SparseIndexedVector (Vectorz 0.62.0 API)

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, INDArray, ISparse, ISparseVector, IVector
```
public class SparseIndexedVector
extends ASparseIndexedVector
```
Indexed sparse vector. Efficient for mutable, mostly sparse vectors. Maintains a indexed array of elements which may be non-zero. These values *can* also be zero. WARNING: individual updates of non-indexed elements are O(n) in the number of non-sparse elements. You should not normally perform element-wise mutation on a SparseIndexedVector if performance is a concern Index must be distinct and sorted.

Author:

Mike

See Also:

Serialized Form

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abs()` Replaces all elements of this array with their absolute values, according to Math.abs(double)
`void`	`add(ASparseVector v)`
`void`	`add(AVector v)` Adds another vector to this one
`void`	`add(double[] src, int srcOffset)` Adds to this vector from a given double array.
`void`	`addAt(int i, double value)` Adds a value to a specific element of the vector This function does not perform bounds checking, i.e.
`void`	`addMultiple(ASparseVector v, double factor)`
`void`	`addMultiple(AVector v, double factor)` Adds a scaled multiple of another vector to this vector
`void`	`addMultiple(SparseIndexedVector v, double factor)` Adds a scaled multiple of a sparse indexed vector to this vector
`void`	`applyOp(Op op)` Applies a unary operator to all elements of the array (in-place)
`void`	`applyOp(Op2 op, double d)` Applies a binary operator to this array and a double value.
`SparseIndexedVector`	`clone()` Clones the vector, creating a new mutable copy of all data.
`static SparseIndexedVector`	`create(ASparseVector source)`
`static SparseIndexedVector`	`create(AVector source)` Creates a SparseIndexedVector from the given vector, ignoring the zeros in the source.
`static SparseIndexedVector`	`create(double[] values)` Creates a SparseIndexedVector from an array of double values
`static SparseIndexedVector`	`create(int length, Index index, AVector data)` Creates a SparseIndexedVector using the given sorted Index to identify the indexes of non-zero values, and a dense vector to specify all the non-zero element values
`static SparseIndexedVector`	`create(int length, Index index, double[] data)` Creates a SparseIndexedVector using the given sorted Index to identify the indexes of non-zero values, and a double[] array to specify all the non-zero element values
`static SparseIndexedVector`	`create(Iterable<?> iterable)` Creates a SparseIndexedVector from the specified Iterable object
`static SparseIndexedVector`	`create(Iterator<?> iterator)` Creates a SparseIndexedVector from the specified Iterator object
`static SparseIndexedVector`	`create(Object o)` Creates a SparseIndexedVector from the source object
`static SparseIndexedVector`	`create(Object[] values)` Creates a SparseIndexedVector from the source object array
`static SparseIndexedVector`	`create(SparseHashedVector source)`
`static AVector`	`createFromRow(AMatrix m, int row)` Creates a SparseIndexedVector from a row of an existing matrix
`static SparseIndexedVector`	`createLength(int length)`
`static AVector`	`createWithIndices(AVector v, int[] ixs)` Creates a sparse indexed vector using the specified indexed values from the source vector All non-indexed vales will be zero.
`SparseIndexedVector`	`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
`AVector`	`immutable()` Creates an immutable copy of a vector
`void`	`includeIndices(ASparseIndexedVector v)`
`void`	`includeIndices(AVector v)` Include additional indices in the non-sparse index set of this vector.
`void`	`includeIndices(Index ixs)` Include additional indices in the non-sparse index set of this vector.
`protected void`	`includeIndices(int[] ixs)` Include additional indices in the non-sparse index set of this vector.
`AVector`	`innerProduct(AMatrix m)` Computes the inner product of this vector with a matrix
`AVector`	`innerProduct(SparseColumnMatrix m)`
`AVector`	`innerProduct(SparseRowMatrix m)`
`boolean`	`isFullyMutable()` Returns true if this vector is fully mutable, i.e.
`boolean`	`isMutable()` Returns true if this vector is mutable.
`double`	`maxAbsElement()` Returns the maximum absolute element value of a vector
`int`	`maxAbsElementIndex()` Returns the index of the maximum absolute element of a vector
`int`	`maxElementIndex()` Returns the index of the maximum element of a vector
`int`	`minElementIndex()` Returns the index of the minimum element of a vector
`void`	`multiply(ADenseArrayVector v)`
`void`	`multiply(ASparseVector v)`
`void`	`multiply(AVector v)`
`void`	`multiply(double d)` Multiplies the vector by a constant factor
`void`	`multiply(double[] array, int offset)` Multiplies the elements in this vector by corresponding elements in the target array
`SparseIndexedVector`	`multiplyCopy(double factor)` Returns a copy of the array with all elements multiplied by a single constant value
`void`	`negate()` Negates all emlements of this vector in place.
`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.
`Vector`	`nonSparseValues()` Returns the non-sparse elements as a compacted vector
`void`	`pow(double exponent)` Raises all elements of the array to a specified power in place
`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.
`ASparseVector`	`roundToZero(double precision)` Returns a vector after replacing all elements with absolute values less-than-or-equal to precision with zeros.
`void`	`set(ADenseArrayVector v)` Sets the vector equal to the value of an ADenseArrayVector
`void`	`set(AVector v)` Sets the vector to equal the value of another vector
`void`	`set(int i, double value)` Sets a value at a given position in a mutable 1D array
`void`	`setElements(double[] array, int offset)` Sets all elements in an array using the given double values
`void`	`setElements(int pos, double[] array, int offset, int length)` Sets elements in an array using the given double values.
`SparseIndexedVector`	`sparseClone()` Clones the vector into a sparse mutable format
`void`	`square()` Squares all elements of the array in place
`void`	`sub(ASparseVector v)`
`void`	`sub(AVector v)` Subtracts a vector from this vector
`SparseIndexedVector`	`toSparseIndexedVector()` Coerces this vector to a SparseIndexedVector.
`Vector`	`toVector()` Coerces this vector to the standard dense Vector format.
`double`	`unsafeGet(int i)`
`void`	`unsafeSet(int i, double value)`
`void`	`validate()` Validates the internal data structure of the INDArray.
`static SparseIndexedVector`	`wrap(int length, Index index, double[] data)` Creates a SparseIndexedVector with the specified index and data values.
`static SparseIndexedVector`	`wrap(int length, int[] indices, double[] data)` Creates a SparseIndexedVector with the specified index and data values.

