DenseVector (kelp-javadoc 1.0.0 API)

java.lang.Object
- it.uniroma2.sag.kelp.data.representation.vector.DenseVector

All Implemented Interfaces:

Normalizable, Representation, Vector, Serializable
```
public class DenseVector
extends Object
implements Vector
```
Dense Feature Vector.
It uses EJML to guarantee a very fast computation

Author:

Simone Filice

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DenseVector()` Empty constructor necessary for making `RepresentationFactory` support this implementation.
`DenseVector(org.ejml.data.DenseMatrix64F featureVector)` Initializing constructor.
`DenseVector(float[] featureVector)` Initializing constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(float coeff, float vectorCoeff, Vector vector)` Add a `vector` multiplied by `vectorCoeff` to this vector multiplied by
`void`	`add(float coeff, Vector vector)` Add a `vector` multiplied by `coeff` to this vector
`void`	`add(Vector vector)` Add a `vector` to this vector
`boolean`	`equals(Object featureVector)`
`float`	`getFeatureValue(int featureIndex)` Returns the feature value of the `featureIndex`-th element
`org.ejml.data.DenseMatrix64F`	`getFeatureValues()` Returns the feature values in the EJML format
`int`	`getNumberOfFeatures()` Returns the number of featuresValues
`float`	`getSquaredNorm()` Returns the squared norm of this vector
`String`	`getTextFromData()` Returns a textual representation of the data stored in this representation
`Vector`	`getZeroVector()` Returns a vector whose values are all 0.
`float`	`innerProduct(Vector vector)` Returns the dot product between this vector and `vector`
`void`	`normalize()` Scales the representation in order to have a unit norm in the explicit feature space
`void`	`scale(float coeff)` Multiplies each element of this representation by `coeff`
`void`	`setDataFromText(String representationDescription)` Initializes a Representation using its textual description provided in `representationDescription`
`void`	`setFeatureValues(org.ejml.data.DenseMatrix64F featureVector)` Sets the feature values.
`void`	`setFeatureValues(float[] featureValues)` Sets the feature values.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DenseVector
```
public DenseVector()
```
    Empty constructor necessary for making RepresentationFactory support this implementation.
    
    Parameters:
    featureVector - is an array of feature values
  - DenseVector
```
public DenseVector(float[] featureVector)
```
    Initializing constructor.
    
    Parameters:
    featureVector - is an array of feature values
  - DenseVector
```
public DenseVector(org.ejml.data.DenseMatrix64F featureVector)
```
    Initializing constructor.
    
    Parameters:
    featureVector - is an array of feature values in the EJML format
- Method Detail
  - setDataFromText
```
public void setDataFromText(String representationDescription)
```
    Description copied from interface: Representation
    
    Initializes a Representation using its textual description provided in representationDescription
    
    Specified by:
    
    setDataFromText in interface Representation
    
    Parameters:
    representationDescription - the textual description of the representation to be initialized
  - setFeatureValues
```
public void setFeatureValues(float[] featureValues)
```
    Sets the feature values.
    
    Parameters:
    featureValues - is an array of feature values
  - setFeatureValues
```
public void setFeatureValues(org.ejml.data.DenseMatrix64F featureVector)
```
    Sets the feature values.
    
    Parameters:
    featureVector - is an array of feature values in the EJML format
  - getFeatureValues
```
public org.ejml.data.DenseMatrix64F getFeatureValues()
```
    Returns the feature values in the EJML format
    
    Returns:
    the feature values
  - getFeatureValue
```
public float getFeatureValue(int featureIndex)
```
    Returns the feature value of the featureIndex-th element
    
    Parameters:
    featureIndex - the index of the feature whose value must be returned
    
    Returns:
    the value of the feature
  - getNumberOfFeatures
```
public int getNumberOfFeatures()
```
    Returns the number of featuresValues
    
    Returns:
    the number of featuresValues
  - equals
```
public boolean equals(Object featureVector)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - normalize
```
public void normalize()
```
    Description copied from interface: Normalizable
    
    Scales the representation in order to have a unit norm in the explicit feature space
    
    Specified by:
    
    normalize in interface Normalizable
  - innerProduct
```
public float innerProduct(Vector vector)
```
    Description copied from interface: Vector
    
    Returns the dot product between this vector and vector
    
    Specified by:
    
    innerProduct in interface Vector
    
    Returns:
    the dot product
  - scale
```
public void scale(float coeff)
```
    Description copied from interface: Normalizable
    
    Multiplies each element of this representation by coeff
    
    Specified by:
    
    scale in interface Normalizable
    
    Parameters:
    coeff - the scaling factor
  - add
```
public void add(Vector vector)
```
    Description copied from interface: Vector
    
    Add a vector to this vector
    
    Specified by:
    
    add in interface Vector
    
    Parameters:
    vector - the vector to be added
  - add
```
public void add(float coeff,
       Vector vector)
```
    Description copied from interface: Vector
    
    Add a vector multiplied by coeff to this vector
    
    Specified by:
    
    add in interface Vector
    
    Parameters:
    coeff - the vector coefficient
    vector - the vector to be added
  - add
```
public void add(float coeff,
       float vectorCoeff,
       Vector vector)
```
    Description copied from interface: Vector
    
    Add a vector multiplied by vectorCoeff to this vector multiplied by
    
    Specified by:
    
    add in interface Vector
    
    Parameters:
    coeff - the coefficient of this vector
    vectorCoeff - the vector coefficient
    vector - the vector to be added
  - getZeroVector
```
public Vector getZeroVector()
```
    Description copied from interface: Vector
    
    Returns a vector whose values are all 0. The returned vector has the same dimensions of this
    
    Specified by:
    
    getZeroVector in interface Vector
    
    Returns:
    a zero vector
  - getTextFromData
```
public String getTextFromData()
```
    Description copied from interface: Representation
    
    Returns a textual representation of the data stored in this representation
    
    Specified by:
    
    getTextFromData in interface Representation
    
    Returns:
    a textual representation of the data stored in this representation
  - getSquaredNorm
```
public float getSquaredNorm()
```
    Description copied from interface: Normalizable
    
    Returns the squared norm of this vector
    
    Specified by:
    
    getSquaredNorm in interface Normalizable
    
    Returns:
    the squared norm

Class DenseVector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DenseVector

DenseVector

DenseVector

Method Detail

setDataFromText

setFeatureValues

setFeatureValues

getFeatureValues

getFeatureValue

getNumberOfFeatures

equals

toString

normalize

innerProduct

scale

add

add

add

getZeroVector

getTextFromData

getSquaredNorm