ASparseVector (Vectorz 0.62.0 API)

java.lang.Object
- mikera.arrayz.impl.AbstractArray<Double>
- - mikera.vectorz.AVector
  - - mikera.vectorz.impl.ASizedVector
    - - mikera.vectorz.impl.ASparseVector

All Implemented Interfaces:

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

Direct Known Subclasses:

ASingleElementVector, ASparseIndexedVector, SparseHashedVector, ZeroVector
```
public abstract class ASparseVector
extends ASizedVector
implements ISparseVector
```
Abstract base class for Sparse vector implementations

Author:

Mike

See Also:

Serialized Form

Field Summary
- Fields inherited from class mikera.vectorz.impl.ASizedVector
  length

Constructor Summary

Constructors
Modifier Constructor and Description

protected ASparseVector(int length)

Constructors
Modifier	Constructor and Description
`protected`	`ASparseVector(int length)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`add(ASparseVector v)`
`void`	`add(AVector v)` Adds another vector to this one
`void`	`addMultiple(AVector src, double factor)` Adds a scaled multiple of another vector to this vector
`AVector`	`clone()` Clones the vector, creating a new mutable copy of all data.
`void`	`copyTo(int offset, double[] destData, int destOffset, int length)` Copies a subset of this vector to a specified destination array offset
`void`	`copyTo(int offset, double[] destData, int destOffset, int length, int stride)` Copies a subset of this vector to a specified destination array offset using the given stride.
`double`	`distanceL1(AVector v)` Returns the distance from this vector to another vector according to the L1 (Taxicab) norm.
`double`	`distanceLinf(AVector v)` Returns the distance from this vector to another vector according to the Linf norm.
`double`	`distanceSquared(AVector v)` Returns the squared Euclidean distance to another vector.
`double`	`dotProduct(ADenseArrayVector v)` Returns the dot product of this vector with a target ADenseArrayVector.
`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`	`elementAbsPowSum(double p)` Returns the sum of the absolute values of all the elements raised to a specified power
`double`	`elementPowSum(double p)` Returns the sum of all the elements raised to a specified power
`double`	`elementProduct()` Returns the product of all elements in the array.
`double`	`elementSquaredSum()` Returns the sum of squared elements in this array.
`double`	`elementSum()` Returns the sum of all elements in a vector
`boolean`	`equals(ASparseVector v)`
`boolean`	`equals(AVector v)`
`List<Double>`	`getSlices()` Returns a list of all major slices of this array.
`boolean`	`hasUncountable()` Returns true if any element is this array is NaN or infinite
`abstract boolean`	`includesIndex(int i)` Returns true iff the sparse vector contains the index i
`AVector`	`innerProduct(AMatrix m)` Computes the inner product of this vector with a matrix
`boolean`	`isSparse()` Returns true if the array is in a sparse format
`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)
`abstract int`	`nonSparseElementCount()` Returns the number of non-sparse elements in the sparse vector.
`abstract Index`	`nonSparseIndex()` Returns an Index indicating which elements of this vector are defined as non-sparse.
`abstract AVector`	`nonSparseValues()` Returns the non-sparse elements as a compacted vector
`long`	`nonZeroCount()` Returns the number of non-zero elements in the array.
`double`	`reduce(Op2 op)` Reduces over all elements of the array in row-major order.
`double`	`reduce(Op2 op, double init)` Reduces over all elements of the array in row-major order.
`AVector`	`reduceSlices(Op2 op, double init)` Reduces each slice of the array by the given operator Uses the specified init value for reduction of each slice
`ASparseVector`	`roundToZero(double precision)` Returns a vector after replacing all elements with absolute values less-than-or-equal to precision with zeros.
`ASparseVector`	`sparse()` Coerces this INDArray to a sparse format, without changing its element values.
`double[]`	`toDoubleArray()` Copies the elements of this array to a new double[] array.
`SparseIndexedVector`	`toSparseIndexedVector()` Coerces this vector to a SparseIndexedVector.

