de.lmu.ifi.dbs.elki.data

Class FloatVector

java.lang.Object

de.lmu.ifi.dbs.elki.data.FloatVector

All Implemented Interfaces:

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

public class FloatVector
extends java.lang.Object
implements NumberVector

Vector type using float[] storage, thus needing approximately half as much memory as DoubleVector.

Since:

0.1

Author:

Elke Achtert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FloatVector.Factory Factory for float vectors.
static class	FloatVector.ShortSerializer Serialization class for dense float vectors with up to Short.MAX_VALUE dimensions, by using a short for storing the dimensionality.
static class	FloatVector.SmallSerializer Serialization class for dense float vectors with up to 127 dimensions, by using a byte for storing the dimensionality.
static class	FloatVector.VariableSerializer Serialization class for variable dimensionality by using VarInt encoding.

Field Summary

Fields

Modifier and Type	Field and Description
static ByteBufferSerializer<FloatVector>	BYTE_SERIALIZER Serializer for up to 127 dimensions.
static FloatVector.Factory	FACTORY Static factory instance.
static ByteBufferSerializer<FloatVector>	SHORT_SERIALIZER Serializer for up to 2^15-1 dimensions.
private float[]	values Keeps the values of the float vector.
static ByteBufferSerializer<FloatVector>	VARIABLE_SERIALIZER Serializer using varint encoding.

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

ATTRIBUTE_SEPARATOR, FIELD, FIELD_1D, FIELD_2D, VARIABLE_LENGTH

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

TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
	FloatVector(float[] values) Create a FloatVector consisting of the given float values.
private	FloatVector(float[] values, boolean nocopy) Private constructor.

Method Summary

Modifier and Type	Method and Description
double	doubleValue(int dimension) Returns the value in the specified dimension as double.
float	floatValue(int dimension) Returns the value in the specified dimension as float.
int	getDimensionality() The dimensionality of the vector space where of this FeatureVector of V is an element.
java.lang.Float	getValue(int dimension) Deprecated.
long	longValue(int dimension) Returns the value in the specified dimension as long.
double[]	toArray() Returns a double array copy of this vector.
java.lang.String	toString() Returns a String representation of the FeatureVector of V as a line that is suitable to be printed in a sequential file.

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.NumberVector

byteValue, getMax, getMin, intValue, shortValue

Field Detail

FACTORY

public static final FloatVector.Factory FACTORY

Static factory instance.

BYTE_SERIALIZER

public static final ByteBufferSerializer<FloatVector> BYTE_SERIALIZER

Serializer for up to 127 dimensions.

SHORT_SERIALIZER

public static final ByteBufferSerializer<FloatVector> SHORT_SERIALIZER

Serializer for up to 2^15-1 dimensions.

VARIABLE_SERIALIZER

public static final ByteBufferSerializer<FloatVector> VARIABLE_SERIALIZER

Serializer using varint encoding.

values

private final float[] values

Keeps the values of the float vector.

Constructor Detail

FloatVector

private FloatVector(float[] values,
                    boolean nocopy)

Private constructor. NOT for public use.

Parameters:

values - Data values

nocopy - Flag to re-use the values array

FloatVector

public FloatVector(float[] values)

Create a FloatVector consisting of the given float values.

Parameters:

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

Method Detail

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

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

public double doubleValue(int dimension)

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

Parameters:

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

Returns:

the value in the specified dimension

floatValue

public float floatValue(int dimension)

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

Parameters:

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

Returns:

the value in the specified dimension

longValue

public long longValue(int dimension)

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

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()

Description copied from interface: FeatureVector

Returns a String representation of the FeatureVector of V as a line that is suitable to be printed in a sequential file.

Specified by:

toString in interface FeatureVector<java.lang.Number>

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the FeatureVector of V