ImmutableVector (Vectorz 0.62.0 API)

java.lang.Object
- mikera.arrayz.impl.AbstractArray<Double>
- - mikera.vectorz.AVector
  - - mikera.vectorz.impl.ASizedVector
    - - mikera.vectorz.impl.AArrayVector
      - mikera.vectorz.impl.AStridedVector
        
        mikera.vectorz.impl.ImmutableVector

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, IDense, IStridedArray, INDArray, IVector
```
public class ImmutableVector
extends AStridedVector
implements IDense
```
Immutable array-backed vector. Keeps defensive array copy to ensure immutability.

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

int offset
- Fields inherited from class mikera.vectorz.impl.AArrayVector
  data
- Fields inherited from class mikera.vectorz.impl.ASizedVector
  length

Fields
Modifier and Type	Field and Description
`int`	`offset`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAt(int i, double v)` Adds a value to a specific element of the vector This function does not perform bounds checking, i.e.
`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)` Adds this vector to a double[] array, starting at the specified offset.
`void`	`addToArray(int offset, double[] array, int arrayOffset, int length)` Adds a subvector of this vector into a double array at the specified offset
`void`	`applyOp(Op op)` Applies a unary operator to all elements of the array (in-place)
`Vector`	`clone()` Clones the vector, creating a new mutable copy of all data.
`void`	`copyTo(int offset, double[] dest, int destOffset, int length)` Copies a subset of this vector to a specified destination array offset
`static ImmutableVector`	`create(AVector v)` Create an ImmutableVector with a copy of the elements in the source vector
`static ImmutableVector`	`create(double[] data)`
`void`	`divideTo(double[] data, int offset)` Divides the elements in the target array by corresponding elements in this vector
`double`	`dotProduct(AVector v)` Returns the dot product of this vector with another vector The vectors must have the same length: if not the result is undefined
`double`	`dotProduct(double[] data, int offset)` Fast dot product with a double[] array.
`double`	`dotProduct(double[] data, int offset, int stride)` Fast dot product with a double[] array and a stride.
`double`	`elementSquaredSum()` Returns the sum of squared elements in this array.
`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
`AVector`	`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
`int`	`getArrayOffset()` Gets the offset into the underlying double[] data array for the first element of this vector
`void`	`getElements(double[] data, int offset)` Gets all elements of the array, copying them into a double array at the specified offset
`int`	`getStride()` Gets the stride of this strided vector.
`int`	`hashCode()` Computes the hashcode of a vector.
`AVector`	`immutable()` Creates an immutable copy of a vector
`protected int`	`index(int i)` Computes an index into the underlying array for a given vector index
`boolean`	`isFullyMutable()` Returns true if this vector is fully mutable, i.e.
`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`	`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)
`Iterator<Double>`	`iterator()`
`void`	`multiplyTo(double[] data, int offset)` Multiplies the elements in the target array by corresponding elements in this vector
`static ImmutableVector`	`of(double... data)`
`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[] values, int offset)` Sets all elements in an array using the given double values
`void`	`setElements(int pos, double[] values, int offset, int length)` Sets elements in an array using the given double values.
`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.
`AVector`	`sparse()` Coerces this INDArray to a sparse format, without changing its element values.
`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.
`void`	`toDoubleBuffer(DoubleBuffer dest)` Copies the elements of this INDArray to the specified double buffer
`double`	`unsafeGet(int i)`
`void`	`unsafeSet(int i, double value)`
`void`	`validate()` Validates the internal data structure of the INDArray.
`static ImmutableVector`	`wrap(double[] data)` Wraps the given double array as an ImmutableVector.
`static ImmutableVector`	`wrap(double[] data, int offset, int length)`
`static ImmutableVector`	`wrap(Vector source)`

Methods inherited from class mikera.vectorz.impl.AStridedVector
add, addToArray, applyOpCopy, asDoubleArray, broadcast, broadcastLike, copyTo, elementMax, elementMin, elementProduct, elementSum, ensureMutable, getArray, getElements, getStride, getStrides, hasUncountable, isPackedArray, reduce, reduce, selectView

Methods inherited from class mikera.vectorz.impl.ASizedVector
checkIndex, checkLength, checkRange, checkSameLength, checkSameLength, elementCount, equalsArray, get, getShape, getShapeClone, isSameShape, length, sliceCount

