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.logging.AbstractLoggable
      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:
WekaObject<WekaNumericAttribute>, DatabaseObject, FeatureVector<FloatVector,Float>, SpatialComparable, SpatialObject, Loggable

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
 
Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debug
 
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.
 int getDimensionality()
          The dimensionality of the vector space whereof this FeatureVector is an element.
 Matrix getRowVector()
          Returns a Matrix representing in one row and getDimensionality() columns the values of this FeatureVector.
 Float getValue(int dimension)
          Returns the value in the specified dimension.
 FloatVector multiplicate(double k)
          Returns a new FeatureVector that is the result of a scalar multiplication with the given scalar.
 FloatVector negativeVector()
          Returns the additive inverse to this FeatureVector.
 FloatVector newInstance(double[] values)
          Returns a new RealVector of N for the given values.
 FloatVector nullVector()
          Provides a null vector of the same Feature Vector Space as this FeatureVector (that is, of the same dimensionality).
 FloatVector plus(FloatVector fv)
          Returns a new FeatureVector that is the sum of this FeatureVector and the given FeatureVector.
 FloatVector randomInstance(Float min, Float max, Random random)
          Returns a FeatureVector of T with random values between min and max.
 FloatVector randomInstance(Random random)
          Returns a new FloatVector with values between 0 and 1.
 String toString()
          Returns a String representation of the FeatureVector 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, getAttributes, getMax, getMin, newInstance
 
Methods inherited from class de.lmu.ifi.dbs.elki.data.AbstractDatabaseObject
getID, setID
 
Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning
 
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 DoubleVector with the specified values
See Also:
RealVector.newInstance(double[])

randomInstance

public FloatVector randomInstance(Random random)
Returns a new FloatVector with values between 0 and 1.

Parameters:
random - a Random instance
Returns:
a FeatureVector of T with random values
See Also:
FeatureVector.randomInstance(java.util.Random)

randomInstance

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

Parameters:
min - minimum of random value
max - maximu of random value
random - a random instance
Returns:
a FeatureVector of T with random values between min and max
See Also:
FeatureVector.randomInstance(Number, Number, java.util.Random)

getDimensionality

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

Returns:
the number of dimensions of this FeatureVector
See Also:
FeatureVector.getDimensionality()

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
See Also:
FeatureVector.getValue(int)

getColumnVector

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

Returns:
a Matrix representing in one column and getDimensionality() rows the values of this FeatureVector
See Also:
FeatureVector.getColumnVector()

getRowVector

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

Returns:
a Matrix representing in one row and getDimensionality() columns the values of this FeatureVector
See Also:
FeatureVector.getRowVector()

plus

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

Parameters:
fv - a FeatureVector to be added to this Featurevector
Returns:
a new FeatureVector that is the sum of this FeatureVector and the given FeatureVector
See Also:
FeatureVector.plus(FeatureVector)

nullVector

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

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

negativeVector

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

Returns:
the additive inverse to this FeatureVector
See Also:
FeatureVector.negativeVector()

multiplicate

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

Parameters:
k - a scalar to multiply this FeatureVector with
Returns:
a new FeatureVector that is the result of a scalar multiplication with the given scalar
See Also:
FeatureVector.multiplicate(double)

toString

public String toString()
Description copied from interface: FeatureVector
Returns a String representation of the FeatureVector 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
See Also:
FeatureVector.toString()

Release 0.1 (2008-07-10_1838)