Methods inherited from class mikera.vectorz.impl.ASizedVector
checkIndex, checkLength, checkRange, checkSameLength, checkSameLength, elementCount, equalsArray, 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, addMultipleToArray, addPower, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, addToArray, addToArray, addToArray, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, checkDimension, checkSameLength, clamp, clampMax, clampMin, compareTo, copy, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, divide, divide, divide, divide, divideCopy, divideCopy, divideTo, dotProduct, dotProduct, dotProduct, elementIterator, elementMax, elementMin, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, exactClone, fill, fillRange, get, get, get, get, get, getElements, getElements, getElements, getLongShape, getShape, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isFullyMutable, isMutable, 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, nonZeroIndices, 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, addToArray, 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, equalsArray, exactClone, exp, fill, get, get, get, get, get, get, get, get, getComponent, getComponents, getElements, 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, 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
  - ASparseVector
```
protected ASparseVector(int length)
```
- Method Detail
  - nonSparseElementCount
```
public abstract int nonSparseElementCount()
```
    Returns the number of non-sparse elements in the sparse vector. This will be greater or equal to the number of non-zero elements
    
    Returns:
  - nonSparseValues
```
public abstract AVector nonSparseValues()
```
    Description copied from interface: ISparseVector
    
    Returns the non-sparse elements as a compacted vector
    
    Specified by:
    
    nonSparseValues in interface ISparseVector
    
    Returns:
  - nonSparseIndex
```
public abstract 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 expected be non-zero.
    
    Specified by:
    
    nonSparseIndex in interface ISparseVector
    
    Overrides:
    
    nonSparseIndex in class AVector
    
    Returns:
  - includesIndex
```
public abstract boolean includesIndex(int i)
```
    Returns true iff the sparse vector contains the index i
    
    Parameters:
    
    i -
    
    Returns:
  - roundToZero
```
public ASparseVector roundToZero(double precision)
```
    Returns a vector after replacing all elements with absolute values less-than-or-equal to precision with zeros. May return either this vector or a new vector. If this vector is return, it may have been mutated.
    
    Parameters:
    
    precision -
    
    Returns:
  - copyTo
```
public void copyTo(int offset,
                   double[] destData,
                   int destOffset,
                   int length)
```
    Description copied from class: AVector
    
    Copies a subset of this vector to a specified destination array offset
    
    Overrides:
    
    copyTo in class AVector
  - copyTo
```
public void copyTo(int offset,
                   double[] destData,
                   int destOffset,
                   int length,
                   int stride)
```
    Description copied from class: AVector
    
    Copies a subset of this vector to a specified destination array offset using the given stride. Unsafe operation: performs no bounds checking
    
    Overrides:
    
    copyTo in class AVector
  - 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
  - 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
  - reduce
```
public double reduce(Op2 op,
                     double init)
```
    Description copied from interface: INDArray
    
    Reduces over all elements of the array in row-major order. Applies the operator to the initial/previous result at each step. Returns the final result.
    
    Specified by:
    
    reduce in interface INDArray
    
    Overrides:
    
    reduce in class AVector
  - reduce
```
public double reduce(Op2 op)
```
    Description copied from interface: INDArray
    
    Reduces over all elements of the array in row-major order. Applies the operator to the previous result at each step. Returns the final result.
    
    Specified by:
    
    reduce in interface INDArray
    
    Overrides:
    
    reduce in class AVector
  - reduceSlices
```
public final AVector reduceSlices(Op2 op,
                                  double init)
```
    Description copied from interface: INDArray
    
    Reduces each slice of the array by the given operator Uses the specified init value for reduction of each slice
    
    Specified by:
    
    reduceSlices in interface INDArray
    
    Overrides:
    
    reduceSlices in class AVector
  - distanceSquared
```
public double distanceSquared(AVector v)
```
    Description copied from class: AVector
    
    Returns the squared Euclidean distance to another vector.
    
    Overrides:
    
    distanceSquared in class AVector
    
    Returns:
  - dotProduct
```
public 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 AVector
    
    Returns:
  - dotProduct
```
public final double dotProduct(ADenseArrayVector v)
```
    Description copied from class: AVector
    
    Returns the dot product of this vector with a target ADenseArrayVector.
    
    Overrides:
    
    dotProduct in class AVector
    
    Returns:
  - innerProduct
```
public AVector innerProduct(AMatrix m)
```
    Description copied from class: AVector
    
    Computes the inner product of this vector with a matrix
    
    Overrides:
    
    innerProduct in class AVector
    
    Returns:
    
    a vector representing the inner product
  - isSparse
```
public final boolean isSparse()
```
    Description copied from interface: INDArray
    
    Returns true if the array is in a sparse format
    
    Specified by:
    
    isSparse in interface INDArray
    
    Overrides:
    
    isSparse in class AbstractArray<Double>
  - add
