mikera.vectorz.impl

Class ZeroVector

java.lang.Object

mikera.arrayz.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ZeroVector

All Implemented Interfaces:

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

public final class ZeroVector
extends AVector
implements ISparse

Specialised vector containing nothing but zeros.

Author:

Mike

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ZeroVector(int dimensions)

Method Summary

Methods

Modifier and Type	Method and Description
static ZeroVector	create(int dimensions)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
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()
boolean	isMutable() Returns true if this vector is mutable.
boolean	isUnitLengthVector() Returns true if the vector has unit length
boolean	isZeroVector() Returns true if this vector is a zero vector (all components zero)
int	length()
double	magnitude() Returns the magnitude (Euclidean length) of the vector
double	magnitudeSquared()
long	nonZeroCount() Returns the number of non-zero elements in the array.
void	set(int i, double value)

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, addToArray, addWeighted, angle, applyOp, applyOp, asElementList, asVector, broadcast, clamp, clampMax, clampMin, clone, compareTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, countZeros, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divideTo, dotProduct, dotProduct, elementCount, elementSquaredSum, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fill, fillRange, get, getElements, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeView, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isFullyMutable, isView, iterator, join, log, maxAbsElement, multiply, multiply, multiply, multiply, multiplyTo, negate, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reshape, scale, scaleAdd, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, set, set, set, setElements, setElements, setValues, signum, slice, slice, sliceCount, square, sub, sub, sub, subMultiple, subVector, toArray, toDoubleBuffer, toList, toString, toVector, validate

Methods inherited from class mikera.arrayz.AbstractArray

epsilonEquals, epsilonEquals, exp, get, get, getSliceViews, reciprocal, scale, set, set, sqrt

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

epsilonEquals, epsilonEquals, exp, get, get, getSliceViews, reciprocal, scale, set, set, sqrt

Constructor Detail

ZeroVector

public ZeroVector(int dimensions)

Method Detail

create

public static ZeroVector create(int dimensions)

length

public int length()

Specified by:

length in interface IVector

Specified by:

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

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Specified by:

set in class AVector

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:

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:

isZeroVector

public boolean isZeroVector()

Description copied from class: AVector

Returns true if this vector is a zero vector (all components zero)

Overrides:

isZeroVector 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

Returns:

isUnitLengthVector

public boolean isUnitLengthVector()

Description copied from class: AVector

Returns true if the vector has unit length

Overrides:

isUnitLengthVector in class AVector

Returns:

hashCode

public int hashCode()

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

Returns: