mikera.vectorz.impl

Class ImmutableScalar

java.lang.Object

mikera.arrayz.impl.AbstractArray<Object>

mikera.vectorz.AScalar

mikera.vectorz.impl.ImmutableScalar

All Implemented Interfaces:

Cloneable, Iterable<Object>, INDArray, IScalar

public final class ImmutableScalar
extends AScalar

Method Summary

Methods

Modifier and Type	Method and Description
static ImmutableScalar	create(AScalar a)
static ImmutableScalar	create(double value)
AScalar	exactClone() Returns an exact deep clone of an array (i.e.
double	get() Returns the double value of a scalar array
void	getElements(double[] dest, int offset) Gets all elements of the array, copying them into a double array
ImmutableScalar	immutable()
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	isView() Return true if this array is a view type
Scalar	mutable()
void	set(double value) Sets all elements of an array to a specific double value

Methods inherited from class mikera.vectorz.AScalar

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

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, log, reciprocal, scale, scaleAdd, set, set, set, set, setElements, signum, sqrt, toArray, toVector

Method Detail

create

public static ImmutableScalar create(double value)

create

public static ImmutableScalar create(AScalar a)

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

Overrides:

isMutable in class AScalar

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

Overrides:

isFullyMutable in class AScalar

Returns:

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this array is a view type

Returns:

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:

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 AScalar

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

exactClone

public 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

Specified by:

exactClone in class AScalar

Returns:

mutable

public Scalar mutable()

Specified by:

mutable in interface IScalar

Overrides:

mutable in class AScalar

immutable

public ImmutableScalar immutable()

Specified by:

immutable in interface IScalar

Overrides:

immutable in class AScalar