de.lmu.ifi.dbs.elki.data

Class SparseFloatVector

java.lang.Object

de.lmu.ifi.dbs.elki.data.AbstractNumberVector<Float>

de.lmu.ifi.dbs.elki.data.SparseFloatVector

All Implemented Interfaces:

FeatureVector<Float>, NumberVector<Float>, SparseFeatureVector<Float>, SparseNumberVector<Float>, SpatialComparable

public class SparseFloatVector
extends AbstractNumberVector<Float>
implements SparseNumberVector<Float>

A SparseFloatVector is to store real values approximately as float values.

A SparseFloatVector only requires storage for those attribute values that are non-zero.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SparseFloatVector.Factory Factory class.
static class	SparseFloatVector.VariableSerializer Serialization class using VarInt encodings.

Field Summary

Fields

Modifier and Type	Field and Description
private int	dimensionality The dimensionality of this feature vector.
static SparseFloatVector.Factory	FACTORY Static instance.
private int[]	indexes Indexes of values.
private float[]	values Stored values.
static ByteBufferSerializer<SparseFloatVector>	VARIABLE_SERIALIZER Serializer using varint encoding.

Fields inherited from class de.lmu.ifi.dbs.elki.data.AbstractNumberVector

ATTRIBUTE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
SparseFloatVector(float[] values) Provides a SparseFloatVector consisting of double values according to the specified mapping of indices and values.
SparseFloatVector(int[] indexes, float[] values, int dimensionality) Direct constructor.
SparseFloatVector(gnu.trove.map.TIntFloatMap values, int dimensionality) Provides a SparseFloatVector consisting of double values according to the specified mapping of indices and values.

Method Summary

Methods

Modifier and Type	Method and Description
double	doubleValue(int dimension) Deprecated.
Vector	getColumnVector() Returns a Vector representing in one column and getDimensionality() rows the values of this NumberVector of V.
int	getDimensionality() The dimensionality of the vector space where of this FeatureVector of V is an element.
private int	getMaxDim() Get the maximum dimensionality.
Float	getValue(int dimension) Deprecated.
private double[]	getValues() Returns an array consisting of the values of this feature vector.
int	iter() Iterator over non-zero features only, ascendingly.
int	iterAdvance(int iter) Advance the iterator to the next position.
byte	iterByteValue(int iter) Get the value of the iterators' current dimension.
int	iterDim(int iter) Get the dimension an iterator points to.
double	iterDoubleValue(int iter) Get the value of the iterators' current dimension.
float	iterFloatValue(int iter) Get the value of the iterators' current dimension.
int	iterIntValue(int iter) Get the value of the iterators' current dimension.
long	iterLongValue(int iter) Get the value of the iterators' current dimension.
short	iterShortValue(int iter) Get the value of the iterators' current dimension.
boolean	iterValid(int iter) Test the iterator position for validity.
long	longValue(int dimension) Deprecated.
void	setDimensionality(int dimensionality) Sets the dimensionality to the new value.
String	toString() Provides a String representation of this SparseFloatVector as suitable for SparseNumberVectorLabelParser .

Methods inherited from class de.lmu.ifi.dbs.elki.data.AbstractNumberVector

byteValue, floatValue, getMax, getMin, intValue, shortValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.data.SparseNumberVector

byteValue, floatValue, intValue, shortValue

Methods inherited from interface de.lmu.ifi.dbs.elki.data.spatial.SpatialComparable

getMax, getMin

Field Detail

FACTORY

public static final SparseFloatVector.Factory FACTORY

Static instance.

VARIABLE_SERIALIZER

public static final ByteBufferSerializer<SparseFloatVector> VARIABLE_SERIALIZER

Serializer using varint encoding.

indexes

private final int[] indexes

Indexes of values.

values

private final float[] values

Stored values.

dimensionality

private int dimensionality

The dimensionality of this feature vector.

