mikera.vectorz.impl

Class ArraySubVector

java.lang.Object

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

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.AArrayVector

mikera.vectorz.impl.AStridedVector

mikera.vectorz.impl.ADenseArrayVector

mikera.vectorz.impl.ArraySubVector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<java.lang.Double>, IDense, IDenseArray, IStridedArray, INDArray, IVector

public final class ArraySubVector
extends ADenseArrayVector

Vector referring to a fixed offset into a double[] array

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ArraySubVector(ADenseArrayVector source, int offset, int length) Constructs a vector directly referencing a sub-vector of an existing array-based Vector

Method Summary

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(AVector v) Adds another vector to this one
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	addMultiple(AVector v, double factor) Adds a scaled multiple of another vector to this vector
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
ArraySubVector	exactClone() Returns an exact clone of this vector, i.e.
void	fill(double value) Fills the entire vector with a given value
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
int	hashCode() Vector hashcode, designed to match hashcode of Java double array
boolean	isView() Returns true if this vector is of a view type that references other vectors / data.
void	set(int i, double value) Sets a value at a given position in a mutable 1D array
void	setElements(double[] src, int srcOffset) Sets all elements in an array using the given double values
AVector	subVector(int start, int length) Obtains a sub-vector view that refers to this vector.
double	unsafeGet(int i) Like get, but performs no bounds checking.
void	unsafeSet(int i, double value) Like set, but performs no bounds checking.
static ArraySubVector	wrap(double[] values) Wraps a double array as a dense ArraySubVector
static ArraySubVector	wrap(double[] data, int offset, int length) Wraps a segment of a double array as a dense ArraySubVector

Methods inherited from class mikera.vectorz.impl.ADenseArrayVector

add, add, add, add, add, add, add, addMultiple, addMultiple, addMultipleToArray, addMultipleToArray, addProduct, addProduct, addProduct, addProductToArray, addProductToArray, addToArray, addToArray, applyOp, clamp, copyTo, copyTo, copyTo, copyTo, dense, divide, divide, divideTo, dotProduct, dotProduct, dotProduct, elementAbsPowSum, elementMax, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, equals, equals, equalsArray, exp, fillRange, getElements, getStride, isPackedArray, isRangeZero, isZero, join, join, join, log, magnitude, maxAbsElement, maxAbsElementIndex, maxElementIndex, minElementIndex, multiply, multiply, multiply, multiplyTo, nonZeroCount, nonZeroIndices, pow, reciprocal, reduce, reduce, scaleAdd, scaleAdd, selectView, set, set, setElements, signum, slice, sqrt, square, squareCopy, toDoubleArray, toDoubleBuffer, tryEfficientJoin, validate, visitNonZero

Methods inherited from class mikera.vectorz.impl.AStridedVector

applyOpCopy, asDoubleArray, broadcast, broadcastLike, clone, ensureMutable, getArray, getElements, getStride, getStrides, hasUncountable, iterator

Methods inherited from class mikera.vectorz.impl.ASizedVector

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

Methods inherited from class mikera.vectorz.AVector

absCopy, absDiff, absDiff, absDiff, absDiffCopy, add, add, add, add, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleSparse, addMultipleSparse, addPower, addPower, addProductCopy, addProductCopy, addSparse, addSparse, addToArray, addWeighted, angle, applyOp, applyOp, applyOp, asElementList, asVector, broadcastLike, broadcastLike, clampMax, clampMin, compareTo, compareTo, copy, copyTo, copyTo, crossProduct, crossProduct, denseClone, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divideCopy, divideCopy, divideCopy, dotProduct, dotProduct, elementIterator, elementMaxAbs, epsilonEquals, epsilonEquals, epsilonEquals, equals, get, get, get, get, get, getElement, getElements, getLongShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isFullyMutable, isMutable, isSameShape, isUnitLengthVector, isUnitLengthVector, join, join, logistic, magnitudeSquared, maxElement, minElement, multiply, multiply, multiplyCopy, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonSparseIndex, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, projectToPlane, reciprocalCopy, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateCopy, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, scaleToMagnitude, select, selectClone, set, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setApplyOp, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, setSparse, setSparse, setSparse, shiftCopy, slice, sliceValue, softmax, softmaxCopy, sparse, sparseClone, sqrtCopy, sub, sub, subArray, subAt, subCopy, subCopy, subMultiple, tanh, toList, toNormal, toSliceArray, toString, toStringFull, toVector

