gov.sandia.cognition.math.matrix

Interface InfiniteVector<KeyType>

Type Parameters:

KeyType - The type of the keys (indices) into the infinite dimensional vector.

All Superinterfaces:

java.lang.Cloneable, CloneableSerializable, java.lang.Iterable<InfiniteVector.Entry<KeyType>>, NumericMap<KeyType>, Ring<InfiniteVector<KeyType>>, ScalarMap<KeyType>, java.io.Serializable, VectorSpace<InfiniteVector<KeyType>,InfiniteVector.Entry<KeyType>>

All Known Implementing Classes:

DefaultInfiniteVector

public interface InfiniteVector<KeyType>
extends VectorSpace<InfiniteVector<KeyType>,InfiniteVector.Entry<KeyType>>, ScalarMap<KeyType>

A Vector that has a potentially infinite number of indices (keys), but will only contain a countable number in any instance.

Since:

3.2.1

Author:

Justin Basilico, Kevin R. Dixon

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InfiniteVector.Entry<KeyType> Entry for a InfiniteVector
static interface	InfiniteVector.KeyValueConsumer<KeyType> Defines the functionality for a consumer of vector entries, which are an index and a value.

Method Summary

Modifier and Type	Method and Description
void	compact() Removes the zero elements from the vector.
void	forEachEntry(InfiniteVector.KeyValueConsumer<? super KeyType> consumer) Applies the given function to each active entry in this vector.
void	forEachNonZero(InfiniteVector.KeyValueConsumer<? super KeyType> consumer) Applies the given function to each non-zero entry in this vector.

Methods inherited from interface gov.sandia.cognition.math.matrix.VectorSpace

angle, cosine, dot, dotProduct, euclideanDistance, euclideanDistanceSquared, getMaxValue, getMinValue, isUnitVector, isUnitVector, norm, norm1, norm2, norm2Squared, normInfinity, sum, unitVector, unitVectorEquals

Methods inherited from interface gov.sandia.cognition.math.Ring

clone, dotTimes, dotTimesEquals, equals, equals, isZero, isZero, minus, minusEquals, negative, negativeEquals, plus, plusEquals, scale, scaledMinus, scaledMinusEquals, scaledPlus, scaledPlusEquals, scaleEquals, zero

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface gov.sandia.cognition.collection.ScalarMap

asMap, decrement, decrement, decrementAll, decrementAll, entrySet, get, getMaxValue, getMinValue, increment, increment, incrementAll, incrementAll, set, setAll, setAll

Methods inherited from interface gov.sandia.cognition.collection.NumericMap

clear, containsKey, getMaxValueKey, getMaxValueKeys, getMinValueKey, getMinValueKeys, isEmpty, keySet, size

Method Detail

compact

void compact()

Removes the zero elements from the vector.

forEachEntry

void forEachEntry(InfiniteVector.KeyValueConsumer<? super KeyType> consumer)

Applies the given function to each active entry in this vector. This can be faster than looping over the entries using an iterator.

Parameters:

consumer - The consumer for the entries. It is called for each active entry in the vector, in order by increasing index.

forEachNonZero

void forEachNonZero(InfiniteVector.KeyValueConsumer<? super KeyType> consumer)

Applies the given function to each non-zero entry in this vector. This can be faster than looping over the entries using an iterator.

Parameters:

consumer - The consumer for the non-zero entries. It is called for each non-zero entry in the vector, in order by increasing index.