mikera.vectorz.impl

Class ASparseIndexedVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.ASparseVector

mikera.vectorz.impl.ASparseIndexedVector

All Implemented Interfaces:

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

Direct Known Subclasses:

SparseImmutableVector, SparseIndexedVector

public abstract class ASparseIndexedVector
extends ASparseVector

Base class containing common implementations for sparse indexed vectors

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields inherited from class mikera.vectorz.impl.ASizedVector

length

Constructor Summary

Constructors

Constructor and Description
ASparseIndexedVector(int length)

Method Summary

Modifier and Type	Method and Description
void	addMultipleToArray(double factor, int offset, double[] array, int arrayOffset, int length) Adds a multiple of a subvector of this vector into a double array at the specified offset
void	addProductToArray(double factor, int offset, ADenseArrayVector other, int otherOffset, double[] array, int arrayOffset, int length) Adds the scaled elementwise product of this vector and another vector to the destimation array
void	addProductToArray(double factor, int offset, AVector other, int otherOffset, double[] array, int arrayOffset, int length)
void	addToArray(double[] dest, int offset) Adds this vector to a double[] array, starting at the specified offset.
void	addToArray(double[] dest, int offset, int stride) Adds this vector to a double[] array, using the specified offset and stride into the destination array
void	addToArray(int offset, double[] array, int arrayOffset, int length) Adds a subvector of this vector into a double array at the specified offset
SparseIndexedVector	cloneIncludingIndices(int[] ixs) Create a clone of this sparse indexed vector including the new indexes specified Intended to allow fast subsequent modification
protected void	copySparseValuesTo(double[] array, int offset) Copy only the sparse values in this vector to a target array.
void	copyTo(AVector v, int offset) Copies a the contents of a vector to a vector at the specified offset
double	dotProduct(ASparseVector v)
double	dotProduct(AVector v) Returns the dot product of this vector with another vector The vectors must have the same length: if not the result is undefined
double	dotProduct(double[] data, int offset) Fast dot product with a double[] array.
double	dotProduct(double[] data, int offset, int stride) Fast dot product with a double[] array and a stride.
double	elementSquaredSum() Returns the sum of squared elements in this array.
double	elementSum() Returns the sum of all elements in a vector
boolean	equals(AVector v)
boolean	equalsArray(double[] ds, int offset) Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
void	getElements(double[] array, int offset) Gets all elements of the array, copying them into a double array at the specified offset
boolean	includesIndex(int i) Returns true iff the sparse vector contains the index i
AVector	innerProduct(AMatrix a) Computes the inner product of this vector with a matrix
boolean	isRangeZero(int start, int length) Returns true if a sub-vector range is completely zero.
boolean	isZero() Returns true if this vector is a zero vector (all components zero)
void	multiply(double factor) Multiplies the vector by a constant factor
long	nonZeroCount() Returns the number of non-zero elements in the array.
int[]	nonZeroIndices() Return an int array specifying the positions in this vector which are non-zero

Methods inherited from class mikera.vectorz.impl.ASparseVector

add, add, addMultiple, clone, copyTo, copyTo, distanceL1, distanceLinf, distanceSquared, dotProduct, elementAbsPowSum, elementPowSum, elementProduct, equals, getSlices, hasUncountable, isSparse, isView, nonSparseElementCount, nonSparseIndex, nonSparseValues, reduce, reduce, reduceSlices, roundToZero, sparse, toDoubleArray, toSparseIndexedVector

Methods inherited from class mikera.vectorz.impl.ASizedVector

checkIndex, checkLength, checkRange, checkSameLength, checkSameLength, elementCount, equalsArray, get, getShape, getShapeClone, isSameShape, length, sliceCount

Methods inherited from class mikera.vectorz.AVector

abs, absCopy, add, add, add, add, add, add, add, add, addAt, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleToArray, addPower, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, checkDimension, checkSameLength, clamp, clampMax, clampMin, compareTo, copy, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, divide, divide, divide, divide, divideCopy, divideCopy, divideTo, dotProduct, elementIterator, elementMax, elementMin, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, exactClone, fill, fillRange, get, get, get, get, get, getElements, getElements, getLongShape, getShape, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isFullyMutable, isMutable, isSameShape, isUnitLengthVector, isUnitLengthVector, iterator, join, join, join, log, logistic, magnitude, magnitudeSquared, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, multiplyCopy, multiplyTo, mutable, negate, negateCopy, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, 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, set, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, shiftCopy, signum, slice, slice, sliceValue, softmax, softmaxCopy, sparseClone, sqrtCopy, square, squareCopy, sub, sub, subArray, subAt, subCopy, subCopy, subMultiple, subVector, tanh, toDoubleBuffer, toList, toNormal, toSliceArray, toString, toStringFull, toVector, tryEfficientJoin, unsafeGet, unsafeSet, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

add, addInnerProduct, addInnerProduct, addOuterProduct, broadcastCloneLike, broadcastCopyLike, checkMutable, componentCount, density, ensureMutable, exp, get, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, reciprocal, reciprocalCopy, scale, set, set, signumCopy, sqrt, sub, sub, toArray, withComponents

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.vectorz.IVector

