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

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

Direct Known Subclasses:: AbstractMTJVector, DenseVector, SparseVector

@CodeReview(reviewer="Kevin R. Dixon",date="2008-02-27",changesNeeded=false,comments={"Minor changes to formatting and documentation for equals().","Otherwise, looks good."}) @CodeReview(reviewer="Jonathan McClain",date="2006-05-16",changesNeeded=false,comments="Added some documentation and other minor changes. Looks ok.")
public abstract class AbstractVector
extends AbstractVectorSpace<Vector,VectorEntry>
implements Vector

Abstract implementation of some of the Vector interface, in a storage-free manner

Since:: 1.0
Author:: Kevin R. Dixon, Justin Basilico
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
Modifier and Type Field and Description

static java.lang.String DEFAULT_DELIMITER
The default delimiter for a vector.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_DELIMITER` The default delimiter for a vector.

Constructor Summary

Constructors
Constructor and Description

AbstractVector()

Constructors
Constructor and Description
`AbstractVector()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assertDimensionalityEquals(int otherDimensionality)` Asserts that the dimensionality of this vector equals the given dimensionality.
`static void`	`assertEqualDimensionality(Vector first, Vector second)` Throws a DimensionalityMismatchException if first.getDimensionality() != second.getDimensionality(), otherwise this function has no effect
`void`	`assertSameDimensionality(Vector other)` Asserts that this vector has the same dimensionality as the given vector.
`boolean`	`checkSameDimensionality(Vector other)` Determines if `this` and `other` have the same number of dimensions (size)
`void`	`convertFromVector(Vector parameters)` Assigns the values in the provided vector into this.
`Vector`	`convertToVector()` Returns this.
`void`	`decrement(int index)` Decrements the value of the given index by 1.
`void`	`decrement(int index, double value)` Decrements the value of the given index by the given value.
`Vector`	`dotDivide(Vector other)` Element-wise division of `this` by `other`.
`void`	`dotDivideEquals(Vector other)` Inline element-wise division of `this` by `other`.
`double`	`dotProduct(Vector other)` The inner product of this vector with the given vector.
`void`	`dotTimesEquals(Vector other)` Inline element-wise multiplication of `this` and `other`
`boolean`	`equals(java.lang.Object other)` Determines if two RingType objects are equal
`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.
`int`	`hashCode()`
`void`	`increment(int index)` Increments the value of the given index by 1.
`void`	`increment(int index, double value)` Increments the value of the given index by the given value.
`void`	`minusEquals(Vector other)` Inline arithmetic subtraction of `other` from `this`
`Matrix`	`outerProduct(Vector other)` Computes the outer matrix product between the two vectors
`void`	`plusEquals(Vector other)` Inline arithmetic addition of `this` and `other`
`void`	`scaledPlusEquals(double scaleFactor, Vector other)` Inline arithmetic addition of `this` and `other` after element-wise scaling of `other` by `scaleFactor`.
`Vector`	`stack(Vector other)` Stacks "other" below "this" and returns the stacked Vector
`Vector`	`times(Matrix matrix)` Premultiplies the matrix by the vector "this"
`double[]`	`toArray()` Converts this vector to a new array of doubles, in the same order as they are in the vector.
`java.lang.String`	`toString()` Converts a vector to a string that consists of each value in the vector
`java.lang.String`	`toString(java.text.NumberFormat format)` Converts the vector to a `String`, using the given formatter.
`java.lang.String`	`toString(java.text.NumberFormat format, java.lang.String delimiter)` Converts the vector to a `String`, using the given formatter and delimiter.
`Vector`	`transform(UnivariateScalarFunction function)` Applies the given function to each of the elements of this vector and returns a new vector with the result.
`Vector`	`transform(Vector.IndexValueTransform function)` Applies the given function to each of the elements of this vector and returns a new vector with the result.
`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.
`Vector`	`transformNonZeros(UnivariateScalarFunction function)` Applies the given function to each of the non-zero elements of this vector and returns a new vector with the result.
`Vector`	`transformNonZeros(Vector.IndexValueTransform function)` Applies the given function to each of the non-zero elements of this vector and returns a new vector with 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.
`java.util.List<java.lang.Double>`	`valuesAsList()` Gets a view of this vector as a list.

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

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

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

Methods inherited from interface gov.sandia.cognition.math.matrix.Vector
clone, countNonZeros, get, getDimensionality, getElement, getEntryCount, getVectorFactory, isSparse, set, setElement, subVector

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

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

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

- Field Detail
  - DEFAULT_DELIMITER
```
public static final java.lang.String DEFAULT_DELIMITER
```
    The default delimiter for a vector.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractVector
```
public AbstractVector()
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object other)
```
    Description copied from interface: Ring
    
    Determines if two RingType objects are equal
    
    Specified by:
    
    equals in interface Ring<Vector>
    
    Overrides:
    
    equals in class AbstractVectorSpace<Vector,VectorEntry>
    
    Parameters:
    
    other - RingType to compare against this
    
    Returns:
    
    True if the two objects are equal, false otherwise
  - 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 AbstractVectorSpace<Vector,VectorEntry>
    
    Parameters:
    
    other - RingType to compare against this
    
    effectiveZero - tolerance threshold for element-wise equality
    
    Returns:
    
    True if the two objects are equal, false otherwise
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - checkSameDimensionality
```
public boolean checkSameDimensionality(Vector other)
```
    Description copied from interface: Vector
    
    Determines if this and other have the same number of dimensions (size)
    
    Specified by:
    
    checkSameDimensionality in interface Vector
    
    Parameters:
    
    other - vector to compare to
    
    Returns:
    
    true iff this.getDimensionality() == other.getDimensionality(), false otherwise
  - assertSameDimensionality
```
public void assertSameDimensionality(Vector other)
```
    Description copied from interface: Vector
    
    Asserts that this vector has the same dimensionality as the given vector. If this assertion fails, a DimensionalityMismatchException is thrown.
    
    Specified by:
    
    assertSameDimensionality in interface Vector
    
    Parameters:
    
    other - The other vector to compare to.
  - assertDimensionalityEquals
```
public void assertDimensionalityEquals(int otherDimensionality)
```
    Description copied from interface: Vector
    
    Asserts that the dimensionality of this vector equals the given dimensionality. If this assertion fails, a DimensionalityMismatchException is thrown.
    
    Specified by:
    
    assertDimensionalityEquals in interface Vector
    
    Parameters:
    
    otherDimensionality - The dimensionality of the.
  - assertEqualDimensionality
```
public static void assertEqualDimensionality(Vector first,
                                             Vector second)
