mikera.vectorz.impl

Class ZeroVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.ASparseVector

mikera.vectorz.impl.ZeroVector

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, INDArray, ISparse, IVector

public final class ZeroVector
extends ASparseVector

Specialised immutable vector containing nothing but zeros. Must have length 1 or more: use Vector0 instead for length 0 vectors.

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields inherited from class mikera.vectorz.impl.ASizedVector

length

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ASparseVector v)
void	addToArray(int offset, double[] array, int arrayOffset, int length)
static ZeroVector	create(int dimensions)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
double	dotProduct(AVector v)
double	dotProduct(double[] data, int offset) Fast dot product with a double[] array.
double	elementMax() Returns the maximum element value in this array.
double	elementMin() Returns the maximum element value in this array.
double	elementSum() Returns the sum of all elements in a vector
ZeroVector	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	hashCode() Computes the hashcode of a vector.
boolean	includesIndex(int i) Returns true iff the sparse vector contains the index i
AVector	innerProduct(AMatrix m)
boolean	isBoolean() Returns true if the array is boolean (contains only 0.0 or 1.0 values)
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
boolean	isMutable() Returns true if this vector is mutable.
boolean	isUnitLengthVector() Returns true if the vector has unit length
boolean	isZero() Returns true if this vector is a zero vector (all components zero)
Iterator<Double>	iterator()
AVector	join(AVector a) Returns a new vector that refers to this vector joined to a second vector
ZeroVector	join(ZeroVector a)
double	magnitude() Returns the magnitude (Euclidean length) of the vector
double	magnitudeSquared()
double	maxAbsElement() Returns the maximum absolute element 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
int	nonSparseElementCount() Returns the number of non-sparse elements in the sparse vector.
Index	nonSparseIndexes() Returns the non-sparse indexes
AVector	nonSparseValues() Returns the non-sparse values as a compacted vector view
long	nonZeroCount() Returns the number of non-zero elements in the array.
void	set(int i, double value) Set a specified element in a vector
ImmutableScalar	slice(int i) Returns the specified major slice of this array as a view (slice along dimension 0)
AVector	subVector(int offset, int length) Obtains a sub-vector that refers to this vector.
double	unsafeGet(int i)
void	unsafeSet(int i, double value)

Methods inherited from class mikera.vectorz.impl.ASparseVector

equals, equals

Methods inherited from class mikera.vectorz.impl.ASizedVector

elementCount, getShape, getShape, getShapeClone, length, sliceCount

Methods inherited from class mikera.vectorz.AVector

abs, add, add, add, add, add, add, addAt, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleToArray, addProduct, addProduct, addProduct, addProductToArray, addProductToArray, addToArray, addWeighted, angle, applyOp, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, clamp, clampMax, clampMin, clone, compareTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideTo, dotProduct, dotProduct, elementIterator, elementSquaredSum, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equalsArray, equalsArray, fill, fillRange, get, get, get, get, getElements, getLongShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, immutable, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isSameShape, isSameShape, isView, join, log, logistic, maxElement, minElement, multiply, multiply, multiply, multiply, multiplyTo, mutable, negate, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reshape, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, set, set, set, setElements, setElements, setRange, setValues, signum, slice, sparse, sparseClone, square, sub, sub, sub, subArray, subMultiple, tanh, toDoubleArray, toDoubleBuffer, toList, toNormal, toString, toVector, unsafeGetInteger, unsafeSetInteger, validate, zeroCount

Methods inherited from class mikera.arrayz.impl.AbstractArray

broadcastCloneLike, ensureMutable, exp, getSlices, getSliceViews, reciprocal, scale, set, set, sqrt, toArray

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray

broadcastCloneLike, ensureMutable, exp, getSlices, getSliceViews, reciprocal, scale, set, set, sqrt, toArray

Method Detail

create

public static ZeroVector create(int dimensions)

dotProduct

public double dotProduct(AVector v)

Overrides:

dotProduct in class ASparseVector

dotProduct

public double dotProduct(double[] data,
                int offset)

Description copied from class: AVector

Fast dot product with a double[] array. Performs no bounds checking.

Overrides:

dotProduct in class AVector

Returns:

innerProduct

public AVector innerProduct(AMatrix m)

Overrides:

innerProduct 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

Returns:

set

public void set(int i,
       double value)

Description copied from interface: IVector

Set a specified element in a vector

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

add

public void add(ASparseVector v)

Specified by:

add in class ASparseVector

magnitudeSquared

public double magnitudeSquared()

Overrides:

magnitudeSquared in class AVector

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 AVector

Returns:

elementMax

public double elementMax()

Description copied from interface: INDArray

Returns the maximum element value in this array.

Specified by:

elementMax in interface INDArray

Overrides:

elementMax in class AVector

Returns:

elementMin

public double elementMin()

Description copied from interface: INDArray

Returns the maximum element value in this array.

Specified by:

elementMin in interface INDArray

Overrides:

elementMin in class AVector

Returns:

maxElementIndex

public int maxElementIndex()

Description copied from class: AVector

Returns the index of the maximum element of a vector

Overrides:

maxElementIndex in class AVector

Returns:

maxAbsElement

public double maxAbsElement()

Description copied from class: AVector

Returns the maximum absolute element 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

Returns:

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 AVector

Returns:

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

Returns:

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>

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

Returns:

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

Returns:

isUnitLengthVector

public boolean isUnitLengthVector()

Description copied from class: AVector

Returns true if the vector has unit length

Overrides:

isUnitLengthVector in class AVector

Returns:

addToArray

public void addToArray(int offset,
              double[] array,
              int arrayOffset,
              int length)

Overrides:

addToArray 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)

Specified by:

slice in interface INDArray

Overrides:

slice in class AVector

Returns:

iterator

public Iterator<Double> iterator()

Specified by:

iterator in interface Iterable<Double>

Overrides:

iterator in class AVector

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

exactClone

public ZeroVector 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:

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 ASparseVector

Returns:

subVector

public AVector subVector(int offset,
                int length)

Description copied from class: AVector

Obtains a sub-vector that refers to this vector. Changes to the sub-vector will be reflected in this vector

Overrides:

subVector in class AVector

join

public AVector join(AVector a)

Description copied from class: AVector

Returns a new vector that refers to this vector joined to a second vector

Overrides:

join in class AVector

Returns:

join

public ZeroVector join(ZeroVector a)

nonSparseElementCount

public int nonSparseElementCount()

Description copied from class: ASparseVector

Returns the number of non-sparse elements in the sparse vector.

Specified by:

nonSparseElementCount in class ASparseVector

Returns:

nonSparseValues

public AVector nonSparseValues()

Description copied from class: ASparseVector

Returns the non-sparse values as a compacted vector view

Specified by:

nonSparseValues in class ASparseVector

Returns:

nonSparseIndexes

public Index nonSparseIndexes()

Description copied from class: ASparseVector

Returns the non-sparse indexes

Specified by:

nonSparseIndexes in class ASparseVector

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: