mikera.vectorz

Class AScalar

java.lang.Object

mikera.arrayz.AbstractArray<Object>

mikera.vectorz.AScalar

All Implemented Interfaces:

Cloneable, Iterable<Object>, INDArray, IScalar

Direct Known Subclasses:

ArrayIndexScalar, DoubleScalar, VectorIndexScalar

public abstract class AScalar
extends AbstractArray<Object>
implements IScalar

Class to represent a wrapped 0-d scalar value. Can be a view into another vector/matrix/array

Author:

Mike

Constructor Summary

Constructors

Constructor and Description
AScalar()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(AScalar s)
void	add(double d)
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... targetShape)
AScalar	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
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.
double	elementSquaredSum() Returns the total sum of elements in this array.
double	elementSum() Returns the total sum of elements in this array.
boolean	equals(AScalar o)
boolean	equals(INDArray o) Returns true if the two arrays are exactly equal in value and shape
boolean	equals(Object o)
abstract AScalar	exactClone() Returns an exact deep clone of an array (i.e.
abstract 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
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.
int	getShape(int dim) Returns the dimension size for a specific dimension in the array's shape
List<Object>	getSlices() Returns a list of all major slices of this array.
int	hashCode()
INDArray	innerProduct(INDArray a) Calculates the inner product of this array with another array.
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)
Iterator<Object>	iterator()
void	multiply(double factor) Multiplies all elements of the array by a given double value
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.
INDArray	reshape(int... dimensions)
void	set(double value) Sets all elements of an array to a specific double value
void	set(int[] indexes, double value)
void	setElements(double[] values, int offset, int length) Sets all elements in an array using the given double values
INDArray	slice(int position)
INDArray	slice(int dimension, int index)
int	sliceCount()
void	sub(AScalar s)
void	sub(double d)
void	sub(INDArray a)
void	toDoubleBuffer(DoubleBuffer dest) Copies the elements of this INDArray to the specified double buffer
String	toString()
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.arrayz.AbstractArray

get, get, getSliceViews, scale, scaleAdd, set, set, set, set, setElements, square, toVector

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

get, get, getSliceViews, isView, scale, scaleAdd, set, set, set, set, setElements, toVector

Constructor Detail

AScalar

public AScalar()

Method Detail

get

public abstract double get()

Description copied from interface: INDArray

Returns the double value of a scalar array

Specified by:

get in interface INDArray

Specified by:

get in interface IScalar

Overrides:

get in class AbstractArray<Object>

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

Specified by:

set in interface IScalar

Overrides:

set in class AbstractArray<Object>

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

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

Overrides:

getElements in class AbstractArray<Object>

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:

slice

public INDArray slice(int position)

Specified by:

slice in interface INDArray

slice

public INDArray slice(int dimension,
             int index)

Specified by:

slice in interface INDArray

sliceCount

public int sliceCount()

Specified by:

sliceCount in interface INDArray

getSlices

public List<Object> 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<Object>

Returns:

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>

Overrides:

iterator in class AbstractArray<Object>

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

Returns true if the INDArray is 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 the IND has additional constraints on element values

Specified by:

isElementConstrained in interface INDArray

add

public void add(double d)

Specified by:

add in interface INDArray

Overrides:

add in class AbstractArray<Object>

sub

public void sub(double d)

Specified by:

sub in interface INDArray

Overrides:

sub in class AbstractArray<Object>

add

public void add(AScalar s)

add

public void add(INDArray a)

Specified by:

add in interface INDArray

Overrides:

add in class AbstractArray<Object>

sub

public void sub(INDArray a)

Specified by:

sub in interface INDArray

Overrides:

sub in class AbstractArray<Object>

sub

public void sub(AScalar s)

negate

public void negate()

Specified by:

negate in interface INDArray

Overrides:

negate in class AbstractArray<Object>

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<Object>

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<Object>

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(int[] indexes,
       double value)

Specified by:

set in interface INDArray

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

Overrides:

getShape in class AbstractArray<Object>

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:

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:

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

Overrides:

nonZeroCount in class AbstractArray<Object>

Returns:

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

Overrides:

copyTo in class AbstractArray<Object>

asVector

public AVector asVector()

Description copied from interface: INDArray

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

Specified by:

asVector in interface INDArray

Returns:

reshape

public INDArray reshape(int... dimensions)

Specified by:

reshape in interface INDArray

Overrides:

reshape in class AbstractArray<Object>

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

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

clone

public AScalar 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<Object>

Returns:

multiply

public void multiply(double factor)

Description copied from interface: INDArray

Multiplies all elements of the array by a given double value

Specified by:

multiply 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

Overrides:

multiply in class AbstractArray<Object>

elementSum

public double elementSum()

Description copied from interface: INDArray

Returns the total sum of elements in this array.

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class AbstractArray<Object>

Returns:

elementSquaredSum

public final double elementSquaredSum()

Description copied from interface: INDArray

Returns the total sum of elements in this array.

Specified by:

elementSquaredSum in interface INDArray

Overrides:

elementSquaredSum in class AbstractArray<Object>

Returns:

broadcast

public INDArray broadcast(int... targetShape)

Specified by:

broadcast in interface INDArray

Overrides:

broadcast in class AbstractArray<Object>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractArray<Object>

equals

public boolean equals(INDArray o)

Description copied from interface: INDArray

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

Specified by:

equals in interface INDArray

Returns:

equals

public boolean equals(AScalar o)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractArray<Object>

toString

public String toString()

Overrides:

toString in class AbstractArray<Object>

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<Object>

exactClone

public abstract AScalar 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:

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<Object>