de.lmu.ifi.dbs.elki.data

Class SparseFloatVector

java.lang.Object

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

All Implemented Interfaces:

FeatureVector<java.lang.Number>, NumberVector, SparseFeatureVector<java.lang.Number>, SparseNumberVector, SpatialComparable

public class SparseFloatVector
extends java.lang.Object
implements SparseNumberVector

Sparse vector type, using float[] for storing the values, and int[] for storing the indexes, approximately 8 bytes per non-zero value.

Since:

0.2

Author:

Arthur Zimek

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 static float	FLOAT0 Float constant, for missing values in (inefficient) getValue(int) API.
private int[]	indexes Indexes of values.
private float[]	values Stored values.
static ByteBufferSerializer<SparseFloatVector>	VARIABLE_SERIALIZER Serializer using varint encoding.

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

FIELD, VARIABLE_LENGTH

Fields inherited from interface de.lmu.ifi.dbs.elki.data.NumberVector

ATTRIBUTE_SEPARATOR, FIELD_1D, FIELD_2D

Fields inherited from interface de.lmu.ifi.dbs.elki.data.FeatureVector

TYPE

Constructor Summary

Constructors

Constructor and Description
SparseFloatVector(float[] values) Create 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(it.unimi.dsi.fastutil.ints.Int2FloatOpenHashMap values, int dimensionality) Create a SparseFloatVector consisting of double values according to the specified mapping of indices and values.

Method Summary

Modifier and Type	Method and Description
double	doubleValue(int dimension) Deprecated.
float	floatValue(int dimension) Deprecated.
int	getDimensionality() The dimensionality of the vector space where of this FeatureVector of V is an element.
private int	getMaxDim() Get the maximum dimensionality.
java.lang.Float	getValue(int dimension) Deprecated.
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.
long	iterLongValue(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.
double[]	toArray() Returns a double array copy of this vector.
java.lang.String	toString() Create a String representation of this SparseFloatVector as suitable for SparseNumberVectorLabelParser .

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, intValue, iter, iterByteValue, iterIntValue, iterShortValue, shortValue

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

getMax, getMin

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

iterAdvance, iterRetract

Field Detail

FACTORY

public static final SparseFloatVector.Factory FACTORY

Static instance.

VARIABLE_SERIALIZER

public static final ByteBufferSerializer<SparseFloatVector> VARIABLE_SERIALIZER

Serializer using varint encoding.

FLOAT0

private static final float FLOAT0

Float constant, for missing values in (inefficient) getValue(int) API.

See Also:

Constant Field Values

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(it.unimi.dsi.fastutil.ints.Int2FloatOpenHashMap values,
                         int dimensionality)
                  throws java.lang.IllegalArgumentException

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

java.lang.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 java.lang.IllegalArgumentException

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

java.lang.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<java.lang.Number>

Specified by:

getDimensionality in interface SpatialComparable

Returns:

the number of dimensions of this FeatureVector of V

setDimensionality

public void setDimensionality(int dimensionality)
                       throws java.lang.IllegalArgumentException

Sets the dimensionality to the new value.

Specified by:

setDimensionality in interface SparseNumberVector

Parameters:

dimensionality - the new dimensionality

Throws:

java.lang.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 java.lang.Float getValue(int dimension)

Deprecated.

Description copied from interface: FeatureVector

Returns the value in the specified dimension.

Specified by:

getValue in interface FeatureVector<java.lang.Number>

Specified by:

getValue in interface NumberVector

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

Specified by:

doubleValue in interface SparseNumberVector

Parameters:

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

Returns:

the value in the specified dimension

floatValue

@Deprecated
public float floatValue(int dimension)

Deprecated.

Description copied from interface: NumberVector

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

Specified by:

floatValue in interface NumberVector

Specified by:

floatValue in interface SparseNumberVector

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

Specified by:

longValue in interface SparseNumberVector

Parameters:

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

Returns:

the value in the specified dimension

toArray

public double[] toArray()

Description copied from interface: NumberVector

Returns a double array copy of this vector.

Specified by:

toArray in interface NumberVector

Returns:

Copy as double[]

toString

public java.lang.String toString()

Create a String representation of this SparseFloatVector as suitable for SparseNumberVectorLabelParser . The returned String is a single line with entries separated by NumberVector.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<java.lang.Number>

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this SparseFloatVector

iterDim

public int iterDim(int iter)

Description copied from interface: SparseFeatureVector

Get the dimension an iterator points to.

Specified by:

iterDim in interface SparseFeatureVector<java.lang.Number>

Parameters:

iter - Iterator position

Returns:

Dimension the iterator refers to

iterValid

public boolean iterValid(int iter)

Description copied from interface: SparseFeatureVector

Test the iterator position for validity.

Specified by:

iterValid in interface SparseFeatureVector<java.lang.Number>

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

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

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

Parameters:

iter - Iterator

Returns:

Value at the current position