mikera.arrayz

Interface INDArray

All Superinterfaces:

Cloneable

All Known Subinterfaces:

IVector

All Known Implementing Classes:

AbstractArray, ADerivedVector, ADiagonalMatrix, AMatrix, APrimitiveVector, ArrayIndexScalar, ArraySubVector, ArrayVector, AScalar, ASparseVector, AVector, AVectorMatrix, AxisVector, BitVector, ColumnMatrix, ComputedVector, DiagonalMatrix, DoubleScalar, GrowableVector, IdentityMatrix, IndexedArrayVector, IndexedSubVector, JoinedArrayVector, JoinedVector, Matrix, Matrix22, Matrix33, MatrixSubVector, NDArray, PermutedMatrix, RepeatedElementVector, RowMatrix, ScalarMatrix, ScalarVector, SingleElementVector, SliceArray, SparseIndexedVector, StridedArrayVector, SubsetMatrix, TransposedMatrix, UnmodifiableVector, Vector, Vector0, Vector1, Vector2, Vector3, Vector4, VectorIndexScalar, VectorMatrixM3, VectorMatrixMN, WrappedSubVector, ZeroMatrix, ZeroVector

public interface INDArray
extends Cloneable

Interface for general multi-dimensional arrays of doubles

Author:

Mike

Method Summary

Methods

Modifier and Type	Method and Description
void	add(INDArray a)
void	applyOp(IOp op) Applies a unary operator to all elements of the array (in-place)
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
AVector	asVector() Creates a view of the array as a single vector in row-major order.
INDArray	broadcast(int... dimensions)
INDArray	clone() Returns a clone of the array, as a new array which will be fully mutable and may be of a different class to the original.
int	dimensionality()
long	elementCount()
boolean	equals(INDArray a) Returns true if the two arrays are exactly equal in value and shape
INDArray	exactClone() Returns an exact deep clone of an array (i.e.
double	get()
double	get(int... indexes)
double	get(int x)
double	get(int x, int y)
void	getElements(double[] dest, int offset) Gets all elements of the array, copying them into a double array
long[]	getLongShape() Returns the shape of the array as an array of longs.
int[]	getShape() Returns the shape of the array as an array of ints.
List<?>	getSlices()
INDArray	innerProduct(INDArray a)
boolean	isElementConstrained() Returns true if the IND has additional constraints on element values
boolean	isFullyMutable() Returns true if the INDArray is fully mutable in all positions i.e.
boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
boolean	isView() Return true if this is a view
void	multiply(double d)
INDArray	outerProduct(INDArray a)
INDArray	reshape(int... dimensions)
void	scale(double d)
void	set(double value)
void	set(INDArray a)
void	set(int[] indexes, double value)
void	set(int x, double value)
void	set(int x, int y, double value)
void	set(Object o)
void	setElements(double[] values) Sets all elements in an array using the given double values
void	setElements(double[] values, int offset, int length)
INDArray	slice(int majorSlice)
int	sliceCount()
void	sub(INDArray a)
void	validate() Validates the internal data structure of the INDArray.

Method Detail

dimensionality

int dimensionality()

getShape

int[] getShape()

Returns the shape of the array as an array of ints.

Returns:

getLongShape

long[] getLongShape()

Returns the shape of the array as an array of longs.

Returns:

get

double get()

get

double get(int x)

get

double get(int x,
         int y)

get

double get(int... indexes)

set

void set(double value)

set

void set(int x,
       double value)

set

void set(int x,
       int y,
       double value)

set

void set(int[] indexes,
       double value)

set

void set(INDArray a)

set

void set(Object o)

add

void add(INDArray a)

sub

void sub(INDArray a)

innerProduct

INDArray innerProduct(INDArray a)

outerProduct

INDArray outerProduct(INDArray a)

asVector

AVector asVector()

Creates a view of the array as a single vector in row-major order.

Returns:

reshape

INDArray reshape(int... dimensions)

broadcast

INDArray broadcast(int... dimensions)

slice

INDArray slice(int majorSlice)

sliceCount

int sliceCount()

elementCount

long elementCount()

isMutable

boolean isMutable()

Returns true if the INDArray is mutable (at least partially)

Returns:

isFullyMutable

boolean isFullyMutable()

Returns true if the INDArray is fully mutable in all positions i.e. every position can store any valid double value

Returns:

isElementConstrained

boolean isElementConstrained()

Returns true if the IND has additional constraints on element values

isView

boolean isView()

Return true if this is a view

Returns:

clone

INDArray clone()

Returns a clone of the array, as a new array which will be fully mutable and may be of a different class to the original.

Returns:

applyOp

void applyOp(Op op)

Applies a unary operator to all elements of the array (in-place)

Parameters:

op -

applyOp

void applyOp(IOp op)

Applies a unary operator to all elements of the array (in-place)

Parameters:

op -

equals

boolean equals(INDArray a)

Returns true if the two arrays are exactly equal in value and shape

Parameters:

a -

Returns:

exactClone

INDArray exactClone()

Returns an exact deep clone of an array (i.e. of the same class as the original).

Returns:

setElements

void setElements(double[] values)

Sets all elements in an array using the given double values

setElements

void setElements(double[] values,
               int offset,
               int length)

getElements

void getElements(double[] dest,
               int offset)

Gets all elements of the array, copying them into a double array

Parameters:

d -

scale

void scale(double d)

multiply

void multiply(double d)

getSlices

List<?> getSlices()

validate

void validate()

Validates the internal data structure of the INDArray. Throws an exception on failure. Failure indicates a serious bug and/or data corruption.