AxisVector (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.ASingleElementVector
        
        mikera.vectorz.impl.AxisVector

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, INDArray, ISparse, ISparseVector, IVector
```
public final class AxisVector
extends ASingleElementVector
```
Specialised immutable unit axis vector. Has a 1.0 in exactly one element, 0.0 everywhere else.

Author:

Mike

See Also:

Serialized Form

Field Summary
- Fields inherited from class mikera.vectorz.impl.ASingleElementVector
  index
- 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)
`AxisVector`	`absCopy()` Returns a copy of the array with the abs operator applied to each element
`void`	`add(ASparseVector v)`
`AVector`	`addCopy(AVector v)` Adds a vector element-wise to this vector, returning a new vector.
`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`	`addToArray(double[] array, 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
`int`	`axis()`
`static AxisVector`	`create(int axisIndex, int dimensions)`
`double`	`density()` Computes the density ratio of this sparse array (proportion of non-zero elements)
`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`	`dotProduct(Vector2 v)`
`double`	`dotProduct(Vector3 v)`
`double`	`elementAbsPowSum(double p)` Returns the sum of the absolute values of all the elements raised to a specified power
`double`	`elementMax()` Returns the maximum element value in this array.
`double`	`elementMin()` Returns the maximum element value in this array.
`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.
`boolean`	`elementsEqual(double value)` Returns true if all elements are equal to a specific value
`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[] data, int offset)` Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
`AxisVector`	`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`	`hasUncountable()` Returns true if any element is this array is NaN or infinite
`boolean`	`includesIndex(int i)` Returns true iff the sparse vector contains the index i
`Scalar`	`innerProduct(ADenseArrayVector v)` Overloaded inner product for dense array vector argument
`AVector`	`innerProduct(AMatrix m)` Computes the inner product of this vector with a matrix
`boolean`	`isBoolean()` Returns true if the array is boolean (contains only 0.0 or 1.0 values)
`boolean`	`isMutable()` Returns true if this vector is mutable.
`boolean`	`isRangeZero(int start, int length)` Returns true if a sub-vector range is completely zero.
`boolean`	`isUnitLengthVector()` Returns true if the vector has unit length
`boolean`	`isZero()` Returns true if this vector is a zero vector (all components zero)
`double`	`magnitude()` Returns the magnitude (Euclidean length) of the vector
`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
`AVector`	`multiplyCopy(double d)` Returns a copy of the array with all elements multiplied by a single constant value
`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
`double[]`	`nonZeroValues()` Return an double array specifying the values in this vector which are non-zero
`double`	`normalise()` Normalises this vector to a magnitude of 1.0 Has no effect on a zero-length vector (i.e.
`AVector`	`normaliseCopy()` Returns a copy of this vector normalised to a Euclidean length of 1.0 Has no effect on a zero-length vector (i.e.
`void`	`set(int i, double value)` Sets a value at a given position in a mutable 1D array
`void`	`signum()` Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)
`AxisVector`	`signumCopy()` Returns a copy of the array with the signum operator applied to each element
`ImmutableScalar`	`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.
`SparseIndexedVector`	`sparseClone()` Clones the vector into a sparse mutable format
`void`	`sqrt()` Computes the square root of all elements in the array
`AxisVector`	`sqrtCopy()` Computes the square root for each element in this vector, returning a new vector.
`void`	`square()` Squares all elements of the array in place
`AVector`	`squareCopy()` Squares all elements of the array, returning a new array
`AVector`	`subCopy(AVector v)` Subtracts a vector element-wise from this vector, returning a new vector.
`AVector`	`subVector(int start, int length)` Obtains a sub-vector view that refers to this vector.
`double[]`	`toDoubleArray()` Copies the elements of this array to a new double[] array.
`Vector`	`toNormal()` Creates a new mutable vector representing the normalised value of this vector Returns null if the vector cannot be normalised (i.e.
`Vector`	`toVector()` Coerces this vector to the standard dense Vector format.
`double`	`unsafeGet(int i)`
`void`	`validate()` Validates the internal data structure of the INDArray.
`protected double`	`value()`

Methods inherited from class mikera.vectorz.impl.ASingleElementVector
index

Methods inherited from class mikera.vectorz.impl.ASparseVector
add, addMultiple, clone, copyTo, copyTo, distanceL1, distanceLinf, distanceSquared, dotProduct, equals, getSlices, isSparse, isView, reduce, reduce, reduceSlices, roundToZero, sparse, 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
add, add, add, add, add, add, add, add, addAt, addAt, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleToArray, addPower, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, 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, elementIterator, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, fill, fillRange, get, get, get, get, getElements, getElements, getElements, getLongShape, getShape, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isFullyMutable, isSameShape, isUnitLengthVector, iterator, join, join, join, log, logistic, magnitudeSquared, maxElement, minElement, multiply, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, multiplyTo, mutable, negate, negateCopy, 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, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, shiftCopy, slice, sliceValue, softmax, softmaxCopy, sub, sub, subArray, subAt, subCopy, subMultiple, tanh, toDoubleBuffer, toList, toSliceArray, toString, toStringFull, tryEfficientJoin, unsafeSet

Methods inherited from class mikera.arrayz.impl.AbstractArray
add, addInnerProduct, addInnerProduct, addOuterProduct, broadcastCloneLike, broadcastCopyLike, checkMutable, componentCount, ensureMutable, exp, get, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isDense, reciprocal, reciprocalCopy, scale, set, set, 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
divideCopy, epsilonEquals, isSameShape, length, multiplyCopy, rotateCopy, rotateView, shiftCopy

Methods inherited from interface mikera.arrayz.INDArray
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, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, 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, isDense, isElementConstrained, isFullyMutable, isSameShape, join, join, log, multiply, multiply, 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, slice, sliceCount, sliceValue, sub, sub, subArray, subCopy, toArray, toDoubleBuffer, toSliceArray, withComponents

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

- Method Detail
  - create
```
public static AxisVector create(int axisIndex,
                                int dimensions)
```
  - axis
```
public int axis()
```
  - magnitude
```
public double magnitude()
```
    Description copied from class: AVector
    
    Returns the magnitude (Euclidean length) of the vector
    
    Overrides:
    
    magnitude in class AVector
    
    Returns:
  - 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
  - normalise
```
public double normalise()
```
    Description copied from class: AVector
    
    Normalises this vector to a magnitude of 1.0 Has no effect on a zero-length vector (i.e. it will remain zero)
    
    Specified by:
    
    normalise in interface IVector
    
    Overrides:
    
    normalise in class AVector
    
    Returns:
    
    the magnitude of the original vector
  - normaliseCopy
```
public AVector normaliseCopy()
```
    Description copied from class: AVector
    
    Returns a copy of this vector normalised to a Euclidean length of 1.0 Has no effect on a zero-length vector (i.e. it will return a zero length vector)
    
    Specified by:
    
    normaliseCopy in interface IVector
    
    Overrides:
    
    normaliseCopy in class AVector
    
    Returns:
  - 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
  - squareCopy
```
public AVector squareCopy()
```
    Description copied from interface: INDArray
    
    Squares all elements of the array, returning a new array
    
    Specified by:
    
    squareCopy in interface INDArray
    
    Overrides:
    
    squareCopy in class AVector
  - 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
  - absCopy
```
public AxisVector absCopy()
```
    Description copied from interface: INDArray
    
    Returns a copy of the array with the abs operator applied to each element
    
    Specified by:
    
    absCopy in interface INDArray
    
    Overrides:
    
    absCopy in class AVector
    
    Returns:
    
    A new array containing the absolute element values
  - sqrt
```
public void sqrt()
```
    Description copied from interface: INDArray
    
    Computes the square root of all elements in the array
    
    Specified by:
    
    sqrt in interface INDArray
    
    Overrides:
    
    sqrt in class AbstractArray<Double>
  - sqrtCopy
```
public AxisVector sqrtCopy()
```
    Description copied from interface: IVector
    
    Computes the square root for each element in this vector, returning a new vector.
    
    Specified by:
    
    sqrtCopy in interface IVector
    
    Overrides:
    
    sqrtCopy in class AVector
    
    Returns:
  - signum
```
public void signum()
```
    Description copied from interface: INDArray
    
    Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)
    
    Specified by:
    
    signum in interface INDArray
    
    Overrides:
    
    signum in class AVector
  - signumCopy
```
public AxisVector signumCopy()
```
    Description copied from interface: INDArray
    
    Returns a copy of the array with the signum operator applied to each element
    
    Specified by:
    
    signumCopy in interface INDArray
    
    Overrides:
    
    signumCopy in class AbstractArray<Double>
    
    Returns:
    
    A new array containing the signums of element values
  - 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
  - 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 ASparseVector
    
    Returns:
  - elementMax
```
public double elementMax()
```
    Description copied from interface: INDArray
    
    Returns the maximum element value in this array. Throws an error if there are no elements.
    
    Specified by:
    
    elementMax in interface INDArray
    
    Overrides:
    
    elementMax in class AVector
  - elementMin
```
public double elementMin()
```
    Description copied from interface: INDArray
    
    Returns the maximum element value in this array. Throws an error if there are no elements.
    
    Specified by:
    
    elementMin in interface INDArray
    
    Overrides:
    
    elementMin in class AVector
  - 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:
  - maxAbsElement
```
public double maxAbsElement()
```
    Description copied from class: AVector
    
    Returns the maximum absolute element value of a vector
    
    Overrides:
    
    maxAbsElement 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
  - 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
  - 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:
  - 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
  - isBoolean
```
public boolean isBoolean()
```
    Description copied from interface: INDArray
    
    Returns true if the array is boolean (contains only 0.0 or 1.0 values)
    
    Specified by:
    
    isBoolean in interface INDArray
    
    Overrides:
    
    isBoolean in class AbstractArray<Double>
  - isUnitLengthVector
```
public boolean isUnitLengthVector()
```
    Description copied from class: AVector
    
    Returns true if the vector has unit length
    
    Overrides:
    
    isUnitLengthVector 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 ASingleElementVector
    
    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
    
    Overrides:
    
    dotProduct in class ASingleElementVector
  - 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
  - dotProduct
```
public double dotProduct(Vector3 v)
```
  - dotProduct
```
public double dotProduct(Vector2 v)
```
  - multiplyCopy
```
public AVector multiplyCopy(double d)
```
    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:
    
    d - A scalar factor
    
    Returns:
    
    A new array, with all element values scaled by the given factor
  - innerProduct
```
public Scalar innerProduct(ADenseArrayVector v)
```
    Description copied from class: AVector
    
    Overloaded inner product for dense array vector argument
    
    Overrides:
    
    innerProduct 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 ASparseVector
    
    Returns:
    
    a vector representing the inner product
  - 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
  - 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[] array,
                       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
  - slice
```
public final ImmutableScalar 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
  - toNormal
```
public Vector toNormal()
```
    Description copied from class: AVector
    
    Creates a new mutable vector representing the normalised value of this vector Returns null if the vector cannot be normalised (i.e. is a zero length vector)
    
    Overrides:
    
    toNormal in class AVector
    
    Returns:
  - 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 ASparseVector
  - 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
  - subVector
```
public AVector subVector(int start,
                         int length)
```
    Description copied from class: AVector
    
    Obtains a sub-vector view that refers to this vector. Changes to the sub-vector will be reflected in this vector
    
    Overrides:
    
    subVector in class AVector
  - density
```
public double density()
```
    Description copied from interface: ISparse
    
    Computes the density ratio of this sparse array (proportion of non-zero elements)
    
    Specified by:
    
    density in interface ISparse
    
    Overrides:
    
    density in class AbstractArray<Double>
    
    Returns:
  - 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
    
    Overrides:
    
    nonSparseElementCount in class ASingleElementVector
    
    Returns:
  - nonSparseValues
```
public AVector nonSparseValues()
```
    Description copied from interface: ISparseVector
    
    Returns the non-sparse elements as a compacted vector
    
    Specified by:
    
    nonSparseValues in interface ISparseVector
    
    Overrides:
    
    nonSparseValues in class ASingleElementVector
    
    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
    
    Overrides:
    
    nonSparseIndex in class ASingleElementVector
    
    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 ASingleElementVector
    
    Returns:
  - nonZeroValues
```
public double[] nonZeroValues()
```
    Description copied from class: AVector
    
    Return an double array specifying the values in this vector which are non-zero
    
    Overrides:
    
    nonZeroValues in class AVector
    
    Returns:
  - add
```
public void add(ASparseVector v)
```
    Specified by:
    
    add in class ASparseVector
  - addCopy
```
public AVector addCopy(AVector v)
```
    Description copied from interface: IVector
    
    Adds a vector element-wise to this vector, returning a new vector.
    
    Specified by:
    
    addCopy in interface IVector
    
    Overrides:
    
    addCopy in class AVector
    
    Returns:
  - subCopy
```
public AVector subCopy(AVector v)
```
    Description copied from interface: IVector
    
    Subtracts a vector element-wise from this vector, returning a new vector.
    
    Specified by:
    
    subCopy in interface IVector
    
    Overrides:
    
    subCopy in class AVector
    
    Returns:
  - 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:
  - 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
  - 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 ASizedVector
    
    Parameters:
    
    data - 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 ASingleElementVector
  - elementsEqual
```
public boolean elementsEqual(double value)
```
    Description copied from interface: INDArray
    
    Returns true if all elements are equal to a specific value
    
    Specified by:
    
    elementsEqual in interface INDArray
    
    Overrides:
    
    elementsEqual in class AVector
  - exactClone
```
public AxisVector 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
  - 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
  - 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 ASparseVector
    
    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 ASparseVector
    
    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 ASparseVector
    
    Returns:
  - value
```
protected double value()
```
    Specified by:
    
    value in class ASingleElementVector

Class AxisVector

Field Summary

Fields inherited from class mikera.vectorz.impl.ASingleElementVector

Fields inherited from class mikera.vectorz.impl.ASizedVector

Method Summary

Methods inherited from class mikera.vectorz.impl.ASingleElementVector

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 java.lang.Iterable

Method Detail

create

axis

magnitude

elementSquaredSum

normalise

normaliseCopy

square

squareCopy

abs

absCopy

sqrt

sqrtCopy

signum

signumCopy

elementSum

elementProduct

elementMax

elementMin

maxElementIndex

maxAbsElement

maxAbsElementIndex

minElementIndex

nonZeroCount

isZero

isRangeZero

isMutable

isBoolean

isUnitLengthVector

dotProduct

dotProduct

dotProduct

dotProduct

dotProduct

multiplyCopy

innerProduct

innerProduct

get

unsafeGet

addToArray

addToArray

addMultipleToArray

slice

toNormal

toDoubleArray

toVector

subVector

density

nonSparseElementCount

nonSparseValues

nonSparseIndex

nonZeroIndices

nonZeroValues

add

addCopy

subCopy

includesIndex

set

equalsArray

equals

elementsEqual

exactClone

sparseClone

validate

hasUncountable

elementPowSum