Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

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

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.data.AbstractDatabaseObject
      extended by de.lmu.ifi.dbs.elki.data.NumberVector<V,N>
          extended by de.lmu.ifi.dbs.elki.data.RealVector<FloatVector,Float>
              extended by de.lmu.ifi.dbs.elki.data.FloatVector
All Implemented Interfaces:
DatabaseObject, FeatureVector<FloatVector,Float>, SpatialComparable, SpatialObject

public class FloatVector
extends RealVector<FloatVector,Float>

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

Author:
Elke Achtert

Field Summary
private  float[] values
          Keeps the values of the float vector
 
Fields inherited from class de.lmu.ifi.dbs.elki.data.NumberVector
ATTRIBUTE_SEPARATOR
 
Constructor Summary
FloatVector(float[] values)
          Provides a FloatVector consisting of the given float values.
FloatVector(Float[] values)
          Provides a FloatVector consisting of the given float values.
FloatVector(List<Float> values)
          Provides a FloatVector consisting of float values according to the given Float values.
 
Method Summary
 Vector getColumnVector()
          Returns a Vector representing in one column and getDimensionality() rows the values of this FeatureVector of V.
 int getDimensionality()
          The dimensionality of the vector space where of this FeatureVector of V is an element.
 Matrix getRowVector()
          Returns a Matrix representing in one row and getDimensionality() columns the values of this FeatureVector of V.
 Float getValue(int dimension)
          Returns the value in the specified dimension.
 FloatVector multiplicate(double k)
          Returns a new FeatureVector of V that is the result of a scalar multiplication with the given scalar.
 FloatVector negativeVector()
          Returns the additive inverse to this FeatureVector of V.
 FloatVector newInstance(double[] values)
          Returns a new RealVector of N for the given values.
 FloatVector newInstance(Float[] values)
          Returns a new FeatureVector of V for the given values.
 FloatVector newInstance(List<Float> values)
          Returns a new FeatureVector of V for the given values.
 FloatVector nullVector()
          Provides a null vector of the same Feature Vector Space as this FeatureVector of V (that is, of the same dimensionality).
 FloatVector plus(FloatVector fv)
          Returns a new FeatureVector of V that is the sum of this FeatureVector of V and the given FeatureVector of V.
 FloatVector randomInstance(Float min, Float max, Random random)
          Returns a FeatureVector of V with random values between min and max.
 FloatVector randomInstance(FloatVector min, FloatVector max, Random random)
          Returns a FeatureVector of V with random values between min and max.
 FloatVector randomInstance(Random random)
          Returns a FeatureVector of V with uniformly distributed (0-1) random values.
 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 de.lmu.ifi.dbs.elki.data.NumberVector
equals, getMax, getMin, getRange
 
Methods inherited from class de.lmu.ifi.dbs.elki.data.AbstractDatabaseObject
getID, setID
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface de.lmu.ifi.dbs.elki.data.DatabaseObject
getID, setID
 
Methods inherited from interface de.lmu.ifi.dbs.elki.index.tree.spatial.SpatialObject
getID
 

Field Detail

values

private float[] values
Keeps the values of the float vector

Constructor Detail

FloatVector

public FloatVector(List<Float> values)
Provides a FloatVector consisting of float values according to the given Float values.

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

FloatVector

public FloatVector(float[] values)
Provides a FloatVector consisting of the given float values.

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

FloatVector

public FloatVector(Float[] values)
Provides a FloatVector consisting of the given float values.

Parameters:
values - the values to be set as values of the float vector
Method Detail

newInstance

public FloatVector newInstance(double[] values)
Description copied from class: RealVector
Returns a new RealVector of N for the given values.

Specified by:
newInstance in class RealVector<FloatVector,Float>
Parameters:
values - the values of the featureVector
Returns:
a new FloatVector with the specified values

newInstance

public FloatVector newInstance(Float[] values)
Description copied from interface: FeatureVector
Returns a new FeatureVector of V for the given values.

Parameters:
values - the values of the featureVector
Returns:
a new FeatureVector of V for the given values

newInstance

public FloatVector newInstance(List<Float> values)
Description copied from interface: FeatureVector
Returns a new FeatureVector of V for the given values.

Parameters:
values - the values of the featureVector
Returns:
a new FeatureVector of V for the given values

randomInstance

public FloatVector randomInstance(Random random)
Description copied from interface: FeatureVector
Returns a FeatureVector of V with uniformly distributed (0-1) random values.

Parameters:
random - a Random instance
Returns:
a new FloatVector with random values between 0 and 1

randomInstance

public FloatVector randomInstance(Float min,
                                  Float max,
                                  Random random)
Description copied from interface: FeatureVector
Returns a FeatureVector of V with random values between min and max.

Parameters:
min - minimum of random value
max - maximum of random value
random - a random instance
Returns:
a FeatureVector of V with random values between min and max

randomInstance

public FloatVector randomInstance(FloatVector min,
                                  FloatVector max,
                                  Random random)
Description copied from interface: FeatureVector
Returns a FeatureVector of V with random values between min and max.

Parameters:
min - minimum of random value for each axis
max - maximum of random value for each axis
random - a random instance
Returns:
a FeatureVector of V with random values between min and max
See Also:
FeatureVector.randomInstance(de.lmu.ifi.dbs.elki.data.FeatureVector, de.lmu.ifi.dbs.elki.data.FeatureVector, java.util.Random)

getDimensionality

public int getDimensionality()
Description copied from interface: FeatureVector
The dimensionality of the vector space where of this FeatureVector of V is an element.

Returns:
the number of dimensions of this FeatureVector of V

getValue

public Float getValue(int dimension)
Description copied from interface: FeatureVector
Returns the value in the specified dimension.

Parameters:
dimension - the desired dimension, where 1 ≤ dimension ≤ this.getDimensionality()
Returns:
the value in the specified dimension

getColumnVector

public Vector getColumnVector()
Description copied from interface: FeatureVector
Returns a Vector representing in one column and getDimensionality() rows the values of this FeatureVector of V.

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

getRowVector

public Matrix getRowVector()
Description copied from interface: FeatureVector
Returns a Matrix representing in one row and getDimensionality() columns the values of this FeatureVector of V.

Returns:
a Matrix representing in one row and getDimensionality() columns the values of this FeatureVector of V

plus

public FloatVector plus(FloatVector fv)
Description copied from interface: FeatureVector
Returns a new FeatureVector of V that is the sum of this FeatureVector of V and the given FeatureVector of V.

Parameters:
fv - a FeatureVector of V to be added to this FeatureVector of V
Returns:
a new FeatureVector of V that is the sum of this FeatureVector of V and the given FeatureVector of V

nullVector

public FloatVector nullVector()
Description copied from interface: FeatureVector
Provides a null vector of the same Feature Vector Space as this FeatureVector of V (that is, of the same dimensionality).

Returns:
a null vector of the same Feature Vector Space as this FeatureVector of V (that is, of the same dimensionality)

negativeVector

public FloatVector negativeVector()
Description copied from interface: FeatureVector
Returns the additive inverse to this FeatureVector of V.

Returns:
the additive inverse to this FeatureVector of V

multiplicate

public FloatVector multiplicate(double k)
Description copied from interface: FeatureVector
Returns a new FeatureVector of V that is the result of a scalar multiplication with the given scalar.

Parameters:
k - a scalar to multiply this FeatureVector of V with
Returns:
a new FeatureVector of V that is the result of a scalar multiplication with the given scalar

toString

public 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<FloatVector,Float>
Overrides:
toString in class Object
Returns:
a String representation of the FeatureVector of V

Release 0.2.1 (2009-07-13_1605)