Methods inherited from class mikera.vectorz.impl.ASparseIndexedVector
addMultipleToArray, addProductToArray, addProductToArray, addToArray, addToArray, addToArray, cloneIncludingIndices, copySparseValuesTo, copyTo, dotProduct, dotProduct, dotProduct, dotProduct, elementSquaredSum, elementSum, equals, equalsArray, getElements, includesIndex, isRangeZero, isZero, nonZeroCount, nonZeroIndices

Methods inherited from class mikera.vectorz.impl.ASparseVector
copyTo, copyTo, distanceL1, distanceLinf, distanceSquared, dotProduct, elementAbsPowSum, elementPowSum, elementProduct, equals, getSlices, hasUncountable, isSparse, isView, reduceSlices, sparse, toDoubleArray

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
absCopy, add, add, add, add, add, add, add, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleToArray, addPower, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addWeighted, angle, 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, fill, fillRange, get, get, get, get, getElements, getElements, getLongShape, getShape, getTranspose, getTransposeCopy, getTransposeView, hashCode, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isSameShape, isUnitLengthVector, isUnitLengthVector, iterator, join, join, join, log, logistic, magnitude, magnitudeSquared, maxElement, minElement, multiply, multiplyCopy, multiplyCopy, multiplyTo, mutable, negateCopy, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, 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, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, shiftCopy, signum, slice, slice, sliceValue, softmax, softmaxCopy, sqrtCopy, squareCopy, sub, subArray, subAt, subCopy, subCopy, subMultiple, subVector, tanh, toDoubleBuffer, toList, toNormal, toSliceArray, toString, toStringFull, tryEfficientJoin

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, isSameShape, length, multiplyCopy, normalise, normaliseCopy, rotateCopy, rotateView, shiftCopy, sqrtCopy, subCopy

Methods inherited from interface mikera.arrayz.INDArray
absCopy, add, add, addAt, addCopy, addCopy, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, 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, exp, fill, get, get, get, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isSameShape, join, join, log, multiply, multiplyCopy, mutable, negateCopy, outerProduct, reciprocal, reciprocalCopy, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, setElements, setInnerProduct, setMultiple, setMultiple, signum, signumCopy, slice, slice, sliceCount, sliceValue, sqrt, squareCopy, sub, sub, subArray, subCopy, toArray, toDoubleBuffer, toSliceArray, withComponents

