mikera.vectorz.impl

Class SingleElementVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.AConstrainedVector

mikera.vectorz.impl.SingleElementVector

All Implemented Interfaces:

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

public final class SingleElementVector
extends AConstrainedVector
implements ISparse

A sparse mutable vector that has a only one element that can be non-zero. All other components are forced to remain at zero, setting them to a non-zero value results in an exception.

Author:

Mike

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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
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	isElementConstrained() Returns true if this array has some constraints on element values
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
int	length()
double	magnitude() Returns the magnitude (Euclidean length) of the vector
double	magnitudeSquared()
void	multiply(double factor) Multiplies the vector by a constant factor
double	normalise() Normalises this vector to a magnitude of 1.0 Has no effect on a zero-length vector (i.e.
void	set(int i, double value)
void	square() Squares all elements of the vector
double	unsafeGet(int i)

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, 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, dotProduct, dotProduct, elementCount, elementIterator, elementSquaredSum, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsArray, fill, fillRange, get, get, get, getElements, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isMutable, isSameShape, isSameShape, isUnitLengthVector, isView, isZero, iterator, join, log, logistic, maxAbsElement, multiply, multiply, multiply, multiplyTo, mutable, negate, nonZeroCount, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reshape, scale, scaleAdd, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, set, set, set, setElements, setElements, setRange, setValues, signum, slice, slice, sliceCount, sub, sub, sub, subMultiple, subVector, tanh, toDoubleArray, toDoubleBuffer, toList, toNormal, toString, toVector, unsafeSet, validate, zeroCount

Methods inherited from class mikera.arrayz.impl.AbstractArray

broadcastCloneLike, ensureMutable, exp, get, getSliceViews, isBoolean, 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, get, getSliceViews, isBoolean, reciprocal, scale, set, set, sqrt, toArray

Constructor Detail

SingleElementVector

public SingleElementVector(int componentIndex,
                   int dimensions)

SingleElementVector

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

Method Detail

length

public int length()

Specified by:

length in interface IVector

Specified by:

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

magnitudeSquared

public double magnitudeSquared()

Overrides:

magnitudeSquared in class AVector

square

public void square()

Description copied from class: AVector

Squares all elements of the vector

Specified by:

square in interface INDArray

Overrides:

square in class AVector

normalise

public double normalise()

Description copied from class: AVector

Normalises this vector to a magnitude of 1.0 Has no effect on a zero-length vector (i.e. it will remain zero)

Overrides:

normalise 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 AConstrainedVector

Returns:

isElementConstrained

public boolean isElementConstrained()

Description copied from interface: INDArray

Returns true if this array has some constraints on element values

Specified by:

isElementConstrained in interface INDArray

Overrides:

isElementConstrained in class AConstrainedVector

multiply

public void multiply(double factor)

Description copied from class: AVector

Multiplies the vector by a constant factor

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AVector

Parameters:

factor - Factor by which to multiply each component of the vector

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:

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:

unsafeGet

public double unsafeGet(int i)

Overrides:

unsafeGet in class AVector

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

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: