mikera.vectorz.impl

Class ImmutableVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ImmutableVector

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, INDArray, IVector

public class ImmutableVector
extends AVector

Immutable array-backed vector. Keeps defensive array copy to ensure immutability.

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	length
int	offset

Method Summary

Methods

Modifier and Type	Method and Description
void	addAt(int i, double v) Adds a value to a specific element of the vector This function does not perform bounds checking
void	addMultipleToArray(double factor, int offset, double[] array, int arrayOffset, int length)
void	addToArray(double[] array, int offset) Adds this vector to a double[] array, starting at the specified offset.
void	addToArray(int offset, double[] array, int arrayOffset, int length)
Vector	clone() Clones the vector, creating a new mutable copy of all data.
void	copyTo(int offset, double[] dest, int destOffset, int length)
static ImmutableVector	create(AVector v)
void	divideTo(double[] data, int offset)
double	dotProduct(AVector v)
double	dotProduct(double[] data, int offset) Fast dot product with a double[] array.
boolean	equals(AVector v)
boolean	equalsArray(double[] data) Returns true if this vector exactly matches a double[] array.
boolean	equalsArray(double[] data, int offset) Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
AVector	exactClone() Returns an exact clone of this vector, i.e.
double	get(int i) Returns the double value at the specified position in a 1D vector
void	getElements(double[] data, int offset) Gets all elements of the array, copying them into a double array
int	hashCode() Computes the hashcode of a vector.
AVector	immutable() Creates an immutable copy of a vector
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
boolean	isMutable() Returns true if this vector is mutable.
boolean	isView() Returns true if this vector is of a view type that references other vectors / data.
boolean	isZero() Returns true if this vector is a zero vector (all components zero)
Iterator<Double>	iterator()
int	length()
double	magnitudeSquared()
void	multiplyTo(double[] data, int offset)
void	set(int i, double value)
AVector	subVector(int start, int length) Obtains a sub-vector that refers to this vector.
void	toDoubleBuffer(DoubleBuffer dest) Copies the elements of this INDArray to the specified double buffer
double	unsafeGet(int i)
void	unsafeSet(int i, double value)
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.vectorz.AVector

abs, add, add, add, add, add, add, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addProduct, addProduct, addProduct, addProductToArray, addProductToArray, addWeighted, angle, applyOp, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, clamp, clampMax, clampMin, compareTo, copyTo, copyTo, copyTo, copyTo, copyTo, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, dotProduct, dotProduct, elementCount, elementIterator, elementSquaredSum, elementSum, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, fill, fillRange, get, get, get, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isSameShape, isSameShape, isUnitLengthVector, join, log, logistic, magnitude, maxAbsElement, multiply, multiply, multiply, multiply, mutable, negate, nonZeroCount, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reshape, scale, scaleAdd, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, set, set, set, setElements, setElements, setRange, setValues, signum, slice, slice, sliceCount, square, sub, sub, sub, subMultiple, tanh, toDoubleArray, toList, toNormal, toString, toVector, zeroCount

Methods inherited from class mikera.arrayz.impl.AbstractArray

broadcastCloneLike, ensureMutable, exp, get, getSliceViews, isBoolean, reciprocal, scale, set, set, sqrt, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

broadcastCloneLike, ensureMutable, exp, get, getSliceViews, isBoolean, reciprocal, scale, set, set, sqrt, toArray

Field Detail

offset

public int offset

length

public int length

Method Detail

create

public static ImmutableVector create(AVector v)

isMutable

public boolean isMutable()

Description copied from class: AVector

Returns true if this vector is mutable.

Specified by:

isMutable in interface INDArray

Overrides:

isMutable in class AVector

Returns:

isFullyMutable

public boolean isFullyMutable()

Description copied from class: AVector

Returns true if this vector is fully mutable, i.e. can contain any unconstrained double values

Specified by:

isFullyMutable in interface INDArray

Overrides:

isFullyMutable in class AVector

Returns:

isView

public boolean isView()

Description copied from class: AVector

Returns true if this vector is of a view type that references other vectors / data.

