mikera.vectorz.impl

Class SparseIndexedVector

java.lang.Object

mikera.vectorz.AVector

mikera.vectorz.impl.ASparseVector

mikera.vectorz.impl.SparseIndexedVector

All Implemented Interfaces:

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

public class SparseIndexedVector
extends ASparseVector

Indexed sparse vector. Mutable only in the elements included in the index. Index must be distinct and sorted.

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double[]	data
Index	index

Method Summary

Methods

Modifier and Type	Method and Description
void	absolute() Sets each component of the vector to its absolute value
void	addMultipleToArray(double factor, int offset, double[] array, int arrayOffset, int length)
void	addToArray(int offset, double[] array, int arrayOffset, int length)
void	copySparseValuesTo(double[] array, int offset)
void	copyTo(AVector v, int offset) Copies a the contents of a vector to a vector at the specified offset
void	copyTo(double[] array, int offset) Copies a the contents of a vector to a double array at the specified offset
static SparseIndexedVector	create(int length, Index index, AVector data)
static SparseIndexedVector	create(int length, Index index, double[] data)
double	dotProduct(ArrayVector v)
double	dotProduct(AVector v)
double	elementSum() Returns the sum of all elements in a vector
double	get(int i)
boolean	includesIndex(int i) Returns true iff the sparse vector contains the index i
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
boolean	isZeroVector() Returns true if this vector is a zero vector (all components zero)
int	length()
double	magnitudeSquared()
double	maxAbsElement() Returns the maximum absolute element of a vector
void	multiply(ArrayVector v)
void	multiply(AVector v)
void	multiply(double[] array, int offset)
void	negate()
int	nonSparseElementCount() Returns the number of non-sparse elements in the sparse vector.
Vector	nonSparseValues() Returns the non-sparse values as a vector view
void	set(int i, double value)
static SparseIndexedVector	wrap(int length, Index index, double[] data) Creates a SparseIndexedVector with the specified index and data values.

Methods inherited from class mikera.vectorz.AVector

add, add, addMultiple, addMultiple, addMultiple, addProduct, addProduct, addProduct, addWeighted, angle, asList, asVector, clamp, clampMax, clampMin, clone, compareTo, copy, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divideTo, dotProduct, epsilonEquals, epsilonEquals, equals, fill, fillRange, get, hashCode, interpolate, interpolate, isMutable, isReference, isUnitLengthVector, iterator, join, magnitude, multiply, multiplyTo, normalise, normaliseMaxAbsElement, projectToPlane, reshape, scale, scale, scaleAdd, scaleToMagnitude, set, set, set, set, setValues, sub, subMultiple, subVector, toArray, toList, toString

Methods inherited from class java.lang.Object

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

Field Detail

index

public final Index index

data

public final double[] data

Method Detail

wrap

public static SparseIndexedVector wrap(int length,
                       Index index,
                       double[] data)

Creates a SparseIndexedVector with the specified index and data values. Performs no checking - Index must be distinct and sorted.

create

public static SparseIndexedVector create(int length,
                         Index index,
                         double[] data)

create

public static SparseIndexedVector create(int length,
                         Index index,
                         AVector data)

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:

length

public int length()

Specified by:

length in interface IVector

Specified by:

length in class AVector

multiply

public void multiply(AVector v)

Overrides:

multiply in class AVector

multiply

public void multiply(ArrayVector v)

multiply

public void multiply(double[] array,
            int offset)

Overrides:

multiply in class AVector

magnitudeSquared

public double magnitudeSquared()

Overrides:

magnitudeSquared in class AVector

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:

maxAbsElement

public double maxAbsElement()

Description copied from class: AVector

Returns the maximum absolute element of a vector

Overrides:

maxAbsElement in class AVector

Returns:

negate

public void negate()

Overrides:

negate in class AVector

absolute

public void absolute()

Description copied from class: AVector

Sets each component of the vector to its absolute value

Overrides:

absolute in class AVector

get

public double get(int i)

Specified by:

get in interface IVector

Specified by:

get 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

Overrides:

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

dotProduct

public double dotProduct(AVector v)

Overrides:

dotProduct in class AVector

dotProduct

public double dotProduct(ArrayVector v)

addMultipleToArray

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

Overrides:

addMultipleToArray in class AVector

addToArray

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

Overrides:

addToArray in class AVector

copyTo

public void copyTo(double[] array,
          int offset)

Description copied from class: AVector

Copies a the contents of a vector to a double array at the specified offset

Overrides:

copyTo in class AVector

copySparseValuesTo

public void copySparseValuesTo(double[] array,
                      int offset)

copyTo

public void copyTo(AVector v,
          int offset)

Description copied from class: AVector

Copies a the contents of a vector to a vector at the specified offset

Overrides:

copyTo in class AVector

set

public void set(int i,
       double value)

Specified by:

set in interface IVector

Specified by:

set in class AVector

nonSparseValues

public Vector nonSparseValues()

Description copied from class: ASparseVector

Returns the non-sparse values as a vector view

Specified by:

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