mikera.vectorz.impl

Class ASingleElementVector

java.lang.Object

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

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.ASparseVector

mikera.vectorz.impl.ASingleElementVector

All Implemented Interfaces:

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

Direct Known Subclasses:

AxisVector, SingleElementVector

public abstract class ASingleElementVector
extends ASparseVector

Abstract base classes for immutable sparse vectors that have a single potentially non-zero element

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
abstract 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.
abstract boolean	equals(AVector v) Returns true if this array is exactly equal to a vector.
void	getElements(double[] dest, int offset) Copies all elements of this array a double array at the specified offset
boolean	isElementConstrained() Returns true if this array has some constraints on element values
boolean	isMutable() Returns true if this vector is mutable.
int	nonSparseElementCount() Returns the number of non-sparse elements in the sparse vector.
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.
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
AScalar	slice(int i) Returns the specified major slice of this array as a view (slice along dimension 0) 0 dimensional slice results are permitted, but attempting to slice a 0 dimensional array will result in an error.

Methods inherited from class mikera.vectorz.impl.ASparseVector

add, add, addMultiple, clone, copyTo, copyTo, density, distanceL1, distanceLinf, distanceSquared, dotProduct, elementAbsPowSum, elementPowSum, elementProduct, elementSquaredSum, elementSum, equals, getSlices, hasUncountable, includesIndex, innerProduct, isSparse, isView, isZero, reduce, reduce, reduceSlices, roundToZero, sparse, toDoubleArray, toSparseIndexedVector, visitNonZero

Methods inherited from class mikera.vectorz.impl.ASizedVector

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

Methods inherited from class mikera.vectorz.AVector

abs, absCopy, absDiff, absDiff, absDiff, absDiffCopy, add, add, add, add, add, add, add, add, addAt, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addInnerProduct, 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, clamp, clampMax, clampMin, compareTo, compareTo, copy, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, divide, divide, divide, divide, divideCopy, divideCopy, divideCopy, divideTo, dotProduct, dotProduct, elementIterator, elementMax, elementMaxAbs, elementMin, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, exactClone, fill, fillRange, get, get, get, get, get, get, getElement, getElements, getElements, getLongShape, getShape, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isFullyMutable, isRangeZero, isSameShape, isUnitLengthVector, isUnitLengthVector, 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, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reciprocal, reciprocalCopy, 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, setApplyOp, setApplyOp, setApplyOp, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, setSparse, setSparse, setSparse, shiftCopy, signum, 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, addApplyOp, addCopy, addInnerProduct, addInnerProduct, addOuterProduct, addOuterProductSparse, addSparse, broadcastCloneLike, broadcastCopyLike, componentCount, ensureMutable, epsilonEquals, exp, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, 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, divideCopy, epsilonEquals, get, isSameShape, length, multiplyCopy, normalise, normaliseCopy, rotateCopy, rotateView, set, 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, elementCount, elementIterator, elementMax, elementMaxAbs, elementMin, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, equalsArray, exactClone, exp, fill, get, get, get, get, get, get, get, get, getComponent, getComponents, getElement, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isFullyMutable, isSameShape, join, join, log, multiply, 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, setApplyOp, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, setSparse, setSparse, signum, signumCopy, slice, sliceCount, sliceValue, sparseClone, sqrt, square, squareCopy, sub, sub, subArray, subCopy, toDoubleBuffer, toSliceArray, toVector, validate, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

isMutable

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

isElementConstrained

public final boolean isElementConstrained()

Description copied from interface: INDArray

Returns true if this array has some constraints on element values

Specified by:

isElementConstrained in interface INDArray

Overrides:

isElementConstrained in class AVector

dotProduct

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

Specified by:

dotProduct in class ASparseVector

Returns:

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

nonSparseElementCount

public int nonSparseElementCount()

Description copied from class: ASparseVector

Returns the number of non-sparse elements in the sparse vector. This will be greater or equal to the number of non-zero elements

Specified by:

nonSparseElementCount in class ASparseVector

Returns:

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

Specified by:

nonSparseValues in class ASparseVector

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

Specified by:

nonSparseIndex in class ASparseVector

Returns:

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

getElements

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

Description copied from interface: INDArray

Copies all elements of this array a double array at the specified offset

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AVector

slice

public AScalar slice(int i)

Description copied from interface: INDArray

Returns the specified major slice of this array as a view (slice along dimension 0) 0 dimensional slice results are permitted, but attempting to slice a 0 dimensional array will result in an error.

Specified by:

slice in interface INDArray

Overrides:

slice in class AVector

equals

public abstract boolean equals(AVector v)

Description copied from class: AbstractArray

Returns true if this array is exactly equal to a vector.

Overrides:

equals in class ASparseVector

Returns:

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: