mikera.vectorz.impl

Class GrowableIndexedVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<java.lang.Double>

mikera.vectorz.AVector

mikera.vectorz.impl.GrowableIndexedVector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<java.lang.Double>, INDArray, ISparse, ISparseVector, IVector

public class GrowableIndexedVector
extends AVector
implements ISparseVector

Implementation for a sparse indexed vector that can accumulate index/value pairs efficiently (in order) Length grows if elements are added beyond the end of the vector

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	append(double v)
void	append(int i, double value) Adds a value to this GrawableIndexedVector at the specified position.
static GrowableIndexedVector	create(AVector v) Creates a GrowableIndexedVector from the specified Iterable object
static GrowableIndexedVector	create(ISparseVector v)
static GrowableIndexedVector	create(java.lang.Iterable<?> iterable) Creates a GrowableIndexedVector from the specified Iterable object
static GrowableIndexedVector	create(java.util.Iterator<?> iterator) Creates a GrowableIndexedVector from the specified Iterator object
static GrowableIndexedVector	createLength(int len) Creates a zero-filled GrowableIndexedVector with the specified initial length
double	dotProduct(double[] data, int offset) Fast dot product with 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
boolean	includesIndex(int i)
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
int	length() Returns the length of a vector, in terms of the number of elements.
int	nonSparseElementCount()
Index	nonSparseIndex() Returns an Index indicating which elements of this vector are defined as non-sparse.
AVector	nonSparseValues() Returns the non-sparse elements as a compacted vector.
void	set(int i, double value) Sets a value at a given position in a mutable 1D array
void	setLength(int length) Sets the length of this vector.
SparseIndexedVector	sparse() Coerces this INDArray to a sparse format, without changing its element values.
SparseIndexedVector	sparseClone() Clones the vector into a sparse mutable format
SparseIndexedVector	toSparseIndexedVector() Coerces this vector to a SparseIndexedVector.
void	validate() Validates the internal data structure of the INDArray.
double	visitNonZero(IndexedElementVisitor elementVisitor) Visits all non-zero elements of this vector.

Methods inherited from class mikera.vectorz.AVector

abs, absCopy, absDiff, absDiff, absDiff, absDiffCopy, add, add, add, add, add, add, add, add, add, addAt, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleSparse, addMultipleSparse, addMultipleToArray, addMultipleToArray, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, addSparse, addSparse, addToArray, addToArray, addToArray, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, checkIndex, checkLength, checkRange, clamp, clampMax, clampMin, clone, compareTo, compareTo, copy, copyTo, copyTo, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideCopy, divideCopy, divideCopy, divideTo, dotProduct, dotProduct, dotProduct, dotProduct, elementAbsPowSum, elementCount, elementIterator, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fill, fillRange, get, get, get, get, get, get, getElement, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isMutable, isRangeZero, isSameShape, isSameShape, isUnitLengthVector, isUnitLengthVector, isView, isZero, iterator, join, join, join, log, logistic, magnitude, magnitudeSquared, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, multiplyCopy, multiplyTo, mutable, negate, negateCopy, nonZeroCount, nonZeroIndices, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reciprocal, reciprocalCopy, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateCopy, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleCopy, scaleToMagnitude, select, selectClone, selectView, set, set, set, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setApplyOp, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, setSparse, setSparse, setSparse, shiftCopy, signum, slice, slice, sliceCount, sliceValue, softmax, softmaxCopy, sqrtCopy, square, squareCopy, sub, sub, subArray, subAt, subCopy, subCopy, subMultiple, subVector, tanh, toDoubleArray, toDoubleBuffer, toList, toNormal, toSliceArray, toString, toStringFull, toVector, tryEfficientJoin, unsafeGet, unsafeSet

Methods inherited from class mikera.arrayz.impl.AbstractArray

add, addApplyOp, addCopy, addInnerProduct, addInnerProduct, addOuterProduct, addOuterProductSparse, addSparse, broadcastCloneLike, broadcastCopyLike, componentCount, density, ensureMutable, epsilonEquals, exp, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, isSparse, scale, set, set, signumCopy, sqrt, sub, sub, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.vectorz.IVector

addCopy, clone, divideCopy, epsilonEquals, isSameShape, multiplyCopy, normalise, normaliseCopy, rotateCopy, rotateView, shiftCopy, sqrtCopy, subCopy

Methods inherited from interface mikera.arrayz.INDArray

