DenseVector (Cognitive Foundry)

java.lang.Object
- gov.sandia.cognition.util.AbstractCloneableSerializable
- - gov.sandia.cognition.math.AbstractRing<VectorType>
  - - gov.sandia.cognition.math.matrix.AbstractVectorSpace<Vector,VectorEntry>
    - - gov.sandia.cognition.math.matrix.AbstractVector
      - gov.sandia.cognition.math.matrix.mtj.AbstractMTJVector
        
        gov.sandia.cognition.math.matrix.mtj.DenseVector

All Implemented Interfaces:: Vector, Vectorizable, VectorSpace<Vector,VectorEntry>, Ring<Vector>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<VectorEntry>

Direct Known Subclasses:: Vector1, Vector2, Vector3

@CodeReview(reviewer="Jonathan McClain",
            date="2006-05-19",
            changesNeeded=true,
            comments="Comments marked with / / /",
            response=@CodeReviewResponse(respondent="Kevin R. Dixon",date="2006-05-22",moreChangesNeeded=false,comments="Fixed comments for writeObject() and readObject()"))
 @PublicationReference(author="Bjorn-Ove Heimsund",
                      title="MTJ DenseVector javadoc",
                      type=WebPage,
                      year=2006,
                      url="http://ressim.berlios.de/doc/no/uib/cipr/matrix/DenseVector.html")
public class DenseVector
extends AbstractMTJVector
implements java.io.Serializable

A generally useful vector representation that allocates a fixed-size underlying vector, based on MTJ's DenseVector

Since:: 1.0
Author:: Kevin R. Dixon
See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface gov.sandia.cognition.math.matrix.Vector
  Vector.IndexValueConsumer, Vector.IndexValueTransform
- Nested classes/interfaces inherited from interface gov.sandia.cognition.math.matrix.VectorSpace
  VectorSpace.Entry

