org.nd4j.linalg.indexing

Interface INDArrayIndex

All Known Implementing Classes:

IntervalIndex, NDArrayIndex, NDArrayIndexAll, NewAxis, PointIndex, SpecifiedIndex

public interface INDArrayIndex

An index in to a particular dimension. This handles traversing indexes along a dimension such as particular rows, or intervals.

Author:

Adam Gibson

Method Summary

Modifier and Type	Method and Description
long	end() The ending for this index
void	init(INDArray arr, int dimension) Init the index wrt the dimension and the given nd array
void	init(INDArray arr, long begin, int dimension) Init the index wrt the dimension and the given nd array
void	init(long begin, long end) Initiailize based on the specified begin and end
void	init(long begin, long end, long max)
boolean	isInterval() Returns true if the index is an interval
long	length() The total length of this index (end - start)
long	offset() The start of this index
void	reverse() Reverse the indexes
long	stride() The stride for the index (most of the time will be 1)

Method Detail

end

long end()

The ending for this index

Returns:

offset

long offset()

The start of this index

Returns:

length

long length()

The total length of this index (end - start)

Returns:

stride

long stride()

The stride for the index (most of the time will be 1)

Returns:

reverse

void reverse()

Reverse the indexes

isInterval

boolean isInterval()

Returns true if the index is an interval

Returns:

init

void init(INDArray arr,
          long begin,
          int dimension)

Init the index wrt the dimension and the given nd array

Parameters:

arr - the array to initialize on

begin - the beginning index

dimension - the dimension to initialize on

init

void init(INDArray arr,
          int dimension)

Init the index wrt the dimension and the given nd array

Parameters:

arr - the array to initialize on

dimension - the dimension to initialize on

init

void init(long begin,
          long end,
          long max)

init

void init(long begin,
          long end)

Initiailize based on the specified begin and end

Parameters:

begin -

end -