Methods inherited from interface mikera.arrayz.ISparse
density

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - wrap
```
public static SparseIndexedVector wrap(int length,
                                       Index index,
                                       double[] data)
```
    Creates a SparseIndexedVector with the specified index and data values. Performs no checking - Index must be distinct and sorted.
  - wrap
```
public static SparseIndexedVector wrap(int length,
                                       int[] indices,
                                       double[] data)
```
    Creates a SparseIndexedVector with the specified index and data values. Performs no checking - Index must be distinct and sorted.
  - create
```
public static SparseIndexedVector create(int length,
                                         Index index,
                                         double[] data)
```
    Creates a SparseIndexedVector using the given sorted Index to identify the indexes of non-zero values, and a double[] array to specify all the non-zero element values
  - createWithIndices
```
public static AVector createWithIndices(AVector v,
                                        int[] ixs)
```
    Creates a sparse indexed vector using the specified indexed values from the source vector All non-indexed vales will be zero.
    
    Parameters:
    
    v -
    
    ixs -
    
    Returns:
  - createLength
```
public static SparseIndexedVector createLength(int length)
```
  - create
```
public static SparseIndexedVector create(int length,
                                         Index index,
                                         AVector data)
```
    Creates a SparseIndexedVector using the given sorted Index to identify the indexes of non-zero values, and a dense vector to specify all the non-zero element values
  - create
```
public static SparseIndexedVector create(Object o)
```
    Creates a SparseIndexedVector from the source object
    
    Parameters:
    
    o -
    
    Returns:
  - create
```
public static SparseIndexedVector create(double[] values)
```
    Creates a SparseIndexedVector from an array of double values
    
    Parameters:
    
    o -
    
    Returns:
  - create
```
public static SparseIndexedVector create(Object[] values)
```
    Creates a SparseIndexedVector from the source object array
    
    Parameters:
    
    o -
    
    Returns:
  - create
```
public static SparseIndexedVector create(AVector source)
```
    Creates a SparseIndexedVector from the given vector, ignoring the zeros in the source.
  - create
```
public static SparseIndexedVector create(ASparseVector source)
```
  - create
```
public static SparseIndexedVector create(SparseHashedVector source)
```
  - create
```
public static SparseIndexedVector create(Iterable<?> iterable)
```
    Creates a SparseIndexedVector from the specified Iterable object
    
    Parameters:
    
    iterable - An Iterable containing java.lang.Number instances
    
    Returns:
  - create
```
public static SparseIndexedVector create(Iterator<?> iterator)
```
    Creates a SparseIndexedVector from the specified Iterator object
    
    Parameters:
    
    iterator - An Iterator over java.lang.Number instances
    
    Returns:
  - createFromRow
```
public static AVector createFromRow(AMatrix m,
                                    int row)
```
    Creates a SparseIndexedVector from a row of an existing matrix
  - 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:
  - innerProduct
```
public AVector innerProduct(SparseRowMatrix m)
```
  - innerProduct
```
public AVector innerProduct(SparseColumnMatrix m)
```
  - 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 ASparseIndexedVector
    
    Returns:
    
    a vector representing the inner product
  - add
```
public void add(AVector v)
```
    Description copied from class: AVector
    
    Adds another vector to this one
    
    Overrides:
    
    add in class ASparseVector
  - addMultiple
```
public void addMultiple(AVector v,
                        double factor)
```
    Description copied from class: AVector
    
    Adds a scaled multiple of another vector to this vector
    
    Overrides:
    
    addMultiple in class ASparseVector
  - add
```
public void add(double[] src,
                int srcOffset)
```
    Description copied from class: AVector
    
    Adds to this vector from a given double array.
    
    Overrides:
    
    add in class AVector
  - add
```
public void add(ASparseVector v)
```
    Specified by:
    
    add in class ASparseVector
  - addMultiple
```
public void addMultiple(ASparseVector v,
                        double factor)
```
  - addMultiple
```
public void addMultiple(SparseIndexedVector v,
                        double factor)
```
    Description copied from class: AVector
    
    Adds a scaled multiple of a sparse indexed vector to this vector
    
    Overrides:
    
    addMultiple in class AVector
  - sub
```
public void sub(AVector v)
```
    Description copied from class: AVector
    
    Subtracts a vector from this vector
    
    Overrides:
    
    sub in class AVector
  - sub
```
public void sub(ASparseVector v)
```
  - multiply