```
    Throws a DimensionalityMismatchException if first.getDimensionality() != second.getDimensionality(), otherwise this function has no effect
    
    Parameters:
    
    first - first vector to consider
    
    second - second vector to consider
  - plusEquals
```
public void plusEquals(Vector other)
```
    Description copied from interface: Ring
    
    Inline arithmetic addition of this and other
    
    Specified by:
    
    plusEquals in interface Ring<Vector>
    
    Parameters:
    
    other - object to add to this
  - minusEquals
```
public void minusEquals(Vector other)
```
    Description copied from interface: Ring
    
    Inline arithmetic subtraction of other from this
    
    Specified by:
    
    minusEquals in interface Ring<Vector>
    
    Parameters:
    
    other - object to subtract from this
  - dotTimesEquals
```
public void dotTimesEquals(Vector other)
```
    Description copied from interface: Ring
    
    Inline element-wise multiplication of this and other
    
    Specified by:
    
    dotTimesEquals in interface Ring<Vector>
    
    Parameters:
    
    other - elements of other will be multiplied to the corresponding elements of this
  - scaledPlusEquals
```
public void scaledPlusEquals(double scaleFactor,
                             Vector other)
```
    Description copied from interface: Ring
    
    Inline arithmetic addition of this and other after element-wise scaling of other by scaleFactor. If this is x, other is y, and scaleFactor is a, then this method is equivalent to x += a * y. It is typically a more efficient way of doing this.plusEquals(other.scale(scaleFactor)) since it can avoid intermediate object creation.
    
    Specified by:
    
    scaledPlusEquals in interface Ring<Vector>
    
    Parameters:
    
    scaleFactor - The scale factor to multiply by the elements of other before adding to the elements of this.
    
    other - Object to scale and then add to this.
  - dotProduct
```
public double dotProduct(Vector other)
```
    Description copied from interface: VectorSpace
    
    The inner product of this vector with the given vector. That is, the sum of each element of this vector times the corresponding element in the other vector. The same as dot.
    
    Specified by:
    
    dotProduct in interface VectorSpace<Vector,VectorEntry>
    
    Parameters:
    
    other - The Vector with which to compute the dot product with this. Must have the same dimensionality as this.
    
    Returns:
    
    The dot product. The value is between 0 and Infinity.
  - 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>
    
    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)
  - times
```
public Vector times(Matrix matrix)
```
    Description copied from interface: Vector
    
    Premultiplies the matrix by the vector "this"
    
    Specified by:
    
    times in interface Vector
    
    Parameters:
    
    matrix - Matrix to premultiply by "this", must have the same number of rows as the dimensionality of "this"
    
    Returns:
    
    Vector of dimension equal to the number of columns of "matrix"
  - outerProduct
```
public Matrix outerProduct(Vector other)
```
    Description copied from interface: Vector
    
    Computes the outer matrix product between the two vectors
    
    Specified by:
    
    outerProduct in interface Vector
    
    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
  - dotDivide
```
public Vector dotDivide(Vector other)
```
    Description copied from interface: Vector
    
    Element-wise division of this by other. Note that if other has zero elements the result will contain NaN values.
    
    Specified by:
    
    dotDivide in interface Vector
    
    Parameters:
    
    other - The other ring whose elements will divide into this one.
    
    Returns:
    
    A new ring of equal size whose elements are equal to the corresponding element in this divided by the element in other.
  - dotDivideEquals
```
public void dotDivideEquals(Vector other)
```
    Description copied from interface: Vector
    
    Inline element-wise division of this by other. Note that if other has zero elements this will contain NaN values.
    
    Specified by:
    
    dotDivideEquals in interface Vector
    
    Parameters:
    
    other - The other vector whose elements will divide into this one.
  - transform
```
public Vector transform(UnivariateScalarFunction function)
```
    Description copied from interface: Vector
    
    Applies the given function to each of the elements of this vector and returns a new vector with the result. Note that this is a dense operation where zero elements will be passed to the function.
    
    Specified by:
    
    transform in interface Vector
    
    Parameters:
    
    function - The function from double to double to apply.
    
    Returns:
    
    A new vector whose elements represent the result of applying the function to corresponding element in this vector.
  - transform
```
public Vector transform(Vector.IndexValueTransform function)
```
    Description copied from interface: Vector
    
    Applies the given function to each of the elements of this vector and returns a new vector with the result. Note that this is a dense operation where zero elements will be passed to the function.
    
    Specified by:
    
    transform in interface Vector
    
    Parameters:
    
    function - The function from index and value to double to apply.
    
    Returns:
    
    A new vector whose elements represent the result of applying the function to corresponding element in this vector.
  - 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
    
    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
    
    Parameters:
    
    function - The function from index and value to double to apply.
  - transformNonZeros
```
public Vector transformNonZeros(UnivariateScalarFunction function)
```
    Description copied from interface: Vector
    
    Applies the given function to each of the non-zero elements of this vector and returns a new vector with the result.
    
    Specified by:
    
    transformNonZeros in interface Vector
    
    Parameters:
    
    function - The function from double to double to apply to the non-zero elements.
    
    Returns:
    
    A new vector whose elements represent the result of applying the function to the corresponding element in this vector, except for zeros, which are exactly the same as in this vector.
  - transformNonZeros
```
public Vector transformNonZeros(Vector.IndexValueTransform function)
```
    Description copied from interface: Vector
    
    Applies the given function to each of the non-zero elements of this vector and returns a new vector with the result.
    
    Specified by:
    
    transformNonZeros in interface Vector
    
    Parameters:
    
    function - The function from index and value to double to apply to non-zero elements.
    
    Returns:
    
    A new vector whose elements represent the result of applying the function to the corresponding element in this vector, except for zeros, which are exactly the same as in this vector.
  - 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
    
    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
    
    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
    
    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
    
    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
    
    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.
  - increment
```
public void increment(int index)
```
    Description copied from interface: Vector
    
    Increments the value of the given index by 1.
    
    Specified by:
    
    increment in interface Vector
    
    Parameters:
    
    index - The index of the dimension to increment.
  - increment
```
public void increment(int index,
                      double value)