Methods inherited from class mikera.arrayz.impl.AbstractArray

add, addApplyOp, addCopy, addInnerProduct, addInnerProduct, addOuterProduct, addOuterProductSparse, addSparse, broadcastCloneLike, broadcastCopyLike, componentCount, density, epsilonEquals, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, isSparse, scale, set, set, signumCopy, sub, sub, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.impl.IDenseArray

getArray

Methods inherited from interface mikera.arrayz.INDArray

absCopy, absDiff, absDiffCopy, add, addApplyOp, addAt, addCopy, addCopy, addInnerProduct, addInnerProduct, addMultiple, addMultipleSparse, addOuterProduct, addOuterProductSparse, addPower, addPower, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, asElementList, asVector, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, componentCount, copy, denseClone, dimensionality, divide, divide, divideCopy, divideCopy, elementCount, elementIterator, elementMaxAbs, epsilonEquals, epsilonEquals, equalsArray, get, get, get, get, get, get, get, get, getComponent, getComponents, getElement, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isFullyMutable, isMutable, isSameShape, isSparse, join, join, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, outerProduct, reciprocalCopy, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleCopy, set, set, set, set, set, set, setApplyOp, setElements, setInnerProduct, setMultiple, setMultiple, setSparse, setSparse, signumCopy, slice, sliceCount, sliceValue, sparse, sparseClone, sub, sub, subArray, subCopy, toSliceArray, toVector, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ArraySubVector

public ArraySubVector(ADenseArrayVector source,
                      int offset,
                      int length)

Constructs a vector directly referencing a sub-vector of an existing array-based Vector

Parameters:

source -

offset -

length -

Method Detail

wrap

public static ArraySubVector wrap(double[] values)

Wraps a double array as a dense ArraySubVector

wrap

public static ArraySubVector wrap(double[] data,
                                  int offset,
                                  int length)

Wraps a segment of a double array as a dense ArraySubVector

Parameters:

data -

offset -

length -

Returns:

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 ADenseArrayVector

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 ADenseArrayVector

fill

public void fill(double value)

Description copied from class: AVector

Fills the entire vector with a given value

Specified by:

fill in interface INDArray

Overrides:

fill in class ADenseArrayVector

unsafeGet

public double unsafeGet(int i)

Description copied from class: AVector

Like get, but performs no bounds checking. Results are undefined if the index is out of range

Specified by:

unsafeGet in class ADenseArrayVector

unsafeSet

public void unsafeSet(int i,
                      double value)

Description copied from class: AVector

Like set, but performs no bounds checking. Results are undefined if the index is out of range

Specified by:

unsafeSet in class ADenseArrayVector

add

public void add(AVector v)

Description copied from class: AVector

Adds another vector to this one

Overrides:

add in class ADenseArrayVector

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 ADenseArrayVector

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

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

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

hashCode

public int hashCode()

Vector hashcode, designed to match hashcode of Java double array

Overrides:

hashCode in class AVector

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 IDenseArray

Specified by:

getArrayOffset in interface IStridedArray

Specified by:

getArrayOffset in class AStridedVector

Returns:

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 ADenseArrayVector

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 ADenseArrayVector

setElements

public void setElements(double[] src,
                        int srcOffset)

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:

src - Element values in a double[] array. There must be at least as many element values as elements in this array.

srcOffset - Position in the values array from which to start taking values.

exactClone

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