Field Summary
- Fields inherited from class gov.sandia.cognition.math.matrix.AbstractVector
  DEFAULT_DELIMITER

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DenseVector(AbstractMTJVector vector)` Copy constructor
`protected`	`DenseVector(DenseVector vector)` Creates a new instance of DenseVector
`protected`	`DenseVector(no.uib.cipr.matrix.DenseVector internalVector)` Creates a new instance of DenseVector
`protected`	`DenseVector(double... values)` Creates a new instance of DenseVector
`protected`	`DenseVector(int numDimensions)` Creates a new instance of DenseVector
`protected`	`DenseVector(Vector vector)` Copy constructor for DenseVector
`protected`	`DenseVector(VectorReader reader)` Creates a new instance of DenseVector

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`countNonZeros()` Counts the number of non-zero entries in the vector.
`boolean`	`equals(Vector other, double effectiveZero)` Determines if two RingType objects are effectively equal
`double`	`euclideanDistanceSquared(Vector other)` Squared Euclidean distance between `this` and `other`, which is the 2-norm between the difference of the Vectors
`void`	`forEachElement(Vector.IndexValueConsumer consumer)` Applies the given function to each element in this vector.
`void`	`forEachEntry(Vector.IndexValueConsumer consumer)` Applies the given function to each active entry in this vector.
`void`	`forEachNonZero(Vector.IndexValueConsumer consumer)` Applies the given function to each non-zero entry in this vector.
`double`	`get(int index)` Gets the value of element of the vector at the zero-based index.
`double[]`	`getArray()` Returns the underlying double array for this DenseVector
`int`	`getDimensionality()` Returns the number of elements in the Vector
`double`	`getElement(int index)` Gets the zero-based indexed element from the Vector
`int`	`getEntryCount()` Gets the number of active entries in the vector.
`double`	`getMaxValue()` The maximum value associated with any key in the vector.
`double`	`getMinValue()` The minimum value associated with any key in the vector.
`VectorFactory<?>`	`getVectorFactory()` Gets a vector factory associated with this kind of vector.
`boolean`	`isSparse()` Returns true if this vector has a potentially sparse underlying structure.
`DenseMatrix`	`outerProduct(AbstractMTJVector other)` Computes the outer matrix product between the two vectors
`void`	`set(int index, double value)` Sets the value for an element at the zero-based index from the vector.
`void`	`setElement(int index, double value)` Sets the zero-based indexed element in the Vector from the specified value
`protected void`	`setInternalVector(no.uib.cipr.matrix.DenseVector internalVector)` Sets the internalVector using MTJ's DenseVector
`protected void`	`setInternalVector(no.uib.cipr.matrix.Vector internalVector)` Setter for internalVector
`DenseVector`	`stack(Vector other)` Stacks "other" below "this" and returns the stacked Vector
`DenseVector`	`subVector(int minIndex, int maxIndex)` Gets a subvector of "this", specified by the inclusive indices
`double`	`sum()` Computes the sum of the elements in the vector.
`void`	`transformEquals(UnivariateScalarFunction function)` Applies the given function to each of the elements of this vector and sets them to the result.
`void`	`transformEquals(Vector.IndexValueTransform function)` Applies the given function to each of the elements of this vector and sets them to the result.
`void`	`transformNonZerosEquals(UnivariateScalarFunction function)` Applies the given function to each of the non-zero elements of this vector and sets them to the result.
`void`	`transformNonZerosEquals(Vector.IndexValueTransform function)` Applies the given function to each of the non-zero elements of this vector and sets them to the result.

Methods inherited from class gov.sandia.cognition.math.matrix.mtj.AbstractMTJVector
clone, dotProduct, dotProduct, dotTimesEquals, getInternalVector, increment, iterator, minusEquals, minusEquals, norm2, norm2Squared, outerProduct, plusEquals, plusEquals, scaledMinusEquals, scaledPlusEquals, scaledPlusEquals, scaleEquals, times, times, zero

Methods inherited from class gov.sandia.cognition.math.matrix.AbstractVector
assertDimensionalityEquals, assertEqualDimensionality, assertSameDimensionality, checkSameDimensionality, convertFromVector, convertToVector, decrement, decrement, dotDivide, dotDivideEquals, equals, hashCode, increment, toArray, toString, toString, toString, transform, transform, transformNonZeros, transformNonZeros, valuesAsList

Methods inherited from class gov.sandia.cognition.math.matrix.AbstractVectorSpace
angle, cosine, dot, euclideanDistance, isUnitVector, isUnitVector, isZero, norm, norm1, normInfinity, unitVector, unitVectorEquals

Methods inherited from class gov.sandia.cognition.math.AbstractRing
dotTimes, isZero, minus, negative, negativeEquals, plus, scale, scaledMinus, scaledMinusEquals, scaledPlus

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

Methods inherited from interface gov.sandia.cognition.math.matrix.VectorSpace
angle, cosine, dot, euclideanDistance, isUnitVector, isUnitVector, norm, norm1, normInfinity, unitVector, unitVectorEquals

Methods inherited from interface gov.sandia.cognition.math.Ring
dotTimes, isZero, isZero, minus, negative, negativeEquals, plus, scale, scaledMinus, scaledMinusEquals, scaledPlus

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - DenseVector
```
protected DenseVector(int numDimensions)
```
    Creates a new instance of DenseVector
    
    Parameters:
    
    numDimensions - Number of dimensions in the Vector
  - DenseVector
```
protected DenseVector(DenseVector vector)
```
    Creates a new instance of DenseVector
    
    Parameters:
    
    vector - Vector from which to populate the elements of this, will not be modified
  - DenseVector
```
protected DenseVector(Vector vector)
```
    Copy constructor for DenseVector
    
    Parameters:
    
    vector - Vector from which to populate the elements of this, will not be modified
  - DenseVector
```
protected DenseVector(AbstractMTJVector vector)
```
    Copy constructor
    
    Parameters:
    
    vector - Vector to copy
  - DenseVector
```
protected DenseVector(double... values)
```
    Creates a new instance of DenseVector
    
    Parameters:
    
    values - The array of values to give the vector
  - DenseVector
```
protected DenseVector(no.uib.cipr.matrix.DenseVector internalVector)
```
    Creates a new instance of DenseVector
    
    Parameters:
    
    internalVector - Internal MTJ-based vector that does the heavy lifting
  - DenseVector
```
protected DenseVector(VectorReader reader)
               throws java.io.IOException
