mikera.arrayz

Class NDArray

java.lang.Object

mikera.arrayz.impl.AbstractArray<INDArray>

mikera.arrayz.NDArray

All Implemented Interfaces:

Cloneable, Iterable<INDArray>, IStridedArray, INDArray

public final class NDArray
extends AbstractArray<INDArray>
implements IStridedArray

General purpose NDArray class

Author:

Mike

Method Summary

Methods

Modifier and Type	Method and Description
void	add(double a) Adds a double value to all elements in this array
void	add(INDArray a) Adds all the elements of another array to this array, in an elementwise order.
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)
double[]	asDoubleArray() Returns the underlying double array representing the packed elements of this array Returns nil if there is no such underlying array
AVector	asVector() Constructs a view of the array as a single vector in row-major order.
INDArray	broadcast(int... dimensions) Returns a view of this array broadcasted up to a larger shape
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() Returns the dimensionality of the array (number of dimensions in the array shape) e.g.
long	elementCount() Returns the total number of elements in this array.
Iterator<Double>	elementIterator() Returns an iterator over all elements in this array.
boolean	equals(INDArray a) Returns true if the two arrays are exactly equal in value and shape
boolean	equals(NDArray a)
NDArray	exactClone() Returns an exact deep clone of an array (i.e.
double	get() Returns the double value of a scalar array
double	get(int... indexes) Returns the double value at the specified index position in an array
double	get(int x) Returns the double value at the specified position in a 1D vector
double	get(int x, int y) Returns the double value at the specified position in a 2D matrix
double[]	getArray()
int	getArrayOffset()
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.
int	getShape(int dim) Returns the dimension size for a specific dimension in the array's shape
List<INDArray>	getSlices() Returns a list of all major slices of this array.
int	getStride(int dim)
int[]	getStrides()
INDArray	getTranspose() Returns the transpose of this array.
INDArray	getTransposeView() Returns a transposed view of the array.
INDArray	innerProduct(INDArray a) Calculates the inner product of this array with another array.
boolean	isElementConstrained() Returns true if this array has some constraints on element values
boolean	isFullyMutable() If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
boolean	isPackedArray()
boolean	isView() Return true if this array is a view type
void	multiply(double d) Multiplies all elements of the array by a given double value
static NDArray	newArray(int... shape)
INDArray	outerProduct(INDArray a) Calculates the outer product of this array with another array.
INDArray	reshape(int... dimensions) Returns a new array by rearranging the elements of this array into the desired shape Truncates or zero-pads the elements as required to fill the new shape
void	set(double value) Sets all elements of an array to a specific double value
void	set(int[] indexes, double value)
void	set(int x, double value)
void	set(int x, int y, double value)
void	setElements(double[] values, int offset, int length) Sets all elements in an array using the given double values
INDArray	slice(int majorSlice) Returns the specified major slice of this array as a view (slice along dimension 0)
INDArray	slice(int dimension, int index) Returns a slice view of this array along the specified dimension
int	sliceCount() returns the number of major slices in this array.
void	sub(INDArray a) Subtracts all the elements of another array from this array, in an elementwise order.
void	toDoubleBuffer(DoubleBuffer dest) Copies the elements of this INDArray to the specified double buffer
void	validate() Validates the internal data structure of the INDArray.
static NDArray	wrap(double[] data, int[] shape)
static NDArray	wrap(INDArray a)
static NDArray	wrap(IStridedArray a)
static NDArray	wrap(Matrix m)
static NDArray	wrap(Vector v)
static INDArray	wrapStrided(double[] data, int offset, int[] shape, int[] strides)

Methods inherited from class mikera.arrayz.impl.AbstractArray

abs, asElementList, broadcastCloneLike, broadcastLike, clamp, copyTo, divide, divide, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, exp, fill, getElements, getSliceViews, getTransposeCopy, hashCode, isBoolean, isSameShape, isZero, iterator, log, multiply, negate, nonZeroCount, pow, reciprocal, scale, scaleAdd, set, set, setElements, signum, sqrt, square, sub, toArray, toDoubleArray, toString, toVector

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

abs, asElementList, broadcastCloneLike, broadcastLike, clamp, copyTo, divide, divide, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, exp, fill, getElements, getSliceViews, getTransposeCopy, isBoolean, isSameShape, isZero, log, multiply, negate, nonZeroCount, pow, reciprocal, scale, scaleAdd, set, set, setElements, signum, sqrt, square, sub, toArray, toDoubleArray, toVector

Method Detail

wrap

public static NDArray wrap(double[] data,
           int[] shape)

wrap

public static NDArray wrap(Vector v)

wrap

public static NDArray wrap(Matrix m)

wrap

public static NDArray wrap(IStridedArray a)

wrap

public static NDArray wrap(INDArray a)

newArray

public static NDArray newArray(int... shape)

dimensionality

public int dimensionality()

Description copied from interface: INDArray

Returns the dimensionality of the array (number of dimensions in the array shape) e.g. 0 for a scalar, 1 for a vector, 2 for a matrix etc.

Specified by:

dimensionality in interface INDArray

Returns:

getShape

public int[] getShape()

Description copied from interface: INDArray

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

Specified by:

getShape in interface IStridedArray

Specified by:

getShape in interface INDArray

Returns:

getStride

public int getStride(int dim)

Specified by:

getStride in interface IStridedArray

getShape

public int getShape(int dim)

Description copied from interface: INDArray

Returns the dimension size for a specific dimension in the array's shape

Specified by:

getShape in interface INDArray

Overrides:

getShape in class AbstractArray<INDArray>

Returns:

getLongShape

public long[] getLongShape()

Description copied from interface: INDArray

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

Specified by:

getLongShape in interface INDArray

Returns:

get

public double get()

Description copied from interface: INDArray

Returns the double value of a scalar array

Specified by:

get in interface INDArray

Overrides:

get in class AbstractArray<INDArray>

Returns:

get

public double get(int x)

Description copied from interface: INDArray

Returns the double value at the specified position in a 1D vector

Specified by:

get in interface INDArray

Overrides:

get in class AbstractArray<INDArray>

Returns:

get

public double get(int x,
         int y)

Description copied from interface: INDArray

Returns the double value at the specified position in a 2D matrix

Specified by:

get in interface INDArray

Overrides:

get in class AbstractArray<INDArray>

Returns:

get

public double get(int... indexes)

Description copied from interface: INDArray

Returns the double value at the specified index position in an array

Specified by:

get in interface INDArray

Returns:

set

public void set(double value)

Description copied from interface: INDArray

Sets all elements of an array to a specific double value

Specified by:

set in interface INDArray

Overrides:

set in class AbstractArray<INDArray>

set

public void set(int x,
       double value)

Specified by:

set in interface INDArray

Overrides:

set in class AbstractArray<INDArray>

set

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

Specified by:

set in interface INDArray

Overrides:

set in class AbstractArray<INDArray>

set

public void set(int[] indexes,
       double value)

Specified by:

set in interface INDArray

add

public void add(double a)

Description copied from interface: INDArray

Adds a double value to all elements in this array

Specified by:

add in interface INDArray

Overrides:

add in class AbstractArray<INDArray>

add

public void add(INDArray a)

Description copied from interface: INDArray

Adds all the elements of another array to this array, in an elementwise order.

Specified by:

add in interface INDArray

Overrides:

add in class AbstractArray<INDArray>

sub

public void sub(INDArray a)

Description copied from interface: INDArray

Subtracts all the elements of another array from this array, in an elementwise order.

Specified by:

sub in interface INDArray

Overrides:

sub in class AbstractArray<INDArray>

innerProduct

public INDArray innerProduct(INDArray a)

Description copied from interface: INDArray

Calculates the inner product of this array with another array.

Specified by:

innerProduct in interface INDArray

Overrides:

innerProduct in class AbstractArray<INDArray>

Returns:

outerProduct

public INDArray outerProduct(INDArray a)

Description copied from interface: INDArray

Calculates the outer product of this array with another array.

Specified by:

outerProduct in interface INDArray

Overrides:

outerProduct in class AbstractArray<INDArray>

Returns:

getTranspose

public INDArray getTranspose()

Description copied from interface: INDArray

Returns the transpose of this array. A transpose of an array is equivalent to reversing the order of dimensions

Specified by:

getTranspose in interface INDArray

Overrides:

getTranspose in class AbstractArray<INDArray>

Returns:

getTransposeView

public INDArray getTransposeView()

Description copied from interface: INDArray

Returns a transposed view of the array. May throw UnsupportedOperationException if the array does not support this capability

Specified by:

getTransposeView in interface INDArray

Overrides:

getTransposeView in class AbstractArray<INDArray>

Returns:

asVector

public AVector asVector()

Description copied from interface: INDArray

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

Specified by:

asVector in interface INDArray

Returns:

isPackedArray

public boolean isPackedArray()

Specified by:

isPackedArray in interface IStridedArray

reshape

public INDArray reshape(int... dimensions)

Description copied from interface: INDArray

Returns a new array by rearranging the elements of this array into the desired shape Truncates or zero-pads the elements as required to fill the new shape

Specified by:

reshape in interface INDArray

Overrides:

reshape in class AbstractArray<INDArray>

Returns:

broadcast

public INDArray broadcast(int... dimensions)

Description copied from interface: INDArray

Returns a view of this array broadcasted up to a larger shape

Specified by:

broadcast in interface INDArray

Overrides:

broadcast in class AbstractArray<INDArray>

Returns:

slice

public INDArray slice(int majorSlice)

Description copied from interface: INDArray

Returns the specified major slice of this array as a view (slice along dimension 0)

Specified by:

slice in interface INDArray

Returns:

slice

public INDArray slice(int dimension,
             int index)

Description copied from interface: INDArray

Returns a slice view of this array along the specified dimension

Specified by:

slice in interface INDArray

Returns:

sliceCount

public int sliceCount()

Description copied from interface: INDArray

returns the number of major slices in this array.

Specified by:

sliceCount in interface INDArray

Returns:

elementCount

public long elementCount()

Description copied from interface: INDArray

Returns the total number of elements in this array. Equivalent to the product all dimension sizes.

Specified by:

elementCount in interface INDArray

Returns:

isMutable

public boolean isMutable()

Description copied from interface: INDArray

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

Specified by:

isMutable in interface INDArray

Returns:

isFullyMutable

public boolean isFullyMutable()

Description copied from interface: INDArray

If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e. every position can store any valid double value

Specified by:

isFullyMutable in interface INDArray

Returns:

isElementConstrained

public boolean isElementConstrained()

Description copied from interface: INDArray

Returns true if this array has some constraints on element values

Specified by:

isElementConstrained in interface INDArray

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this array is a view type

Specified by:

isView in interface INDArray

Returns:

applyOp

public void applyOp(Op op)

Description copied from interface: INDArray

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

Specified by:

applyOp in interface INDArray

applyOp

public void applyOp(IOp op)

Description copied from interface: INDArray

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

Specified by:

applyOp in interface INDArray

equals

public boolean equals(NDArray a)

equals

public boolean equals(INDArray a)

Description copied from interface: INDArray

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

Specified by:

equals in interface INDArray

Overrides:

equals in class AbstractArray<INDArray>

Returns:

exactClone

public NDArray exactClone()

Description copied from interface: INDArray

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

Specified by:

exactClone in interface INDArray

Returns:

clone

public INDArray clone()

Description copied from interface: INDArray

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. Clone should attempt to return the most efficient possible array type.

Specified by:

clone in interface INDArray

Overrides:

clone in class AbstractArray<INDArray>

Returns:

multiply

public void multiply(double d)

Description copied from interface: INDArray

Multiplies all elements of the array by a given double value

Specified by:

multiply in interface INDArray

setElements

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

Description copied from interface: INDArray

Sets all elements in an array using the given double values

Specified by:

setElements in interface INDArray

toDoubleBuffer

public void toDoubleBuffer(DoubleBuffer dest)

Description copied from interface: INDArray

Copies the elements of this INDArray to the specified double buffer

Specified by:

toDoubleBuffer in interface INDArray

Overrides:

toDoubleBuffer in class AbstractArray<INDArray>

asDoubleArray

public double[] asDoubleArray()

Description copied from interface: INDArray

Returns the underlying double array representing the packed elements of this array Returns nil if there is no such underlying array

Specified by:

asDoubleArray in interface INDArray

Overrides:

asDoubleArray in class AbstractArray<INDArray>

getSlices

public List<INDArray> getSlices()

Description copied from interface: INDArray

Returns a list of all major slices of this array.

Specified by:

getSlices in interface INDArray

Specified by:

getSlices in class AbstractArray<INDArray>

Returns:

elementIterator

public Iterator<Double> elementIterator()

Description copied from interface: INDArray

Returns an iterator over all elements in this array.

Specified by:

elementIterator in interface INDArray

Overrides:

elementIterator in class AbstractArray<INDArray>

Returns:

validate

public void validate()

Description copied from interface: INDArray

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

Specified by:

validate in interface INDArray

Overrides:

validate in class AbstractArray<INDArray>

getArray

public double[] getArray()

Specified by:

getArray in interface IStridedArray

getArrayOffset

public int getArrayOffset()

Specified by:

getArrayOffset in interface IStridedArray

getStrides

public int[] getStrides()

Specified by:

getStrides in interface IStridedArray

wrapStrided

public static INDArray wrapStrided(double[] data,
                   int offset,
                   int[] shape,
                   int[] strides)