```
public void add(AVector v)
```
    Description copied from class: AVector
    
    Adds another vector to this one
    
    Overrides:
    
    add in class AVector
  - addMultiple
```
public void addMultiple(AVector src,
                        double factor)
```
    Description copied from class: AVector
    
    Adds a scaled multiple of another vector to this vector
    
    Overrides:
    
    addMultiple in class AVector
  - add
```
public abstract void add(ASparseVector v)
```
  - getSlices
```
public List<Double> getSlices()
```
    Description copied from interface: INDArray
    
    Returns a list of all major slices of this array. Returns a list of Double values if a 1-dimensional array is sliced, otherwise a list of INDArray instances
    
    Specified by:
    
    getSlices in interface INDArray
    
    Overrides:
    
    getSlices in class AVector
  - elementProduct
```
public double elementProduct()
```
    Description copied from interface: INDArray
    
    Returns the product of all elements in the array.
    
    Specified by:
    
    elementProduct in interface INDArray
    
    Overrides:
    
    elementProduct in class AVector
    
    Returns:
  - sparse
```
public ASparseVector 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
  - clone
```
public AVector 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
    
    Specified by:
    
    clone in interface IVector
    
    Overrides:
    
    clone in class AVector
  - equals
```
public boolean equals(ASparseVector v)
```
  - toDoubleArray
```
public double[] toDoubleArray()
```
    Description copied from interface: INDArray
    
    Copies the elements of this array to a new double[] array.
    
    Specified by:
    
    toDoubleArray in interface INDArray
    
    Overrides:
    
    toDoubleArray in class AVector
  - 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 AVector
  - equals
```
public boolean equals(AVector v)
```
    Overrides:
    
    equals in class AVector
  - hasUncountable
```
public boolean hasUncountable()
```
    Description copied from class: AbstractArray
    
    Returns true if any element is this array is NaN or infinite
    
    Specified by:
    
    hasUncountable in interface INDArray
    
    Overrides:
    
    hasUncountable in class AVector
    
    Returns:
    
    True if any element is this array is NaN or infinite, false otherwise
  - elementPowSum
```
public double elementPowSum(double p)
```
    Returns the sum of all the elements raised to a specified power
    
    Specified by:
    
    elementPowSum in interface INDArray
    
    Overrides:
    
    elementPowSum in class AVector
    
    Returns:
  - elementAbsPowSum
```
public double elementAbsPowSum(double p)
```
    Returns the sum of the absolute values of all the elements raised to a specified power
    
    Specified by:
    
    elementAbsPowSum in interface INDArray
    
    Overrides:
    
    elementAbsPowSum 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 AVector
  - 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 AVector
  - distanceL1
```
public double distanceL1(AVector v)
```
    Description copied from class: AVector
    
    Returns the distance from this vector to another vector according to the L1 (Taxicab) norm.
    
    Overrides:
    
    distanceL1 in class AVector
    
    Returns:
  - distanceLinf
```
public double distanceLinf(AVector v)
```
    Description copied from class: AVector
    
    Returns the distance from this vector to another vector according to the Linf norm.
    
    Overrides:
    
    distanceLinf in class AVector
    
    Returns:
  - 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:

Class ASparseVector

Field Summary

Fields inherited from class mikera.vectorz.impl.ASizedVector

Constructor Summary

Method Summary

Methods inherited from class mikera.vectorz.impl.ASizedVector

Methods inherited from class mikera.vectorz.AVector

Methods inherited from class mikera.arrayz.impl.AbstractArray

Methods inherited from class java.lang.Object

Methods inherited from interface mikera.vectorz.IVector

Methods inherited from interface mikera.arrayz.INDArray

Methods inherited from interface mikera.arrayz.ISparse

Methods inherited from interface java.lang.Iterable

Constructor Detail

ASparseVector

Method Detail

nonSparseElementCount

nonSparseValues

nonSparseIndex

includesIndex

roundToZero

copyTo

copyTo

isZero

isView

reduce

reduce

reduceSlices

distanceSquared

dotProduct

dotProduct

innerProduct

isSparse

add

addMultiple

add

getSlices

elementProduct

sparse

clone

equals

toDoubleArray

nonZeroCount

equals

hasUncountable

elementPowSum

elementAbsPowSum

elementSum

elementSquaredSum

distanceL1

distanceLinf

toSparseIndexedVector