Methods inherited from class mikera.vectorz.AVector
abs, absCopy, add, add, add, add, add, add, add, add, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleToArray, addPower, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, asElementList, asVector, broadcastLike, broadcastLike, checkDimension, checkSameLength, clamp, clampMax, clampMin, compareTo, copy, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideCopy, divideCopy, dotProduct, dotProduct, elementAbsPowSum, elementIterator, elementPowSum, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, fill, fillRange, get, get, get, get, getElements, getLongShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isSameShape, isUnitLengthVector, isUnitLengthVector, join, join, join, log, logistic, magnitude, magnitudeSquared, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonSparseIndex, nonZeroCount, nonZeroIndices, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateCopy, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleCopy, scaleToMagnitude, select, selectClone, set, set, set, set, set, set, set, set, set, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, shiftCopy, signum, slice, sliceValue, softmax, softmaxCopy, sparseClone, sqrtCopy, square, squareCopy, sub, sub, subArray, subAt, subCopy, subCopy, subMultiple, tanh, toList, toNormal, toSliceArray, toString, toStringFull, toVector, tryEfficientJoin

Methods inherited from class mikera.arrayz.impl.AbstractArray
add, addInnerProduct, addInnerProduct, addOuterProduct, broadcastCloneLike, broadcastCopyLike, checkMutable, componentCount, density, exp, get, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, isSparse, 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.arrayz.INDArray
abs, absCopy, add, add, addAt, addCopy, addCopy, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, applyOp, applyOp, applyOp, asElementList, asVector, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkMutable, clamp, componentCount, copy, dense, denseClone, dimensionality, divide, divide, divideCopy, elementAbsPowSum, elementCount, elementIterator, elementPowSum, elementsEqual, epsilonEquals, epsilonEquals, equals, equalsArray, exp, fill, get, get, get, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isSameShape, isSparse, join, join, log, multiply, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonZeroCount, outerProduct, pow, reciprocal, reciprocalCopy, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, setElements, setInnerProduct, setMultiple, setMultiple, signum, signumCopy, slice, sliceCount, sliceValue, sparseClone, sqrt, square, squareCopy, sub, sub, subArray, subCopy, toArray, toSliceArray, toVector, withComponents

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

- Field Detail
  - offset
```
public final int offset
```
- Method Detail
  - of
```
public static ImmutableVector of(double... data)
```
  - create
```
public static ImmutableVector create(double[] data)
```
  - create
```
public static ImmutableVector create(AVector v)
```
    Create an ImmutableVector with a copy of the elements in the source vector
    
    Parameters:
    
    v -
    
    Returns:
  - wrap
```
public static ImmutableVector wrap(double[] data)
```
    Wraps the given double array as an ImmutableVector. Caller should ensure that the data array is never subsequently modified
    
    Parameters:
    
    data -
    
    Returns:
  - wrap
```
public static ImmutableVector wrap(double[] data,
                                   int offset,
                                   int length)
```
  - wrap
```
public static ImmutableVector wrap(Vector source)
```
  - 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
  - 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
  - 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
  - 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
  - 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 AStridedVector
    
    Returns:
  - 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 AArrayVector
  - 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
  - toDoubleBuffer
```
public void toDoubleBuffer(DoubleBuffer dest)
```
    Description copied from interface: INDArray
    
    Copies the elements of this INDArray to the specified double buffer
    
    Specified by:
    
    toDoubleBuffer in interface INDArray
    
    Overrides:
    
    toDoubleBuffer in class AVector
  - 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
  - getElements
```
public void getElements(double[] data,
                        int offset)
```
    Description copied from interface: INDArray
    
    Gets all elements of the array, copying them into a double array at the specified offset
    
    Specified by:
    
    getElements in interface INDArray
    
    Overrides:
    
    getElements in class AStridedVector
  - copyTo
```
public void copyTo(int offset,
                   double[] dest,
                   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
  - multiplyTo
```
public void multiplyTo(double[] data,
                       int offset)
```
    Description copied from class: AVector
    
    Multiplies the elements in the target array by corresponding elements in this vector
    
    Overrides:
    
    multiplyTo in class AVector
    
    offset - The offset into the target array
  - addToArray
```
public void addToArray(double[] array,
                       int offset)
