mikera.vectorz.impl

Class ArrayIndexScalar

java.lang.Object

mikera.arrayz.impl.AbstractArray<Object>

mikera.vectorz.AScalar

mikera.vectorz.impl.ArrayIndexScalar

All Implemented Interfaces:

Cloneable, Iterable<Object>, IStridedArray, INDArray, IScalar

public class ArrayIndexScalar
extends AScalar
implements IStridedArray

Constructor Summary

Constructors

Constructor and Description
ArrayIndexScalar(double[] array, int index)

Method Summary

Methods

Modifier and Type	Method and Description
double[]	asDoubleArray() Returns the underlying double array representing the packed elements of this array Returns nil if there is no such underlying array
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.
ArrayIndexScalar	exactClone() Returns an exact deep clone of an array (i.e.
double	get() Returns the double value of a scalar array
double[]	getArray()
int	getArrayOffset()
int	getStride(int dimension)
int[]	getStrides()
boolean	isFullyMutable() Returns true if the INDArray is fully mutable in all positions i.e.
boolean	isPackedArray()
boolean	isView() Return true if this array is a view type
void	set(double value) Sets all elements of an array to a specific double value
void	validate() Validates the internal data structure of the INDArray.
static ArrayIndexScalar	wrap(double[] array, int index)

Methods inherited from class mikera.vectorz.AScalar

abs, add, add, add, applyOp, applyOp, asVector, broadcast, clamp, copyTo, dimensionality, divide, elementCount, elementIterator, elementSquaredSum, elementSum, epsilonEquals, epsilonEquals, equals, equals, equals, get, getElements, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeView, hashCode, innerProduct, innerProduct, isElementConstrained, isMutable, isZero, iterator, multiply, multiply, negate, nonZeroCount, outerProduct, pow, reshape, set, setElements, slice, slice, sliceCount, square, sub, sub, sub, toDoubleArray, toDoubleBuffer, toString

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.impl.IStridedArray

getShape

Methods inherited from interface mikera.arrayz.INDArray

abs, add, add, applyOp, applyOp, asElementList, asVector, broadcast, broadcastCloneLike, broadcastLike, clamp, copyTo, dimensionality, divide, divide, elementCount, elementIterator, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, exp, fill, get, get, get, getElements, getLongShape, getShape, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, innerProduct, isBoolean, isElementConstrained, isMutable, isSameShape, isZero, log, multiply, multiply, negate, nonZeroCount, outerProduct, pow, reciprocal, reshape, scale, scaleAdd, set, set, set, set, set, setElements, setElements, signum, slice, slice, sliceCount, sqrt, square, sub, sub, toArray, toDoubleArray, toDoubleBuffer, toVector

Constructor Detail

ArrayIndexScalar

public ArrayIndexScalar(double[] array,
                int index)

Method Detail

wrap

public static ArrayIndexScalar wrap(double[] array,
                    int index)

get

public 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

Specified by:

get in class AScalar

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 AScalar

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:

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

Overrides:

isFullyMutable in class AScalar

Returns:

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 AScalar

Returns:

exactClone

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

Specified by:

exactClone in class AScalar

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 AScalar

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

getStride

public int getStride(int dimension)

Specified by:

getStride in interface IStridedArray

isPackedArray

public boolean isPackedArray()

Specified by:

isPackedArray in interface IStridedArray

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 AScalar