mikera.vectorz.impl

Class SingleElementVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.ASparseVector

mikera.vectorz.impl.SingleElementVector

All Implemented Interfaces:

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

public final class SingleElementVector
extends ASparseVector

A sparse immutable 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

Field Summary

Fields inherited from class mikera.vectorz.impl.ASizedVector

length

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
void	add(ASparseVector v)
static AVector	create(double val, int i, int len)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
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
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	includesIndex(int i) Returns true iff the sparse vector contains the index i
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.
boolean	isMutable() Returns true if this vector is mutable.
double	magnitude() Returns the magnitude (Euclidean length) of the vector
double	magnitudeSquared()
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
void	set(int i, double value) Set a specified element in a vector
AScalar	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)

Methods inherited from class mikera.vectorz.impl.ASparseVector

dotProduct, 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, 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, elementIterator, elementSquaredSum, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equalsArray, equalsArray, fill, fillRange, get, get, get, get, getElements, getLongShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isSameShape, isSameShape, isUnitLengthVector, isView, isZero, iterator, join, join, log, logistic, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiplyTo, mutable, negate, nonZeroCount, 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, unsafeSet, unsafeSetInteger, validate, zeroCount

Methods inherited from class mikera.arrayz.impl.AbstractArray

broadcastCloneLike, ensureMutable, exp, getSlices, 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, getSlices, 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

create

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

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:

magnitudeSquared

public double magnitudeSquared()

Overrides:

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

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:

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 AVector

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:

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)

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

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)

Specified by:

slice in interface INDArray

Overrides:

slice in class AVector

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

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:

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:

add

public void add(ASparseVector v)

Specified by:

add in class ASparseVector