mikera.arrayz

Class AbstractArray<T>

java.lang.Object

mikera.arrayz.AbstractArray<T>

Type Parameters:

T - The type of array slices

All Implemented Interfaces:

Cloneable, Iterable<T>, INDArray

Direct Known Subclasses:

AScalar, AVector, NDArray, SliceArray

public abstract class AbstractArray<T>
extends Object
implements INDArray, Iterable<T>

Abstract base class for INDArray implementations

Author:

Mike

Constructor Summary

Constructors

Constructor and Description
AbstractArray()

Method Summary

Methods

Modifier and Type	Method and Description
void	abs()
void	add(double a)
void	add(INDArray a)
INDArray	broadcast(int... targetShape)
void	clamp(double min, double max)
AbstractArray<?>	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.
void	copyTo(double[] arr) Copies all the elements of this INDArray to the specified double array
double	elementSquaredSum() Returns the total sum of elements in this array.
double	elementSum() Returns the total sum of elements in this array.
boolean	epsilonEquals(INDArray a)
boolean	epsilonEquals(INDArray a, double epsilon)
boolean	equals(Object o)
double	get() Returns the double value of a scalar 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
void	getElements(double[] dest, int offset) Gets all elements of the array, copying them into a double array
int	getShape(int dim) Returns the dimension size for a specific dimension in the array's shape
abstract List<T>	getSlices() Returns a list of all major slices of this array.
List<INDArray>	getSliceViews() Returns a list of slices as mutable INDArray views.
INDArray	getTranspose()
INDArray	getTransposeView() Returns a transposed view of the array.
int	hashCode()
INDArray	innerProduct(INDArray a) Calculates the inner product of this array with another array.
Iterator<T>	iterator()
void	multiply(INDArray a) Multiplies all elements by the equivalent elements in a second array
void	negate()
long	nonZeroCount() Returns the number of non-zero elements in the array.
INDArray	outerProduct(INDArray a) Calculates the outer product of this array with another array.
void	pow(double exponent) Raises all elements of the array to a specified power
void	reciprocal()
INDArray	reshape(int... targetShape)
void	scale(double d) Scales all elements of the array by a given double value
void	scaleAdd(double factor, double constant) Scales all elements of the array by a given double value and adds a constant vale
void	set(double value) Sets all elements of an array to a specific double value
void	set(INDArray a)
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	square() Squares all elements of the array
void	sub(double a)
void	sub(INDArray a)
void	toDoubleBuffer(DoubleBuffer dest) Copies the elements of this INDArray to the specified double buffer
String	toString()
AVector	toVector() Converts the array into a flattened vector
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

applyOp, applyOp, asVector, dimensionality, elementCount, equals, exactClone, get, getLongShape, getShape, isElementConstrained, isFullyMutable, isMutable, isView, multiply, set, setElements, slice, slice, sliceCount

Constructor Detail

AbstractArray

public AbstractArray()

Method Detail

get

public double get()

Description copied from interface: INDArray

Returns the double value of a scalar array

Specified by:

get in interface 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

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

Returns:

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

Returns:

epsilonEquals

public boolean epsilonEquals(INDArray a)

Specified by:

epsilonEquals in interface INDArray

epsilonEquals

public boolean epsilonEquals(INDArray a,
                    double epsilon)

Specified by:

epsilonEquals in interface 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

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

Returns:

getTranspose

public INDArray getTranspose()

Specified by:

getTranspose in interface INDArray

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

Returns:

scale

public final void scale(double d)

Description copied from interface: INDArray

Scales all elements of the array by a given double value

Specified by:

scale in interface INDArray

scaleAdd

public void scaleAdd(double factor,
            double constant)

Description copied from interface: INDArray

Scales all elements of the array by a given double value and adds a constant vale

Specified by:

scaleAdd in interface INDArray

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

set

public void set(int x,
       double value)

Specified by:

set in interface INDArray

set

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

Specified by:

set in interface INDArray

set

public void set(INDArray a)

Specified by:

set in interface INDArray

clamp

public void clamp(double min,
         double max)

Specified by:

clamp in interface INDArray

set

public void set(Object o)

Specified by:

set in interface INDArray

setElements

public void setElements(double[] values)

Description copied from interface: INDArray

Sets all elements in an array using the given double values

Specified by:

setElements in interface INDArray

square

public void square()

Description copied from interface: INDArray

Squares all elements of the array

Specified by:

square in interface INDArray

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public AbstractArray<?> 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 Object

Returns:

add

public void add(INDArray a)

Specified by:

add in interface INDArray

add

public void add(double a)

Specified by:

add in interface INDArray

pow

public void pow(double exponent)

Description copied from interface: INDArray

Raises all elements of the array to a specified power

Specified by:

pow in interface INDArray

sub

public void sub(double a)

Specified by:

sub in interface INDArray

multiply

public void multiply(INDArray a)

Description copied from interface: INDArray

Multiplies all elements by the equivalent elements in a second array

Specified by:

multiply in interface INDArray

nonZeroCount

public long nonZeroCount()

Description copied from interface: INDArray

Returns the number of non-zero elements in the array.

Specified by:

nonZeroCount in interface INDArray

Returns:

elementSum

public double elementSum()

Description copied from interface: INDArray

Returns the total sum of elements in this array.

Specified by:

elementSum in interface INDArray

Returns:

elementSquaredSum

public double elementSquaredSum()

Description copied from interface: INDArray

Returns the total sum of elements in this array.

Specified by:

elementSquaredSum in interface INDArray

Returns:

sub

public void sub(INDArray a)

Specified by:

sub in interface INDArray

negate

public void negate()

Specified by:

negate in interface INDArray

reciprocal

public void reciprocal()

Specified by:

reciprocal in interface INDArray

abs

public void abs()

Specified by:

abs in interface INDArray

reshape

public INDArray reshape(int... targetShape)

Specified by:

reshape in interface INDArray

getSlices

public abstract List<T> getSlices()

Description copied from interface: INDArray

Returns a list of all major slices of this array.

Specified by:

getSlices in interface INDArray

Returns:

getSliceViews

public List<INDArray> getSliceViews()

Description copied from interface: INDArray

Returns a list of slices as mutable INDArray views. Note: will return a list of AScalar values when this array is a 1D vector

Specified by:

getSliceViews in interface INDArray

Returns:

toVector

public AVector toVector()

Description copied from interface: INDArray

Converts the array into a flattened vector

Specified by:

toVector in interface INDArray

Returns:

getElements

public void getElements(double[] dest,
               int offset)

Description copied from interface: INDArray

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

Specified by:

getElements in interface INDArray

copyTo

public void copyTo(double[] arr)

Description copied from interface: INDArray

Copies all the elements of this INDArray to the specified double array

Specified by:

copyTo 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

broadcast

public INDArray broadcast(int... targetShape)

Specified by:

broadcast in interface INDArray

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