```
    Description copied from class: AVector
    
    Adds this vector to a double[] array, starting at the specified offset.
    
    Specified by:
    
    addToArray in interface INDArray
    
    Overrides:
    
    addToArray in class AVector
  - addToArray
```
public void addToArray(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 AStridedVector
  - 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 AStridedVector
  - divideTo
```
public void divideTo(double[] data,
                     int offset)
```
    Description copied from class: AVector
    
    Divides the elements in the target array by corresponding elements in this vector
    
    Overrides:
    
    divideTo in class AVector
    
    offset - The offset into the target array
  - 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 AStridedVector
  - 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(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 AStridedVector
    
    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 AStridedVector
  - 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
  - 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
  - unsafeGet
```
public double unsafeGet(int i)
```
    Overrides:
    
    unsafeGet in class AVector
  - unsafeSet
```
public void unsafeSet(int i,
                      double value)
```
    Overrides:
    
    unsafeSet in class AVector
  - addAt
```
public void addAt(int i,
                  double v)
```
    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
    
    Specified by:
    
    addAt in class AStridedVector
  - iterator
```
public Iterator<Double> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Double>
    
    Overrides:
    
    iterator in class AStridedVector
  - hashCode
```
public int hashCode()
```
    Description copied from class: AVector
    
    Computes the hashcode of a vector. Currently defined to be equal to List.hashCode for a equivalent list of Double values, this may change in future versions.
    
    Overrides:
    
    hashCode in class AVector
  - equals
```
public boolean equals(AVector v)
```
    Overrides:
    
    equals 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 AStridedVector
    
    Parameters:
    
    data - Array of double element values to check for equality
    
    offset - Offset into the data array
    
    Returns:
  - clone
```
public Vector 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 AStridedVector
  - sparse
```
public AVector 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
  - exactClone
```
public AVector 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
  - 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
  - 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 AStridedVector
  - index
```
protected int index(int i)
```
    Description copied from class: AArrayVector
    
    Computes an index into the underlying array for a given vector index
    
    Specified by:
    
    index in class AArrayVector
  - getArrayOffset
```
public int getArrayOffset()
```
    Description copied from class: AStridedVector
    
    Gets the offset into the underlying double[] data array for the first element of this vector
    
    Specified by:
    
    getArrayOffset in interface IStridedArray
    
    Specified by:
    
    getArrayOffset in class AStridedVector
    
    Returns:
  - getStride
```
public int getStride()
```
    Description copied from class: AStridedVector
    
    Gets the stride of this strided vector.
    
    Specified by:
    
    getStride in class AStridedVector
    
    Returns:
  - set
```
public void set(AVector v)
```
    Description copied from class: AVector
    
    Sets the vector to equal the value of another vector
    
    Specified by:
    
    set in class AStridedVector
  - setElements
```
public void setElements(double[] values,
                        int offset)
```
    Description copied from interface: INDArray
    
    Sets all elements in an array using the given double values
    
    Specified by:
    
    setElements in interface INDArray
    
    Specified by:
    
    setElements in class AStridedVector
    
    Parameters:
    
    values - 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[] values,
                        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
    
    Specified by:
    
    setElements in class AStridedVector
    
    Parameters:
    
    pos - Offset into this array, expressed in terms of number of elements in row major order
    
    values - 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.
  - 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
    
    Specified by:
    
    applyOp in class AStridedVector

Class ImmutableVector

Field Summary

Fields inherited from class mikera.vectorz.impl.AArrayVector

Fields inherited from class mikera.vectorz.impl.ASizedVector

Method Summary

Methods inherited from class mikera.vectorz.impl.AStridedVector

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.arrayz.INDArray

Methods inherited from interface java.lang.Iterable

Field Detail

offset

Method Detail

of

create

create

wrap

wrap

wrap

isMutable

isFullyMutable

isView

isZero

isRangeZero

slice

subVector

toDoubleBuffer

toDoubleArray

getElements

copyTo

multiplyTo

addToArray

addToArray

addMultipleToArray

divideTo

dotProduct

dotProduct

dotProduct

elementSquaredSum

get

set

unsafeGet

unsafeSet

addAt

iterator

hashCode

equals

equalsArray

clone

sparse

exactClone

immutable

validate

index

getArrayOffset

getStride

set

setElements

setElements

applyOp