org.nd4j.linalg.indexing

Class NewAxis

java.lang.Object

org.nd4j.linalg.indexing.NewAxis

All Implemented Interfaces:

INDArrayIndex

public class NewAxis
extends Object
implements INDArrayIndex

New axis index. Specified for wanting a new dimension in an ndarray

Author:

Adam Gibson

Constructor Summary

Constructors

Constructor and Description
NewAxis()

Method Summary

Modifier and Type	Method and Description
long	current() Return the current index without incrementing the counter
long	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, 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	next() Returns the next index
long	offset() The start of this index
void	reset()
void	reverse() Reverse the indexes
void	setInterval(boolean isInterval)
long	stride() The stride for the index (most of the time will be 1)

Methods inherited from class java.lang.Object

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

Constructor Detail

NewAxis

public NewAxis()

Method Detail

end

public long end()

Description copied from interface: INDArrayIndex

The ending for this index

Specified by:

end in interface INDArrayIndex

Returns:

offset

public long offset()

Description copied from interface: INDArrayIndex

The start of this index

Specified by:

offset in interface INDArrayIndex

Returns:

length

public long length()

Description copied from interface: INDArrayIndex

The total length of this index (end - start)

Specified by:

length in interface INDArrayIndex

Returns:

stride

public long 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 long 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 long 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,
                 long 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(long begin,
                 long end,
                 long max)

Specified by:

init in interface INDArrayIndex

init

public void init(long begin,
                 long 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