```
public void multiply(double d)
```
    Description copied from class: AVector
    
    Multiplies the vector by a constant factor
    
    Specified by:
    
    multiply in interface INDArray
    
    Overrides:
    
    multiply in class ASparseIndexedVector
    
    Parameters:
    
    d - Factor by which to multiply each component of the vector
  - pow
```
public void pow(double exponent)
```
    Description copied from interface: INDArray
    
    Raises all elements of the array to a specified power in place
    
    Specified by:
    
    pow in interface INDArray
    
    Overrides:
    
    pow in class AVector
  - square
```
public void square()
```
    Description copied from interface: INDArray
    
    Squares all elements of the array in place
    
    Specified by:
    
    square in interface INDArray
    
    Overrides:
    
    square in class AVector
  - multiply
```
public void multiply(AVector v)
```
    Overrides:
    
    multiply in class AVector
  - multiply
```
public void multiply(ASparseVector v)
```
  - multiply
```
public void multiply(ADenseArrayVector v)
```
    Overrides:
    
    multiply in class AVector
  - multiplyCopy
```
public SparseIndexedVector multiplyCopy(double factor)
```
    Description copied from interface: INDArray
    
    Returns a copy of the array with all elements multiplied by a single constant value
    
    Specified by:
    
    multiplyCopy in interface INDArray
    
    Overrides:
    
    multiplyCopy in class AVector
    
    Parameters:
    
    factor - A scalar factor
    
    Returns:
    
    A new array, with all element values scaled by the given factor
  - multiply
```
public void multiply(double[] array,
                     int offset)
```
    Description copied from class: AVector
    
    Multiplies the elements in this vector by corresponding elements in the target array
    
    Overrides:
    
    multiply in class AVector
    
    offset - The offset into the target array
  - maxAbsElement
```
public double maxAbsElement()
```
    Description copied from class: AVector
    
    Returns the maximum absolute element value of a vector
    
    Overrides:
    
    maxAbsElement in class AVector
    
    Returns:
  - maxElementIndex
```
public int maxElementIndex()
```
    Description copied from class: AVector
    
    Returns the index of the maximum element of a vector
    
    Overrides:
    
    maxElementIndex in class AVector
    
    Returns:
  - maxAbsElementIndex
```
public int maxAbsElementIndex()
```
    Description copied from class: AVector
    
    Returns the index of the maximum absolute element of a vector
    
    Overrides:
    
    maxAbsElementIndex in class AVector
    
    Returns:
  - minElementIndex
```
public int minElementIndex()
```
    Description copied from class: AVector
    
    Returns the index of the minimum element of a vector
    
    Overrides:
    
    minElementIndex in class AVector
  - negate
```
public void negate()
```
    Description copied from class: AVector
    
    Negates all emlements of this vector in place.
    
    Specified by:
    
    negate in interface INDArray
    
    Overrides:
    
    negate in class AVector
  - applyOp
```
public void applyOp(Op op)
```
    Description copied from interface: INDArray
    
    Applies a unary operator to all elements of the array (in-place)
    
    Specified by:
    
    applyOp in interface INDArray
    
    Overrides:
    
    applyOp in class AVector
  - applyOp
```
public void applyOp(Op2 op,
                    double d)
```
    Description copied from interface: INDArray
    
    Applies a binary operator to this array and a double value. Works as if the double value was broadcast to the shape of this array.
    
    Specified by:
    
    applyOp in interface INDArray
    
    Overrides:
    
    applyOp 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 ASparseVector
  - 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 ASparseVector
  - abs
```
public void abs()
```
    Description copied from interface: INDArray
    
    Replaces all elements of this array with their absolute values, according to Math.abs(double)
    
    Specified by:
    
    abs in interface INDArray
    
    Overrides:
    
    abs 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
  - unsafeGet
```
public double unsafeGet(int i)
```
    Overrides:
    
    unsafeGet in class AVector
  - 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
  - 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
  - setElements
```
public void setElements(double[] array,
                        int offset)
```
    Description copied from interface: INDArray
    
    Sets all elements in an array using the given double values
    
    Specified by:
    
    setElements in interface INDArray
    
    Overrides:
    
    setElements in class AVector
    
    Parameters:
    
    array - Element values in a double[] array. There must be at least as many element values as elements in this array.
    
    offset - Position in the values array from which to start taking values.
  - setElements