abs, absCopy, absDiff, absDiffCopy, add, add, addApplyOp, addAt, addCopy, addCopy, addInnerProduct, addInnerProduct, addMultiple, addMultipleSparse, addOuterProduct, addOuterProductSparse, addPower, addPower, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, clamp, componentCount, copy, dense, denseClone, dimensionality, divide, divide, divideCopy, divideCopy, elementAbsPowSum, elementCount, elementIterator, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, exp, fill, get, get, get, get, get, get, get, get, getComponent, getComponents, getElement, getElements, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isMutable, isSameShape, isSparse, isView, isZero, join, join, log, multiply, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonZeroCount, outerProduct, pow, reciprocal, reciprocalCopy, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, setApplyOp, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, setSparse, setSparse, signum, signumCopy, slice, slice, sliceCount, sliceValue, sqrt, square, squareCopy, sub, sub, subArray, subCopy, toDoubleArray, toDoubleBuffer, toSliceArray, toVector, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface mikera.arrayz.ISparse

density

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

create

public static GrowableIndexedVector create(java.lang.Iterable<?> iterable)

Creates a GrowableIndexedVector from the specified Iterable object

Parameters:

iterable - An Iterable containing java.lang.Number instances

Returns:

create

public static GrowableIndexedVector create(AVector v)

Creates a GrowableIndexedVector from the specified Iterable object

Parameters:

iterable - An Iterable containing java.lang.Number instances

Returns:

create

public static GrowableIndexedVector create(ISparseVector v)

create

public static GrowableIndexedVector create(java.util.Iterator<?> iterator)

Creates a GrowableIndexedVector from the specified Iterator object

Parameters:

iterator - An Iterator over java.lang.Number instances

Returns:

createLength

public static GrowableIndexedVector createLength(int len)

Creates a zero-filled GrowableIndexedVector with the specified initial length

Parameters:

len -

Returns:

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

append

public void append(int i,
                   double value)

Adds a value to this GrawableIndexedVector at the specified position. Grows the vector if required.

Parameters:

i -

value -

set

public void set(int i,
                double value)

Description copied from interface: INDArray

Sets a value at a given position in a mutable 1D array

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Specified by:

set in class AVector

append

public void append(double v)

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

dotProduct

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

Description copied from class: AVector

Fast dot product with a double[] array. Performs no bounds checking. Likely to be faster than most other dot product operations

Specified by:

dotProduct in class AVector

toSparseIndexedVector

public SparseIndexedVector toSparseIndexedVector()

Description copied from interface: ISparseVector

Coerces this vector to a SparseIndexedVector. May return this vector if already a SparseIndexedVector

Specified by:

toSparseIndexedVector in interface ISparseVector

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:

A clone of the original array

sparseClone

public SparseIndexedVector sparseClone()

Description copied from class: AVector

Clones the vector into a sparse mutable format

Specified by:

sparseClone in interface INDArray

Overrides:

sparseClone in class AVector

sparse

public SparseIndexedVector sparse()

Description copied from interface: INDArray

Coerces this INDArray to a sparse format, without changing its element values. May return the same INDArray if already sparse. May also mutate the internal structure of the original NDArray, or create a view over parts of the original INDArray. You should take a defensive copy of the original NDArray if any of this concerns you. The returned sparse array may not be fully mutable in all elements.

Specified by:

sparse in interface INDArray

Overrides:

sparse in class AVector

nonSparseElementCount

public int nonSparseElementCount()

nonSparseValues

public AVector nonSparseValues()

Description copied from interface: ISparseVector

Returns the non-sparse elements as a compacted vector. May or may not be a view.

Specified by:

nonSparseValues in interface ISparseVector

Returns:

nonSparseIndex

public Index nonSparseIndex()

Description copied from class: AVector

Returns an Index indicating which elements of this vector are defined as non-sparse. A sparse index must be zero. A non-sparse element may be zero, but is typically expected be non-zero.

Specified by:

nonSparseIndex in interface ISparseVector

Overrides:

nonSparseIndex in class AVector

Returns:

includesIndex

public boolean includesIndex(int i)

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

length

public int length()

Description copied from interface: IVector

Returns the length of a vector, in terms of the number of elements. For Euclidean length, use magnitude() instead

Specified by:

length in interface IVector

Specified by:

length in class AVector

Returns:

setLength

public void setLength(int length)

Sets the length of this vector.

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

Specified by:

equalsArray in interface INDArray

Overrides:

equalsArray in class AVector

Parameters:

data - Array of double element values to check for equality

offset - Offset into the data array

Returns:

visitNonZero

public double visitNonZero(IndexedElementVisitor elementVisitor)

Description copied from class: AVector

Visits all non-zero elements of this vector. Visitor may return a non-zero value to terminate early, which will return the given value. Returns 0.0 otherwise.

Specified by:

visitNonZero in class AVector