mikera.vectorz

Class AScalar

java.lang.Object

mikera.arrayz.impl.AbstractArray<Object>

mikera.vectorz.AScalar

All Implemented Interfaces:

Cloneable, Iterable<Object>, INDArray, IScalar

Direct Known Subclasses:

ArrayIndexScalar, DoubleScalar, ImmutableScalar, Scalar, 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 TODO: override methods in AScalar

Author:

Mike

Constructor Summary

Constructors

Constructor and Description
AScalar()

Method Summary

Methods

Modifier and Type	Method and Description
void	abs() Replaces all elements of this array with their absolute values, according to Math.abs(double)
void	add(AScalar s)
void	add(double d) 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... targetShape) Returns a view of this array broadcasted up to a larger shape
void	clamp(double min, double max) Clamps all the elments of this array within the specified [min,max] range
Scalar	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.
void	divide(double factor) Divides all elements by a given factor
long	elementCount() Returns the total number of elements in this array.
Iterator<Double>	elementIterator() Returns an iterator over all 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	epsilonEquals(INDArray a) Tests is this array is approximately equal to another array.
boolean	epsilonEquals(INDArray a, double epsilon) Tests is this array is approximately equal to another array, up to a given tolerance (epsilon) The arrays must have the same shape
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.
AScalar	getTranspose() Returns the transpose of this array.
AScalar	getTransposeView() Returns a transposed view of the array.
int	hashCode()
AScalar	immutable()
Scalar	innerProduct(AScalar a)
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	isZero() Returns true if the array is zero (all elements equal to zero)
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
AScalar	mutable()
void	negate() Negates all elements in the array
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
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	setElements(double[] values, int offset, int length) Sets all elements in an array using the given double values
INDArray	slice(int position) 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	square() Squares all elements of the array
void	sub(AScalar s)
void	sub(double d) Subtracts a double value from all elements in this array
void	sub(INDArray a) Subtracts all the elements of another array from this array, in an elementwise order.
double[]	toDoubleArray() Copies the elements of this INDArray to a new double array
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.impl.AbstractArray

asElementList, broadcastCloneLike, broadcastLike, divide, ensureMutable, exp, fill, get, get, getSliceViews, getTransposeCopy, isBoolean, isSameShape, log, reciprocal, scale, scaleAdd, set, set, set, set, setElements, signum, sqrt, toArray, toVector

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

asElementList, broadcastCloneLike, broadcastLike, divide, ensureMutable, exp, fill, get, get, getSliceViews, getTransposeCopy, isBoolean, isSameShape, isView, log, reciprocal, scale, scaleAdd, set, set, set, set, setElements, signum, sqrt, toArray, 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>

getTranspose

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

Returns:

getTransposeView

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

Returns:

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)

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:

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

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

isZero

public boolean isZero()

Description copied from interface: INDArray

Returns true if the array is zero (all elements equal to zero)

Specified by:

isZero in interface INDArray

Overrides:

isZero in class AbstractArray<Object>

Returns:

add

public void add(double d)

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

sub

public void sub(double d)

Description copied from interface: INDArray

Subtracts a double value from all elements in this array

Specified by:

sub in interface INDArray

Overrides:

sub in class AbstractArray<Object>

add

public void add(AScalar s)

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

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

sub

public void sub(AScalar s)

negate

public void negate()

Description copied from interface: INDArray

Negates all elements in the array

Specified by:

negate in interface INDArray

Overrides:

negate in class AbstractArray<Object>

square

public void square()

Description copied from interface: INDArray

Squares all elements of the array

Specified by:

square in interface INDArray

Overrides:

square in class AbstractArray<Object>

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

Overrides:

pow in class AbstractArray<Object>

clamp

public void clamp(double min,
         double max)

Description copied from interface: INDArray

Clamps all the elments of this array within the specified [min,max] range

Specified by:

clamp in interface INDArray

Overrides:

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

innerProduct

public Scalar innerProduct(AScalar a)

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

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

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

Returns:

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

divide

public void divide(double factor)

Description copied from interface: INDArray

Divides all elements by a given factor

Specified by:

divide in interface INDArray

Overrides:

divide in class AbstractArray<Object>

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

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

Returns:

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractArray<Object>

epsilonEquals

public boolean epsilonEquals(INDArray a)

Description copied from interface: INDArray

Tests is this array is approximately equal to another array. The arrays must have the same shape

Specified by:

epsilonEquals in interface INDArray

Overrides:

epsilonEquals in class AbstractArray<Object>

Returns:

epsilonEquals

public boolean epsilonEquals(INDArray a,
                    double epsilon)

Description copied from interface: INDArray

Tests is this array is approximately equal to another array, up to a given tolerance (epsilon) The arrays must have the same shape

Specified by:

epsilonEquals in interface INDArray

Overrides:

epsilonEquals in class AbstractArray<Object>

Returns:

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

Overrides:

equals in class AbstractArray<Object>

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>

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

Returns:

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>

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

toDoubleArray

public double[] toDoubleArray()

Description copied from interface: INDArray

Copies the elements of this INDArray to a new double array

Specified by:

toDoubleArray in interface INDArray

Overrides:

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

mutable

public AScalar mutable()

Specified by:

mutable in interface IScalar

immutable

public AScalar immutable()

Specified by:

immutable in interface IScalar

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>

abs

public void abs()

Description copied from interface: INDArray

Replaces all elements of this array with their absolute values, according to Math.abs(double)

Specified by:

abs in interface INDArray

Overrides:

abs in class AbstractArray<Object>