mikera.vectorz.impl

Class SingleElementVector

java.lang.Object

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

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.ASparseVector

mikera.vectorz.impl.ASingleElementVector

mikera.vectorz.impl.SingleElementVector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<java.lang.Double>, INDArray, ISparse, ISparseVector, IVector

public final class SingleElementVector
extends ASingleElementVector

A sparse immutable vector that has a only one element that can be non-zero.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SingleElementVector(int componentIndex, int dimensions)
SingleElementVector(int componentIndex, int dimensions, double value)

Method Summary

Modifier and Type	Method and Description
void	add(ASparseVector v)
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
AVector	applyOpCopy(Op op) Applies a unary operator to all elements of the array (creating a new array)
static SingleElementVector	create(double val, int i, int len)
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	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.
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) Returns true if this array is exactly equal to a vector.
boolean	equalsArray(double[] data, int offset) Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
SingleElementVector	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
AVector	innerProduct(AMatrix a) Computes the inner product of this vector with a matrix
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
boolean	isRangeZero(int start, int length) Returns true if a sub-vector range is completely zero.
boolean	isZero() Returns true if this vector is a zero vector (all components zero)
double	magnitude() Returns the magnitude (Euclidean length) of the 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.
int[]	nonZeroIndices() Return an int array specifying the positions in this vector which are non-zero
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.
void	set(int i, double value) Sets a value at a given position in a mutable 1D array
AScalar	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
AVector	subVector(int offset, int length) Obtains a sub-vector view that refers to this vector.
AVector	tryEfficientJoin(AVector a) Attempts to perform an efficient join with a second vector.
double	unsafeGet(int i) Like get, but performs no bounds checking.
double	visitNonZero(IndexedElementVisitor elementVisitor) Visits all non-zero elements of this vector.

Methods inherited from class mikera.vectorz.impl.ASingleElementVector

getElements, isElementConstrained, isMutable, nonZeroCount

Methods inherited from class mikera.vectorz.impl.ASparseVector

add, addMultiple, clone, copyTo, copyTo, density, distanceL1, distanceLinf, distanceSquared, dotProduct, equals, getSlices, isSparse, isView, reduceSlices, roundToZero, sparse, toDoubleArray, toSparseIndexedVector

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

abs, absCopy, absDiff, absDiff, absDiff, absDiffCopy, add, add, add, add, add, add, add, add, addAt, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleSparse, addMultipleSparse, addMultipleToArray, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, addSparse, addSparse, addToArray, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, clamp, clampMax, clampMin, compareTo, compareTo, copy, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, divide, divide, divide, divide, divideCopy, divideCopy, divideCopy, divideTo, dotProduct, elementIterator, elementMaxAbs, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, fill, fillRange, get, get, get, get, get, getElement, getElements, getElements, getLongShape, getShape, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isSameShape, isUnitLengthVector, isUnitLengthVector, iterator, join, join, join, log, logistic, magnitudeSquared, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, multiplyTo, mutable, negate, negateCopy, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reciprocal, reciprocalCopy, 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, setApplyOp, setApplyOp, setApplyOp, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, setSparse, setSparse, setSparse, shiftCopy, signum, slice, sliceValue, softmax, softmaxCopy, sqrtCopy, square, squareCopy, sub, sub, subArray, subAt, subCopy, subCopy, subMultiple, tanh, toDoubleBuffer, toList, toNormal, toSliceArray, toString, toStringFull, toVector, unsafeSet, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

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

Methods inherited from class java.lang.Object

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

abs, absCopy, absDiff, absDiffCopy, add, add, addApplyOp, addAt, addCopy, addCopy, addInnerProduct, addInnerProduct, addMultiple, addMultipleSparse, addOuterProduct, addOuterProductSparse, addPower, addPower, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, clamp, componentCount, copy, dense, denseClone, dimensionality, divide, divide, divideCopy, divideCopy, elementCount, elementIterator, elementMaxAbs, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, exp, fill, get, get, get, get, get, get, get, get, getComponent, getComponents, getElement, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, 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, setApplyOp, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, setSparse, setSparse, signum, signumCopy, slice, sliceCount, sliceValue, sqrt, square, squareCopy, sub, sub, subArray, subCopy, toDoubleBuffer, toSliceArray, toVector, validate, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SingleElementVector

public SingleElementVector(int componentIndex,
                           int dimensions)

SingleElementVector

public SingleElementVector(int componentIndex,
                           int dimensions,
                           double value)

Method Detail

create

public static SingleElementVector create(double val,
                                         int i,
                                         int len)

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:

magnitude

public double magnitude()

Description copied from class: AVector

Returns the magnitude (Euclidean length) of the vector

Overrides:

magnitude in class AVector

Returns:

elementSum

public double elementSum()

Description copied from class: AVector

Returns the sum of all elements in a vector

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class 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

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

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

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)

Description copied from class: AVector

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

Overrides:

unsafeGet 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

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

applyOpCopy

public AVector applyOpCopy(Op op)

Description copied from interface: INDArray

Applies a unary operator to all elements of the array (creating a new array)

Specified by:

applyOpCopy in interface INDArray

Overrides:

applyOpCopy 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 AScalar 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 ASingleElementVector

subVector

public AVector subVector(int offset,
                         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

tryEfficientJoin

public AVector tryEfficientJoin(AVector a)

Description copied from class: AVector

Attempts to perform an efficient join with a second vector. An efficient join is guaranteed to be better than a simple JoinedVector(left,right) If possible, returns the joined vector. If not, returns null

Overrides:

tryEfficientJoin in class AVector

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 AVector innerProduct(AMatrix a)

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

exactClone

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

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)

Description copied from class: AbstractArray

Returns true if this array is exactly equal to a vector.

Specified by:

equals in class ASingleElementVector

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. May or may not be a view.

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 typically expected be non-zero.

Specified by:

nonSparseIndex in interface ISparseVector

Overrides:

nonSparseIndex in class ASingleElementVector

Returns:

visitNonZero

public double visitNonZero(IndexedElementVisitor elementVisitor)

Description copied from class: AVector

Visits all non-zero elements of this vector. Visitor may return a non-zero value to terminate early, which will return the given value. Returns 0.0 otherwise.

Overrides:

visitNonZero in class ASparseVector

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:

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:

add

public void add(ASparseVector v)

Specified by:

add in class ASparseVector

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:

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(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

Specified by:

dotProduct in class ASingleElementVector

Returns: