mikera.vectorz.impl

Class SingleElementVector

java.lang.Object

mikera.arrayz.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.SingleElementVector

All Implemented Interfaces:

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

public final class SingleElementVector
extends AVector
implements ISparse

A sparse mutable vector that has one non-zero element. All other components are forced to remain at zero, setting them is ignored.

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
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)
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()
double	normalise()
void	scale(double factor) Scales the vector by a scalar factor
void	set(int i, double value)
void	square()

Methods inherited from class mikera.vectorz.AVector

abs, add, add, add, add, add, add, addAt, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleToArray, addProduct, addProduct, addProduct, addProductToArray, addProductToArray, addToArray, addWeighted, angle, applyOp, applyOp, asList, asVector, broadcast, clamp, clampMax, clampMin, clone, compareTo, copyTo, copyTo, copyTo, copyTo, copyTo, countZeros, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divideTo, dotProduct, dotProduct, elementCount, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fill, fillRange, get, getShape, getSlices, hashCode, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isMutable, isUnitLengthVector, isView, isZeroVector, iterator, join, maxAbsElement, multiply, multiply, multiply, multiplyTo, negate, normaliseMaxAbsElement, outerProduct, outerProduct, projectToPlane, reshape, scale, scaleAdd, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, set, set, set, signum, slice, sliceCount, sub, sub, sub, subMultiple, subVector, toArray, toList, toString

Methods inherited from class mikera.arrayz.AbstractArray

get, get, set, set

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

get, get, set, set

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

Overrides:

elementSum in class AVector

Returns:

magnitudeSquared

public double magnitudeSquared()

Overrides:

magnitudeSquared in class AVector

square

public void square()

Overrides:

square in class AVector

normalise

public double normalise()

Overrides:

normalise in class AVector

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:

scale

public void scale(double factor)

Description copied from class: AVector

Scales the vector by a scalar factor

Specified by:

scale in interface INDArray

Overrides:

scale in class AVector

density

public double density()

Description copied from interface: ISparse

Computes the density ratio of this sparse array

Specified by:

density in interface ISparse

Returns:

get

public double get(int i)

Specified by:

get in interface INDArray

Specified by:

get in interface IVector

Specified by:

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