Constructor Detail

SparseFloatVector

public SparseFloatVector(int[] indexes,
                 float[] values,
                 int dimensionality)

Direct constructor.

Parameters:

indexes - Indexes Must be sorted!

values - Associated value.

dimensionality - "true" dimensionality

SparseFloatVector

public SparseFloatVector(gnu.trove.map.TIntFloatMap values,
                 int dimensionality)
                  throws IllegalArgumentException

Provides a SparseFloatVector consisting of double values according to the specified mapping of indices and values.

Parameters:

values - the values to be set as values of the real vector

dimensionality - the dimensionality of this feature vector

Throws:

IllegalArgumentException - if the given dimensionality is too small to cover the given values (i.e., the maximum index of any value not zero is bigger than the given dimensionality)

SparseFloatVector

public SparseFloatVector(float[] values)
                  throws IllegalArgumentException

Provides a SparseFloatVector consisting of double values according to the specified mapping of indices and values.

Parameters:

values - the values to be set as values of the real vector

Throws:

IllegalArgumentException - if the given dimensionality is too small to cover the given values (i.e., the maximum index of any value not zero is bigger than the given dimensionality)

Method Detail

getMaxDim

private int getMaxDim()

Get the maximum dimensionality.

Returns:

the maximum dimensionality seen

getDimensionality

public int getDimensionality()

Description copied from interface: FeatureVector

The dimensionality of the vector space where of this FeatureVector of V is an element.

Specified by:

getDimensionality in interface FeatureVector<Float>

Specified by:

getDimensionality in interface SpatialComparable

Returns:

the number of dimensions of this FeatureVector of V

setDimensionality

public void setDimensionality(int dimensionality)
                       throws IllegalArgumentException

Sets the dimensionality to the new value.

Specified by:

setDimensionality in interface SparseNumberVector<Float>

Parameters:

dimensionality - the new dimensionality

Throws:

IllegalArgumentException - if the given dimensionality is too small to cover the given values (i.e., the maximum index of any value not zero is bigger than the given dimensionality)

getValue

@Deprecated
public Float getValue(int dimension)

Deprecated.

Description copied from interface: FeatureVector

Returns the value in the specified dimension.

Specified by:

getValue in interface FeatureVector<Float>

Specified by:

getValue in interface NumberVector<Float>

Parameters:

dimension - the desired dimension, where 0 ≤ dimension ≤ this.getDimensionality()-1

Returns:

the value in the specified dimension

doubleValue

@Deprecated
public double doubleValue(int dimension)

Deprecated.

Description copied from interface: NumberVector

Returns the value in the specified dimension as double. Note: this might seem redundant with respect to getValue(dim).doubleValue(), but usually this is much more efficient due to boxing/unboxing cost.

Specified by:

doubleValue in interface NumberVector<Float>

Specified by:

doubleValue in interface SparseNumberVector<Float>

Parameters:

dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()

Returns:

the value in the specified dimension

longValue

@Deprecated
public long longValue(int dimension)

Deprecated.

Description copied from interface: NumberVector

Returns the value in the specified dimension as long. Note: this might seem redundant with respect to getValue(dim).longValue(), but usually this is much more efficient due to boxing/unboxing cost.

Specified by:

longValue in interface NumberVector<Float>

Specified by:

longValue in interface SparseNumberVector<Float>

Parameters:

dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()

Returns:

the value in the specified dimension

getColumnVector

public Vector getColumnVector()

Description copied from interface: NumberVector

Returns a Vector representing in one column and getDimensionality() rows the values of this NumberVector of V.

Specified by:

getColumnVector in interface NumberVector<Float>

Returns:

a Matrix representing in one column and getDimensionality() rows the values of this NumberVector of V

toString

public String toString()

Provides a String representation of this SparseFloatVector as suitable for SparseNumberVectorLabelParser .

