org.nd4j.linalg.indexing

Class IntervalIndex

java.lang.Object

org.nd4j.linalg.indexing.IntervalIndex

All Implemented Interfaces:

INDArrayIndex

Direct Known Subclasses:

NDArrayIndexAll

public class IntervalIndex
extends Object
implements INDArrayIndex

And indexing representing an interval

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field and Description
protected int	begin
protected int	end
protected boolean	inclusive
protected int	index
protected int	length
protected int	stride

Constructor Summary

Constructors

Constructor and Description
IntervalIndex(boolean inclusive, int stride)

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	equals(Object o)
int	hashCode()
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)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

begin

protected int begin

end

protected int end

inclusive

protected boolean inclusive

stride

protected int stride

index

protected int index

length

protected int length

Constructor Detail

IntervalIndex

public IntervalIndex(boolean inclusive,
                     int stride)

Parameters:

inclusive - whether to include the last number

stride - the stride for the interval

Method Detail

end

public int end()

Description copied from interface: INDArrayIndex

The ending for this index

Specified by:

end in interface INDArrayIndex

Returns:

offset

public int offset()

Description copied from interface: INDArrayIndex

The start of this index

Specified by:

offset in interface INDArrayIndex

Returns:

length

public int length()

Description copied from interface: INDArrayIndex

The total length of this index (end - start)

Specified by:

length in interface INDArrayIndex

Returns:

stride

public int stride()

Description copied from interface: INDArrayIndex

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

Specified by:

stride in interface INDArrayIndex

Returns:

current

public int current()

Description copied from interface: INDArrayIndex

Return the current index without incrementing the counter

Specified by:

current in interface INDArrayIndex

Returns:

hasNext

public boolean hasNext()

Description copied from interface: INDArrayIndex

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

Specified by:

hasNext in interface INDArrayIndex

Returns:

next

public int next()

Description copied from interface: INDArrayIndex

Returns the next index

Specified by:

next in interface INDArrayIndex

Returns:

reverse

public void reverse()

Description copied from interface: INDArrayIndex

Reverse the indexes

Specified by:

reverse in interface INDArrayIndex

isInterval

public boolean isInterval()

Description copied from interface: INDArrayIndex

Returns true if the index is an interval

Specified by:

isInterval in interface INDArrayIndex

Returns:

setInterval

public void setInterval(boolean isInterval)

Specified by:

setInterval in interface INDArrayIndex

init

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

Description copied from interface: INDArrayIndex

Init the index wrt the dimension and the given nd array

Specified by:

init in interface INDArrayIndex

Parameters:

arr - the array to initialize on

begin - the beginning index

dimension - the dimension to initialize on

init

public void init(INDArray arr,
                 int dimension)

Description copied from interface: INDArrayIndex

Init the index wrt the dimension and the given nd array

Specified by:

init in interface INDArrayIndex

Parameters:

arr - the array to initialize on

dimension - the dimension to initialize on

init

public void init(int begin,
                 int end)

Description copied from interface: INDArrayIndex

Initiailize based on the specified begin and end

Specified by:

init in interface INDArrayIndex

reset

public void reset()

Specified by:

reset in interface INDArrayIndex

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object