org.nd4j.linalg.indexing

Class NDArrayIndex

java.lang.Object

org.nd4j.linalg.indexing.NDArrayIndex

Direct Known Subclasses:

NDArrayIndex.NDArrayIndexAll

public class NDArrayIndex
extends Object

NDArray indexing

Author:

Adam Gibson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NDArrayIndex.NDArrayIndexAll

Constructor Summary

Constructors

Constructor and Description
NDArrayIndex(int... indices) NDArrayIndexing based on the given indexes

Method Summary

Modifier and Type	Method and Description
static NDArrayIndex	all() Represents collecting all elements
static NDArrayIndex	concat(NDArrayIndex... indexes) Concatneate all of the given indices in to one
static NDArrayIndex[]	create(INDArray index) Create from a matrix.
static NDArrayIndex[]	createCoveringShape(int[] shape) Creates an index covering the given shape (for each dimension 0,shape[i])
int	end()
boolean	equals(Object o)
int	hashCode()
int[]	indices()
static NDArrayIndex	interval(int begin, int end) Generates an interval from begin (inclusive) to end (exclusive)
static NDArrayIndex	interval(int begin, int end, boolean inclusive) Generates an interval from begin (inclusive) to end (exclusive)
static NDArrayIndex	interval(int begin, int stride, int end) Generates an interval from begin (inclusive) to end (exclusive)
static NDArrayIndex	interval(int begin, int stride, int end, boolean inclusive) Generates an interval from begin (inclusive) to end (exclusive)
boolean	isInterval()
int	length() Returns the length of the indices
int	offset()
static NDArrayIndex[]	rangeOfLength(NDArrayIndex... indexes) Create a range based on the given indexes.
void	reverse()
void	setInterval(boolean isInterval)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NDArrayIndex

public NDArrayIndex(int... indices)

NDArrayIndexing based on the given indexes

Parameters:

indices -

Method Detail

all

public static NDArrayIndex all()

Represents collecting all elements

Returns:

an ndarray index meaning collect all elements

createCoveringShape

public static NDArrayIndex[] createCoveringShape(int[] shape)

Creates an index covering the given shape (for each dimension 0,shape[i])

Parameters:

shape - the shape to cover

Returns:

the ndarray indexes to cover

rangeOfLength

public static NDArrayIndex[] rangeOfLength(NDArrayIndex... indexes)

Create a range based on the given indexes. This is similar to create covering shape in that it approximates the length of each dimension (ignoring elements) and reproduces an index of the same dimension and length.

Parameters:

indexes - the indexes to create the range for

Returns:

the index ranges.

create

public static NDArrayIndex[] create(INDArray index)

Create from a matrix. The rows are the indices The columns are the individual element in each ndarrayindex

Parameters:

index - the matrix to getFloat indices from

Returns:

the indices to getFloat

concat

public static NDArrayIndex concat(NDArrayIndex... indexes)

Concatneate all of the given indices in to one

Parameters:

indexes - the indexes to concatneate

Returns:

the merged indices

interval

public static NDArrayIndex interval(int begin,
                                    int stride,
                                    int end)

Generates an interval from begin (inclusive) to end (exclusive)

Parameters:

begin - the begin

stride - the stride at which to increment

end - the end index

Returns:

the interval

interval

public static NDArrayIndex interval(int begin,
                                    int stride,
                                    int end,
                                    boolean inclusive)

Generates an interval from begin (inclusive) to end (exclusive)

Parameters:

begin - the begin

stride - the stride at which to increment

end - the end index

inclusive - whether the end should be inclusive or not

Returns:

the interval

interval

public static NDArrayIndex interval(int begin,
                                    int end)

Generates an interval from begin (inclusive) to end (exclusive)

Parameters:

begin - the begin

end - the end index

Returns:

the interval

interval

public static NDArrayIndex interval(int begin,
                                    int end,
                                    boolean inclusive)

Generates an interval from begin (inclusive) to end (exclusive)

Parameters:

begin - the begin

end - the end index

inclusive - whether the end should be inclusive or not

Returns:

the interval

end

public int end()

offset

public int offset()

length

public int length()

Returns the length of the indices

Returns:

the length of the range

indices

public int[] indices()

reverse

public void reverse()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isInterval

public boolean isInterval()

setInterval

public void setInterval(boolean isInterval)