The returned String is a single line with entries separated by AbstractNumberVector.ATTRIBUTE_SEPARATOR. The first entry gives the number of values actually not zero. Following entries are pairs of Integer and Float where the Integer gives the index of the dimensionality and the Float gives the corresponding value.

Example: a vector (0,1.2,1.3,0)^T would result in the String
2 2 1.2 3 1.3

Specified by:

toString in interface FeatureVector<Float>

Overrides:

toString in class Object

Returns:

a String representation of this SparseFloatVector

getValues

private double[] getValues()

Returns an array consisting of the values of this feature vector.

Returns:

an array consisting of the values of this feature vector

iter

public int iter()

Description copied from interface: SparseNumberVector

Iterator over non-zero features only, ascendingly. Note: depending on the underlying implementation, this may or may not be the dimension. Use SparseFeatureVector.iterDim(int) to get the actual dimension. In fact, usually this will be the ith non-zero value, assuming an array representation. Think of this number as an iterator. For efficiency, it has a primitive type! Intended usage:

 for (int iter = v.iter(); v.iterValid(iter); iter = v.iterAdvance(iter)) {
   final int dim = v.iterDim(iter);
   final double val = v.iterDoubleValue(iter);
   // Do something.
 }
 
 

Specified by:

iter in interface SparseFeatureVector<Float>

Specified by:

iter in interface SparseNumberVector<Float>

Returns:

Identifier for the first non-zero dimension, not necessarily the dimension!

iterDim

public int iterDim(int iter)

Description copied from interface: SparseFeatureVector

Get the dimension an iterator points to.

Specified by:

iterDim in interface SparseFeatureVector<Float>

Parameters:

iter - Iterator position

Returns:

Dimension the iterator refers to

iterAdvance

public int iterAdvance(int iter)

Description copied from interface: SparseFeatureVector

Advance the iterator to the next position.

Specified by:

iterAdvance in interface SparseFeatureVector<Float>

Parameters:

iter - Previous iterator position

Returns:

Next iterator position

iterValid

public boolean iterValid(int iter)

Description copied from interface: SparseFeatureVector

Test the iterator position for validity.

Specified by:

iterValid in interface SparseFeatureVector<Float>

Parameters:

iter - Iterator position

Returns:

true when it refers to a valid position.

iterDoubleValue

public double iterDoubleValue(int iter)

Description copied from interface: SparseNumberVector

Get the value of the iterators' current dimension.

Specified by:

iterDoubleValue in interface SparseNumberVector<Float>

Parameters:

iter - Iterator

Returns:

Value at the current position

iterFloatValue

public float iterFloatValue(int iter)

Description copied from interface: SparseNumberVector

Get the value of the iterators' current dimension.

Specified by:

iterFloatValue in interface SparseNumberVector<Float>

Parameters:

iter - Iterator

Returns:

Value at the current position

iterIntValue

public int iterIntValue(int iter)

Description copied from interface: SparseNumberVector

Get the value of the iterators' current dimension.

Specified by:

iterIntValue in interface SparseNumberVector<Float>

Parameters:

iter - Iterator

Returns:

Value at the current position

iterShortValue

public short iterShortValue(int iter)

Description copied from interface: SparseNumberVector

Get the value of the iterators' current dimension.

Specified by:

iterShortValue in interface SparseNumberVector<Float>

Parameters:

iter - Iterator

Returns:

Value at the current position

iterLongValue

public long iterLongValue(int iter)

Description copied from interface: SparseNumberVector

Get the value of the iterators' current dimension.

Specified by:

iterLongValue in interface SparseNumberVector<Float>

Parameters:

iter - Iterator

Returns:

Value at the current position

iterByteValue

public byte iterByteValue(int iter)

Description copied from interface: SparseNumberVector

Get the value of the iterators' current dimension.

Specified by:

iterByteValue in interface SparseNumberVector<Float>

Parameters:

iter - Iterator

Returns:

Value at the current position