addCopy, divideCopy, epsilonEquals, get, isSameShape, length, multiplyCopy, normalise, normaliseCopy, rotateCopy, rotateView, set, shiftCopy, sqrtCopy, subCopy

Methods inherited from interface mikera.arrayz.INDArray

abs, absCopy, add, add, addAt, addCopy, addCopy, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, checkMutable, clamp, componentCount, copy, dense, denseClone, dimensionality, divide, divide, divideCopy, elementCount, elementIterator, elementMax, elementMin, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, exactClone, exp, fill, get, get, get, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isFullyMutable, isMutable, isSameShape, join, join, log, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, outerProduct, pow, reciprocal, reciprocalCopy, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, signum, signumCopy, slice, slice, sliceCount, sliceValue, sparseClone, sqrt, square, squareCopy, sub, sub, subArray, subCopy, toArray, toDoubleBuffer, toSliceArray, toVector, validate, withComponents

Methods inherited from interface mikera.arrayz.ISparse

density

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ASparseIndexedVector

public ASparseIndexedVector(int length)

Method Detail

includesIndex

public boolean includesIndex(int i)

Description copied from class: ASparseVector

Returns true iff the sparse vector contains the index i

Specified by:

includesIndex in class ASparseVector

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 ASparseVector

isRangeZero

public boolean isRangeZero(int start,
                           int length)

Description copied from class: AVector

Returns true if a sub-vector range is completely zero. Unsafe operation - does not perform bounds checking, results are undefined if sub-vector is out of range

Overrides:

isRangeZero in class AVector

Returns:

elementSum

public double elementSum()

Description copied from class: AVector

Returns the sum of all elements in a vector

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class ASparseVector

multiply

public void multiply(double factor)

Description copied from class: AVector

Multiplies the vector by a constant factor

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AVector

Parameters:

factor - Factor by which to multiply each component of the vector

elementSquaredSum

public double elementSquaredSum()

Description copied from interface: INDArray

Returns the sum of squared elements in this array.

Specified by:

elementSquaredSum in interface INDArray

Overrides:

elementSquaredSum in class ASparseVector

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 ASparseVector

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

dotProduct

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

Description copied from class: AVector

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

Overrides:

dotProduct in class AVector

innerProduct

public AVector innerProduct(AMatrix a)

Description copied from class: AVector

Computes the inner product of this vector with a matrix

Overrides:

innerProduct in class ASparseVector

Returns:

a vector representing the inner product

dotProduct

public final double dotProduct(AVector v)

Description copied from class: AVector

Returns the dot product of this vector with another vector The vectors must have the same length: if not the result is undefined

Overrides:

dotProduct in class ASparseVector

Returns:

dotProduct

public final double dotProduct(ASparseVector v)

nonZeroIndices

public int[] nonZeroIndices()

Description copied from class: AVector

Return an int array specifying the positions in this vector which are non-zero

Overrides:

nonZeroIndices in class AVector

Returns:

addToArray

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

Description copied from class: AVector

Adds a subvector of this vector into a double array at the specified offset

Overrides:

addToArray in class AVector

addToArray

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

Description copied from class: AVector

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

Specified by:

addToArray in interface INDArray

Overrides:

addToArray in class AVector

addToArray

public void addToArray(double[] dest,
                       int offset,
                       int stride)

Description copied from class: AVector

Adds this vector to a double[] array, using the specified offset and stride into the destination array

Overrides:

addToArray in class AVector

addMultipleToArray

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

Description copied from class: AVector

Adds a multiple of a subvector of this vector into a double array at the specified offset

Overrides:

addMultipleToArray in class AVector

addProductToArray

public void addProductToArray(double factor,
                              int offset,
                              AVector other,
                              int otherOffset,
                              double[] array,
                              int arrayOffset,
                              int length)

Overrides:

addProductToArray in class AVector

addProductToArray

public void addProductToArray(double factor,
                              int offset,
                              ADenseArrayVector other,
                              int otherOffset,
                              double[] array,
                              int arrayOffset,
                              int length)

Description copied from class: AVector

Adds the scaled elementwise product of this vector and another vector to the destimation array

Overrides:

addProductToArray in class AVector

equalsArray

public boolean equalsArray(double[] ds,
                           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 ASizedVector

Parameters:

ds - Array of double element values to check for equality

offset - Offset into the data array

Returns:

equals

public boolean equals(AVector v)

Overrides:

equals in class ASparseVector

cloneIncludingIndices

public final SparseIndexedVector cloneIncludingIndices(int[] ixs)

Create a clone of this sparse indexed vector including the new indexes specified Intended to allow fast subsequent modification

getElements

public final void getElements(double[] array,
                              int offset)

Description copied from interface: INDArray

Gets all elements of the array, copying them into a double array at the specified offset

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AVector

copyTo

public final void copyTo(AVector v,
                         int offset)

Description copied from class: AVector

Copies a the contents of a vector to a vector at the specified offset

Overrides:

copyTo in class AVector

copySparseValuesTo

protected final void copySparseValuesTo(double[] array,
                                        int offset)

Copy only the sparse values in this vector to a target array. Other values in the target array are unchanged

Parameters:

array -

offset -