```
    Description copied from interface: Vector
    
    Increments the value of the given index by the given value.
    
    Specified by:
    
    increment in interface Vector
    
    Parameters:
    
    index - The index of the dimension to increment.
    
    value - The value to add.
  - decrement
```
public void decrement(int index)
```
    Description copied from interface: Vector
    
    Decrements the value of the given index by 1.
    
    Specified by:
    
    decrement in interface Vector
    
    Parameters:
    
    index - The index of the dimension to decrement.
  - decrement
```
public void decrement(int index,
                      double value)
```
    Description copied from interface: Vector
    
    Decrements the value of the given index by the given value.
    
    Specified by:
    
    decrement in interface Vector
    
    Parameters:
    
    index - The index of the dimension to decrement.
    
    value - The value to subtract.
  - stack
```
public Vector stack(Vector other)
```
    Description copied from interface: Vector
    
    Stacks "other" below "this" and returns the stacked Vector
    
    Specified by:
    
    stack in interface Vector
    
    Parameters:
    
    other - Vector to stack below "this"
    
    Returns:
    
    stacked Vector
  - toArray
```
public double[] toArray()
```
    Description copied from interface: Vector
    
    Converts this vector to a new array of doubles, in the same order as they are in the vector. The returned will be safe in that no references are maintained by this vector.
    
    Specified by:
    
    toArray in interface Vector
    
    Returns:
    
    The vector as a dense array of doubles. Its length will be equal to the dimensionality of the vector.
  - valuesAsList
```
public java.util.List<java.lang.Double> valuesAsList()
```
    Description copied from interface: Vector
    
    Gets a view of this vector as a list. The list is the same size as this array.
    
    Specified by:
    
    valuesAsList in interface Vector
    
    Returns:
    
    A list representing this array.
  - toString
```
public java.lang.String toString()
```
    Converts a vector to a string that consists of each value in the vector
    
    Specified by:
    
    toString in interface Vector
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String containing the elements of this
  - toString
```
public java.lang.String toString(java.text.NumberFormat format)
```
    Description copied from interface: Vector
    
    Converts the vector to a String, using the given formatter.
    
    Specified by:
    
    toString in interface Vector
    
    Parameters:
    
    format - The number format to use.
    
    Returns:
    
    The string representation of the vector.
  - toString
```
public java.lang.String toString(java.text.NumberFormat format,
                                 java.lang.String delimiter)