Specified by:

isView in interface INDArray

Overrides:

isView in class AVector

Returns:

isZero

public boolean isZero()

Description copied from class: AVector

Returns true if this vector is a zero vector (all components zero)

Specified by:

isZero in interface INDArray

Overrides:

isZero in class AVector

Returns:

subVector

public AVector subVector(int start,
                int length)

Description copied from class: AVector

Obtains a sub-vector that refers to this vector. Changes to the sub-vector will be reflected in this vector

Overrides:

subVector in class AVector

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 AVector

getElements

public void getElements(double[] data,
               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 AVector

copyTo

public void copyTo(int offset,
          double[] dest,
          int destOffset,
          int length)

Overrides:

copyTo in class AVector

multiplyTo

public void multiplyTo(double[] data,
              int offset)

Overrides:

multiplyTo in class AVector

addToArray

public void addToArray(double[] array,
              int offset)

Description copied from class: AVector

Adds this vector to a double[] array, starting at the specified offset.

Overrides:

addToArray in class AVector

addToArray

public void addToArray(int offset,
              double[] array,
              int arrayOffset,
              int length)

Overrides:

addToArray in class AVector

addMultipleToArray

public void addMultipleToArray(double factor,
                      int offset,
                      double[] array,
                      int arrayOffset,
                      int length)

Overrides:

addMultipleToArray in class AVector

divideTo

public void divideTo(double[] data,
            int offset)

Overrides:

divideTo in class AVector

dotProduct

public double dotProduct(double[] data,
                int offset)

Description copied from class: AVector

Fast dot product with a double[] array.

Overrides:

dotProduct in class AVector

Returns:

dotProduct

public double dotProduct(AVector v)

Overrides:

dotProduct in class AVector

magnitudeSquared

public double magnitudeSquared()

Overrides:

magnitudeSquared in class AVector

get

public double get(int i)

Description copied from interface: INDArray

Returns the double value at the specified position in a 1D vector

Specified by:

get in interface INDArray

Specified by:

get in interface IVector

Specified by:

get in class AVector

Returns:

set

public void set(int i,
       double value)

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Specified by:

set in class AVector

unsafeGet

public double unsafeGet(int i)

Overrides:

unsafeGet in class AVector

unsafeSet

public void unsafeSet(int i,
             double value)

Overrides:

unsafeSet in class AVector

addAt

public void addAt(int i,
         double v)

Description copied from class: AVector

Adds a value to a specific element of the vector This function does not perform bounds checking

Overrides:

addAt in class AVector

length

public int length()

Specified by:

length in interface IVector

Specified by:

length in class AVector

iterator

public Iterator<Double> iterator()

Specified by:

iterator in interface Iterable<Double>

Overrides:

iterator in class AVector

hashCode

public int hashCode()

Description copied from class: AVector

Computes the hashcode of a vector. Currently defined to be equal to List.hashCode for a equivalent list of Double values, this may change in future versions.

Overrides:

hashCode in class AVector

equals

public boolean equals(AVector v)

Overrides:

equals in class AVector

equalsArray

public boolean equalsArray(double[] data,
                  int offset)

Description copied from class: AVector

Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset

Overrides:

equalsArray in class AVector

Returns:

equalsArray

public boolean equalsArray(double[] data)

Description copied from class: AVector

Returns true if this vector exactly matches a double[] array.

Overrides:

equalsArray in class AVector

Returns:

clone

public Vector clone()

Description copied from class: AVector

Clones the vector, creating a new mutable copy of all data. The clone is: - not guaranteed to be of the same type. - guaranteed to be fully mutable - guaranteed not to contain a reference (i.e. is a full deep copy)

Specified by:

clone in interface INDArray

Overrides:

clone in class AVector

Returns:

exactClone

public AVector exactClone()

Description copied from class: AVector

Returns an exact clone of this vector, i.e. of the same type

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class AVector

Returns:

immutable

public AVector immutable()

Description copied from class: AVector

Creates an immutable copy of a vector

Specified by:

immutable in interface IVector

Overrides:

immutable in class AVector

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 AVector