org.nd4j.linalg.indexing

Interface INDArrayIndex

All Known Implementing Classes:

IntervalIndex, NDArrayIndex, NDArrayIndexAll, NDArrayIndexEmpty, 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
int	current() Return the current index without incrementing the counter
int	end() The ending for this index
boolean	hasNext() Returns true if there is another element in the index to iterate over otherwise false
void	init(INDArray arr, int dimension) Init the index wrt the dimension and the given nd array
void	init(INDArray arr, int begin, int dimension) Init the index wrt the dimension and the given nd array
void	init(int begin, int end) Initiailize based on the specified begin and end
boolean	isInterval() Returns true if the index is an interval
int	length() The total length of this index (end - start)
int	next() Returns the next index
int	offset() The start of this index
void	reset()
void	reverse() Reverse the indexes
void	setInterval(boolean isInterval)
int	stride() The stride for the index (most of the time will be 1)

Method Detail

end

int end()

The ending for this index

Returns:

offset

int offset()

The start of this index

Returns:

length

int length()

The total length of this index (end - start)

Returns:

stride

int stride()

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

Returns:

current

int current()

Return the current index without incrementing the counter

Returns:

hasNext

boolean hasNext()

Returns true if there is another element in the index to iterate over otherwise false

Returns:

next

int next()

Returns the next index

Returns:

reverse

void reverse()

Reverse the indexes

isInterval

boolean isInterval()

Returns true if the index is an interval

Returns:

setInterval

void setInterval(boolean isInterval)

Parameters:

isInterval -

init

void init(INDArray arr,
          int 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(int begin,
          int end)

Initiailize based on the specified begin and end

Parameters:

begin -

end -

reset

void reset()