```
    Creates a new instance of DenseVector
    
    Parameters:
    
    reader - takes in information from a java stream
    
    Throws:
    
    java.io.IOException - if the stream is invalid
- Method Detail
  - setInternalVector
```
protected void setInternalVector(no.uib.cipr.matrix.Vector internalVector)
```
    Description copied from class: AbstractMTJVector
    
    Setter for internalVector
    
    Overrides:
    
    setInternalVector in class AbstractMTJVector
    
    Parameters:
    
    internalVector - internal MTJ-based vector that does the heavy lifting
  - setInternalVector
```
protected void setInternalVector(no.uib.cipr.matrix.DenseVector internalVector)
```
    Sets the internalVector using MTJ's DenseVector
    
    Parameters:
    
    internalVector - internal MTJ-based DenseVector
  - getElement
```
public double getElement(int index)
```
    Description copied from interface: Vector
    
    Gets the zero-based indexed element from the Vector
    
    Specified by:
    
    getElement in interface Vector
    
    Overrides:
    
    getElement in class AbstractMTJVector
    
    Parameters:
    
    index - zero-based index
    
    Returns:
    
    zero-based indexed element in the Vector
  - setElement
```
public void setElement(int index,
                       double value)
```
    Description copied from interface: Vector
    
    Sets the zero-based indexed element in the Vector from the specified value
    
    Specified by:
    
    setElement in interface Vector
    
    Overrides:
    
    setElement in class AbstractMTJVector
    
    Parameters:
    
    index - zero-based index
    
    value - value to set the element in the Vector
  - get
```
public double get(int index)
```
    Description copied from interface: Vector
    
    Gets the value of element of the vector at the zero-based index. It throws an ArrayIndexOutOfBoundsException if the index is out of range. It is a convenience method for getElement.
    
    Specified by:
    
    get in interface Vector
    
    Overrides:
    
    get in class AbstractMTJVector
    
    Parameters:
    
    index - The zero-based index. Must be between 0 (inclusive) and the dimensionality of the vector (exclusive).
    
    Returns:
    
    The value at the index in the vector.
  - set
```
public void set(int index,
                double value)
```
    Description copied from interface: Vector
    
    Sets the value for an element at the zero-based index from the vector. It throws an ArrayIndexOutOfBoundsException if the index is out of range. It is a convenience method for setElement.
    
    Specified by:
    
    set in interface Vector
    
    Overrides:
    
    set in class AbstractMTJVector
    
    Parameters:
    
    index - The zero-based index. Must be between 0 (inclusive) and the dimensionality of the vector (exclusive).
    
    value - The value at the index in the vector.
  - getDimensionality
```
public int getDimensionality()
```
    Description copied from interface: Vector
    
    Returns the number of elements in the Vector
    
    Specified by:
    
    getDimensionality in interface Vector
    
    Overrides:
    
    getDimensionality in class AbstractMTJVector
    
    Returns:
    
    number of elements in the Vector
  - equals
```
public boolean equals(Vector other,
                      double effectiveZero)
```
    Description copied from interface: Ring
    
    Determines if two RingType objects are effectively equal
    
    Specified by:
    
    equals in interface Ring<Vector>
    
    Overrides:
    
    equals in class AbstractVector
    
    Parameters:
    
    other - RingType to compare against this
    
    effectiveZero - tolerance threshold for element-wise equality
    
    Returns:
    
    True if the two objects are equal, false otherwise
  - euclideanDistanceSquared
```
public double euclideanDistanceSquared(Vector other)
```
    Description copied from interface: VectorSpace
    
    Squared Euclidean distance between this and other, which is the 2-norm between the difference of the Vectors
    
    Specified by:
    
    euclideanDistanceSquared in interface VectorSpace<Vector,VectorEntry>
    
    Overrides:
    
    euclideanDistanceSquared in class AbstractVector
    
    Parameters:
    
    other - Vector to which to compute the squared distance, must be the same dimension as this
    
    Returns:
    
    this.minus( other ).norm2Squared(), which is [0,\infty)
  - outerProduct
```
public DenseMatrix outerProduct(AbstractMTJVector other)
```
    Description copied from class: AbstractMTJVector
    
    Computes the outer matrix product between the two vectors
    
    Specified by:
    
    outerProduct in class AbstractMTJVector
    
    Parameters:
    
    other - post-multiplied Vector with which to compute the outer product
    
    Returns:
    
    Outer matrix product, which will have dimensions (this.getDimensionality x other.getDimensionality) and WILL BE singular
  - stack
```
public DenseVector stack(Vector other)
```
    Description copied from interface: Vector
    
    Stacks "other" below "this" and returns the stacked Vector
    
    Specified by:
    
    stack in interface Vector
    
    Overrides:
    
    stack in class AbstractVector
    
    Parameters:
    
    other - Vector to stack below "this"
    
    Returns:
    
    stacked Vector
  - subVector
```
public DenseVector subVector(int minIndex,
                             int maxIndex)
