mikera.arrayz

Class NDArray

java.lang.Object

mikera.arrayz.AbstractArray<INDArray>

mikera.arrayz.NDArray

All Implemented Interfaces:

Cloneable, Iterable<INDArray>, INDArray

public final class NDArray
extends AbstractArray<INDArray>

General purpose NDArray class

Author:

Mike

Constructor Summary

Constructors

Constructor and Description
NDArray(double[] data, int offset, int[] shape, int[] stride)
NDArray(double[] data, int dimensions, int offset, int[] shape, int[] stride)
NDArray(int... shape)

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)
NDArray	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.
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
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)
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) Multiplies all elements of the array by a given double value
static NDArray	newArray(int... shape)
INDArray	outerProduct(INDArray a)
INDArray	reshape(int... dimensions)
void	set(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)
int	sliceCount()
void	sub(INDArray a)
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.arrayz.AbstractArray

copyTo, equals, getElements, hashCode, iterator, nonZeroCount, scale, set, set, setElements, square, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NDArray

public NDArray(int... shape)

NDArray

public NDArray(double[] data,
       int offset,
       int[] shape,
       int[] stride)

NDArray

public NDArray(double[] data,
       int dimensions,
       int offset,
       int[] shape,
       int[] stride)

Method Detail

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.

Returns:

getShape

public int[] getShape()

Description copied from interface: INDArray

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

Returns:

getStride

public int getStride(int dim)

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.

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

Returns:

set

public void set(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)

add

public void add(INDArray a)

Specified by:

add in interface INDArray

Overrides:

add in class AbstractArray<INDArray>

sub

public void sub(INDArray a)

Specified by:

sub in interface INDArray

Overrides:

sub in class AbstractArray<INDArray>

innerProduct

public INDArray innerProduct(INDArray a)

Specified by:

innerProduct in interface INDArray

Overrides:

innerProduct in class AbstractArray<INDArray>

outerProduct

public INDArray outerProduct(INDArray a)

Specified by:

outerProduct in interface INDArray

Overrides:

outerProduct in class AbstractArray<INDArray>

asVector

public AVector asVector()

Description copied from interface: INDArray

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

Returns:

reshape

public INDArray reshape(int... dimensions)

Specified by:

reshape in interface INDArray

Overrides:

reshape in class AbstractArray<INDArray>

broadcast

public INDArray broadcast(int... dimensions)

Specified by:

broadcast in interface INDArray

Overrides:

broadcast in class AbstractArray<INDArray>

slice

public INDArray slice(int majorSlice)

sliceCount

public int sliceCount()

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.

Returns:

isMutable

public boolean isMutable()

Description copied from interface: INDArray

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

Returns:

isFullyMutable

public boolean isFullyMutable()

Description copied from interface: INDArray

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

Returns:

isElementConstrained

public boolean isElementConstrained()

Description copied from interface: INDArray

Returns true if the IND has additional constraints on element values

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this is a view

Returns:

applyOp

public void applyOp(Op op)

Description copied from interface: INDArray

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

applyOp

public void applyOp(IOp op)

Description copied from interface: INDArray

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

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

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).

Returns:

clone

public NDArray 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.

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

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

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:

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>