```
    Description copied from interface: Vector
    
    Converts the vector to a String, using the given formatter and delimiter.
    
    Specified by:
    
    toString in interface Vector
    
    Parameters:
    
    format - The number format to use.
    
    delimiter - The delimiter to use.
    
    Returns:
    
    The string representation of the vector.
  - convertToVector
```
public Vector convertToVector()
```
    Returns this.
    
    Specified by:
    
    convertToVector in interface Vectorizable
    
    Returns:
    
    This.
  - convertFromVector
```
public void convertFromVector(Vector parameters)
```
    Assigns the values in the provided vector into this.
    
    Specified by:
    
    convertFromVector in interface Vectorizable
    
    Parameters:
    
    parameters - The vector to convert.

Class AbstractVector

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

Constructor Summary

Method Summary

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

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

Field Detail

DEFAULT_DELIMITER

Constructor Detail

AbstractVector

Method Detail

equals

equals

hashCode

checkSameDimensionality

assertSameDimensionality

assertDimensionalityEquals

assertEqualDimensionality

plusEquals

minusEquals

dotTimesEquals

scaledPlusEquals

dotProduct

euclideanDistanceSquared

times

outerProduct

dotDivide

dotDivideEquals

transform

transform

transformEquals

transformEquals

transformNonZeros

transformNonZeros

transformNonZerosEquals

transformNonZerosEquals

forEachElement

forEachEntry

forEachNonZero

increment

increment

decrement

decrement

stack

toArray

valuesAsList

toString

toString

toString

convertToVector

convertFromVector