```
    Gets a subvector of "this", specified by the inclusive indices
    
    Specified by:
    
    subVector in interface Vector
    
    Parameters:
    
    minIndex - minimum index to get (inclusive)
    
    maxIndex - maximum index to get (inclusive)
    
    Returns:
    
    vector of dimension (maxIndex-minIndex+1)
  - transformEquals
```
public void transformEquals(UnivariateScalarFunction function)
```
    Description copied from interface: Vector
    
    Applies the given function to each of the elements of this vector and sets them to the result.
    
    Specified by:
    
    transformEquals in interface Vector
    
    Overrides:
    
    transformEquals in class AbstractVector
    
    Parameters:
    
    function - The function from double to double to apply.
  - transformEquals
```
public void transformEquals(Vector.IndexValueTransform function)
```
    Description copied from interface: Vector
    
    Applies the given function to each of the elements of this vector and sets them to the result.
    
    Specified by:
    
    transformEquals in interface Vector
    
    Overrides:
    
    transformEquals in class AbstractVector
    
    Parameters:
    
    function - The function from index and value to double to apply.
  - transformNonZerosEquals
```
public void transformNonZerosEquals(UnivariateScalarFunction function)
```
    Description copied from interface: Vector
    
    Applies the given function to each of the non-zero elements of this vector and sets them to the result.
    
    Specified by:
    
    transformNonZerosEquals in interface Vector
    
    Overrides:
    
    transformNonZerosEquals in class AbstractVector
    
    Parameters:
    
    function - The function from double to double to apply to the non-zero elements.
  - transformNonZerosEquals
```
public void transformNonZerosEquals(Vector.IndexValueTransform function)
```
    Description copied from interface: Vector
    
    Applies the given function to each of the non-zero elements of this vector and sets them to the result.
    
    Specified by:
    
    transformNonZerosEquals in interface Vector
    
    Overrides:
    
    transformNonZerosEquals in class AbstractVector
    
    Parameters:
    
    function - The function from index and value to double to apply to non-zero elements.
  - forEachElement
```
public void forEachElement(Vector.IndexValueConsumer consumer)
```
    Description copied from interface: Vector
    
    Applies the given function to each element in this vector. This is a dense operation that includes all values, even on a sparse vector.
    
    Specified by:
    
    forEachElement in interface Vector
    
    Overrides:
    
    forEachElement in class AbstractVector
    
    Parameters:
    
    consumer - The consumer for the entries. It is called for each element in the vector, in order by increasing index.
  - forEachEntry
```
public void forEachEntry(Vector.IndexValueConsumer consumer)
```
    Description copied from interface: Vector
    
    Applies the given function to each active entry in this vector. This can be faster than looping over the entries using an iterator.
    
    Specified by:
    
    forEachEntry in interface Vector
    
    Overrides:
    
    forEachEntry in class AbstractVector
    
    Parameters:
    
    consumer - The consumer for the entries. It is called for each active entry in the vector, in order by increasing index.
  - forEachNonZero
```
public void forEachNonZero(Vector.IndexValueConsumer consumer)
```
    Description copied from interface: Vector
    
    Applies the given function to each non-zero entry in this vector. This can be faster than looping over the entries using an iterator.
    
    Specified by:
    
    forEachNonZero in interface Vector
    
    Overrides:
    
    forEachNonZero in class AbstractVector
    
    Parameters:
    
    consumer - The consumer for the non-zero entries. It is called for each non-zero entry in the vector, in order by increasing index.
  - sum
```
public double sum()
```
    Description copied from interface: VectorSpace
    
    Computes the sum of the elements in the vector.
    
    Specified by:
    
    sum in interface VectorSpace<Vector,VectorEntry>
    
    Overrides:
    
    sum in class AbstractVectorSpace<Vector,VectorEntry>
    
    Returns:
    
    The sum of the elements in the vector.
  - getMinValue
```
public double getMinValue()
```
    Description copied from interface: VectorSpace
    
    The minimum value associated with any key in the vector.
    
    Specified by:
    
    getMinValue in interface VectorSpace<Vector,VectorEntry>
    
    Returns:
    
    The minimum value associated with any key in the vector. If the vector is empty, then Double.POSITIVE_INFINITY is returned.
  - getMaxValue
```
public double getMaxValue()
```
    Description copied from interface: VectorSpace
    
    The maximum value associated with any key in the vector.
    
    Specified by:
    
    getMaxValue in interface VectorSpace<Vector,VectorEntry>
    
    Returns:
    
    The maximum value associated with any key in the vector. If the vector is empty, then Double.NEGATIVE_INFINITY is returned.
  - getArray
```
public double[] getArray()
```
    Returns the underlying double array for this DenseVector
    
    Returns:
    
    internal double array for this DenseVector
  - isSparse
```
public boolean isSparse()
```
    Description copied from interface: Vector
    
    Returns true if this vector has a potentially sparse underlying structure. This can indicate that it is faster to only process the non-zero elements rather than to do dense operations on it. Of course, even with a sparse structure, there may be no zero elements or conversely even with a non-sparse (dense) structure there may be many zero elements.
    
    Specified by:
    
    isSparse in interface Vector
    
    Returns:
    
    True if the vector has a potentially sparse structure. Otherwise, false.
  - getVectorFactory
```
public VectorFactory<?> getVectorFactory()
```
    Description copied from interface: Vector
    
    Gets a vector factory associated with this kind of vector.
    
    Specified by:
    
    getVectorFactory in interface Vector
    
    Returns:
    
    The associated factory.
  - getEntryCount
```
public int getEntryCount()
```
    Description copied from interface: Vector
    
    Gets the number of active entries in the vector. Must be between zero and the dimensionality.
    
    Specified by:
    
    getEntryCount in interface Vector
    
    Returns:
    
    The number of active entries in the vector.
  - countNonZeros
```
public int countNonZeros()
```
    Description copied from interface: Vector
    
    Counts the number of non-zero entries in the vector. Must be between zero and the dimensionality. This operation may require evaluating all entries in the vector based on the implementation.
    
    Specified by:
    
    countNonZeros in interface Vector
    
    Returns:
    
    The number of non-zero values in the vector.

Class DenseVector

Nested Class Summary

Nested classes/interfaces inherited from interface gov.sandia.cognition.math.matrix.Vector

Nested classes/interfaces inherited from interface gov.sandia.cognition.math.matrix.VectorSpace

Field Summary

Fields inherited from class gov.sandia.cognition.math.matrix.AbstractVector

Constructor Summary

Method Summary

Methods inherited from class gov.sandia.cognition.math.matrix.mtj.AbstractMTJVector

Methods inherited from class gov.sandia.cognition.math.matrix.AbstractVector

Methods inherited from class gov.sandia.cognition.math.matrix.AbstractVectorSpace

Methods inherited from class gov.sandia.cognition.math.AbstractRing

Methods inherited from class java.lang.Object

Methods inherited from interface gov.sandia.cognition.math.matrix.VectorSpace

Methods inherited from interface gov.sandia.cognition.math.Ring

Methods inherited from interface java.lang.Iterable

Constructor Detail

DenseVector

DenseVector

DenseVector

DenseVector

DenseVector

DenseVector

DenseVector

Method Detail

setInternalVector

setInternalVector

getElement

setElement

get

set

getDimensionality

equals

euclideanDistanceSquared

outerProduct

stack

subVector

transformEquals

transformEquals

transformNonZerosEquals

transformNonZerosEquals

forEachElement

forEachEntry

forEachNonZero

sum

getMinValue

getMaxValue

getArray

isSparse

getVectorFactory

getEntryCount

countNonZeros