```
public void setElements(int pos,
                        double[] array,
                        int offset,
                        int length)
```
    Description copied from interface: INDArray
    
    Sets elements in an array using the given double values. The source array must contain at least the specified length in terms of number of elements
    
    Specified by:
    
    setElements in interface INDArray
    
    Overrides:
    
    setElements in class AVector
    
    Parameters:
    
    pos - Offset into this array, expressed in terms of number of elements in row major order
    
    array - Element values in a double[] array. There must be at least as many element values as elements in this array.
    
    offset - Position in the values array from which to start taking values.
    
    length - Number of elements to set.
  - set
```
public void set(AVector v)
```
    Description copied from class: AVector
    
    Sets the vector to equal the value of another vector
    
    Overrides:
    
    set in class AVector
  - set
```
public void set(ADenseArrayVector v)
```
    Description copied from class: AVector
    
    Sets the vector equal to the value of an ADenseArrayVector
    
    Overrides:
    
    set in class AVector
  - 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
  - unsafeSet
```
public void unsafeSet(int i,
                      double value)
```
    Overrides:
    
    unsafeSet in class AVector
  - addAt
```
public void addAt(int i,
                  double value)
```
    Description copied from class: AVector
    
    Adds a value to a specific element of the vector This function does not perform bounds checking, i.e. is an unsafe operation
    
    Overrides:
    
    addAt in class AVector
  - roundToZero
```
public ASparseVector roundToZero(double precision)
```
    Description copied from class: ASparseVector
    
    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.
    
    Overrides:
    
    roundToZero in class ASparseVector
    
    Returns:
  - nonSparseValues
```
public Vector nonSparseValues()
```
    Description copied from interface: ISparseVector
    
    Returns the non-sparse elements as a compacted vector
    
    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 expected be non-zero.
    
    Specified by:
    
    nonSparseIndex in interface ISparseVector
    
    Specified by:
    
    nonSparseIndex in class ASparseVector
    
    Returns:
  - toVector
```
public Vector toVector()
```
    Description copied from class: AVector
    
    Coerces this vector to the standard dense Vector format. May return the same vector is thsis is already a dense Vector, otherwise returns a Vector containing a new clone of the vector elements.
    
    Specified by:
    
    toVector in interface INDArray
    
    Overrides:
    
    toVector 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
    
    Overrides:
    
    toSparseIndexedVector in class ASparseVector
    
    Returns:
  - clone
```
public SparseIndexedVector 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 ASparseVector
  - includeIndices
```
protected void includeIndices(int[] ixs)
```
    Include additional indices in the non-sparse index set of this vector. Useful to improve performance if subsequent operations will access these indices.
    
    Parameters:
    
    ixs -
  - includeIndices
```
public void includeIndices(Index ixs)
```
    Include additional indices in the non-sparse index set of this vector. Useful to improve performance if subsequent operations will access these indices.
    
    Parameters:
    
    ixs -
  - includeIndices
```
public void includeIndices(AVector v)
```
    Include additional indices in the non-sparse index set of this vector. Useful to improve performance if subsequent operations will access these indices.
    
    Parameters:
    
    ixs -
  - includeIndices
```
public void includeIndices(ASparseIndexedVector v)
```
  - 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
  - exactClone
```
public SparseIndexedVector 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
  - 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
  - immutable
```
public AVector immutable()
```
    Description copied from class: AVector
    
    Creates an immutable copy of a vector
    
    Specified by:
    
    immutable in interface INDArray
    
    Overrides:
    
    immutable in class AVector

Class SparseIndexedVector

Field Summary

Fields inherited from class mikera.vectorz.impl.ASizedVector

Method Summary

Methods inherited from class mikera.vectorz.impl.ASparseIndexedVector

Methods inherited from class mikera.vectorz.impl.ASparseVector

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

Method Detail

wrap

wrap

create

createWithIndices

createLength

create

create

create

create

create

create

create

create

create

createFromRow

nonSparseElementCount

innerProduct

innerProduct

innerProduct

add

addMultiple

add

add

addMultiple

addMultiple

sub

sub

multiply

pow

square

multiply

multiply

multiply

multiplyCopy

multiply

maxAbsElement

maxElementIndex

maxAbsElementIndex

minElementIndex

negate

applyOp

applyOp

reduce

reduce

abs

get

unsafeGet

isFullyMutable

isMutable

setElements

setElements

set

set

set

unsafeSet

addAt

roundToZero

nonSparseValues

nonSparseIndex

toVector

toSparseIndexedVector

clone

includeIndices

includeIndices

includeIndices