Vector (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- de.lmu.ifi.dbs.elki.math.linearalgebra.Vector

All Implemented Interfaces:

FeatureVector<Number>, NumberVector, SpatialComparable

Direct Known Subclasses:

Centroid
```
public class Vector
extends Object
implements NumberVector
```
A mathematical vector object, along with mathematical operations.

Author:

Elke Achtert

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`Vector.Factory` Vector factory for Vectors.
`static class`	`Vector.ShortSerializer` Serialization class for dense double vectors with up to `Short.MAX_VALUE` dimensions, by using a short for storing the dimensionality.
`static class`	`Vector.SmallSerializer` Serialization class for dense double vectors with up to 127 dimensions, by using a byte for storing the dimensionality.
`protected static class`	`Vector.VariableSerializer` Serialization class for variable dimensionality by using VarInt encoding.

Field Summary

Fields
Modifier and Type	Field and Description
`static ByteBufferSerializer<Vector>`	`BYTE_SERIALIZER` Serializer for up to 127 dimensions.
`protected double[]`	`elements` Array for internal storage of elements.
`private static String`	`ERR_DIMENSIONS` Error message (in assertions!)
`static String`	`ERR_MATRIX_INNERDIM` Error message (in assertions!)
`static String`	`ERR_VEC_DIMENSIONS` Error message (in assertions!)
`static Vector.Factory`	`FACTORY` Static vector factory.
`static ByteBufferSerializer<Vector>`	`SHORT_SERIALIZER` Serializer for up to 2^15-1 dimensions.
`static ByteBufferSerializer<Vector>`	`VARIABLE_SERIALIZER` Serializer using varint encoding.

Constructor Summary

Constructors
Constructor and Description

Vector(double... values)
Construct a vector from a given array.

Vector(int m)
Constructor

Constructors
Constructor and Description
`Vector(double... values)` Construct a vector from a given array.
`Vector(int m)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`byte`	`byteValue(int dimension)` Returns the value in the specified dimension as byte.
`Vector`	`clone()`
`Vector`	`copy()` Returns a copy of this vector.
`Vector`	`cross3D(Vector other)` Cross product for 3d vectors, i.e.
`double`	`doubleValue(int dimension)` Returns the value in the specified dimension as double.
`boolean`	`equals(Object obj)`
`double`	`euclideanLength()` Returns the length of this vector.
`float`	`floatValue(int dimension)` Returns the value in the specified dimension as float.
`double`	`get(int i)` Returns the value at the specified row.
`double[]`	`getArrayCopy()` Copy the internal two-dimensional array.
`double[]`	`getArrayRef()` Access the internal two-dimensional array.
`Vector`	`getColumnVector()` Returns a Vector representing in one column and `getDimensionality()` rows the values of this NumberVector of V.
`int`	`getDimensionality()` Returns the dimensionality of this vector.
`double`	`getMax(int dimension)` Returns the maximum coordinate at the specified dimension.
`double`	`getMin(int dimension)` Returns the minimum coordinate at the specified dimension.
`Double`	`getValue(int dimension)` Deprecated.
`int`	`hashCode()`
`int`	`intValue(int dimension)` Returns the value in the specified dimension as int.
`long`	`longValue(int dimension)` Returns the value in the specified dimension as long.
`Vector`	`minus(Vector v)` Returns this vector minus the specified vector v.
`Vector`	`minusEquals(double d)` Subtract a constant value from all dimensions.
`Vector`	`minusEquals(Vector b)` a = a - b.
`Vector`	`minusTimes(Vector v, double s)` Returns this vector minus the specified vector v times s.
`Vector`	`minusTimesEquals(Vector b, double s)` a = a - s * b.
`Vector`	`normalize()` Normalizes this vector to the length of 1.0.
`Vector`	`plus(Vector v)` Returns a new vector which is the result of this vector plus the specified vector.
`Vector`	`plusEquals(double d)` Add a constant value to all dimensions.
`Vector`	`plusEquals(Vector b)` a = a + b.
`Vector`	`plusTimes(Vector v, double s)` Returns a new vector which is the result of this vector plus the specified vector times the given factor.
`Vector`	`plusTimesEquals(Vector b, double s)` a = a + s * b.
`Vector`	`projection(Matrix v)` Projects this row vector into the subspace formed by the specified matrix v.
`static Vector`	`randomNormalizedVector(int dimensionality)` Returns a randomly created vector of length 1.0.
`Vector`	`rotate90Equals()` Rotate vector by 90 degrees.
`Vector`	`set(int i, double value)` Sets the value at the specified row.
`Vector`	`set(Vector v)` Copy the values of another vector into the current vector.
`void`	`setZero()` Reset the Vector to 0.
`short`	`shortValue(int dimension)` Returns the value in the specified dimension as short.
`double`	`squaredEuclideanLength()` Returns the squared length of this vector: v^T * v.
`Vector`	`times(double s)` Returns a new vector which is the result of this vector multiplied by the specified scalar.
`Matrix`	`times(Matrix B)` Linear algebraic matrix multiplication, A * B.
`Vector`	`timesEquals(double s)` Multiply a matrix by a scalar in place, A = s*A.
`Matrix`	`timesTranspose(Matrix B)` Linear algebraic matrix multiplication, A * B^T.
`Matrix`	`timesTranspose(Vector B)` Linear algebraic matrix multiplication, A * B^T.
`String`	`toString()` Returns a string representation of this vector.
`String`	`toStringNoWhitespace()` Returns a string representation of this vector without adding extra whitespace.
`Matrix`	`transposeTimes(Matrix B)` Linear algebraic matrix multiplication, A^T * B.
`double`	`transposeTimes(Vector B)` Linear algebraic matrix multiplication, A^T * B.
`double`	`transposeTimesTimes(Matrix B, Vector c)` Linear algebraic matrix multiplication, a^T * B * c.
`static Vector`	`unitVector(int dimensionality, int i)` Returns the ith unit vector of the specified dimensionality.

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

- Field Detail
  - FACTORY
```
public static final Vector.Factory FACTORY
```
    Static vector factory.
  - BYTE_SERIALIZER
```
public static final ByteBufferSerializer<Vector> BYTE_SERIALIZER
```
    Serializer for up to 127 dimensions.
  - SHORT_SERIALIZER
```
public static final ByteBufferSerializer<Vector> SHORT_SERIALIZER
```
    Serializer for up to 2^15-1 dimensions.
  - VARIABLE_SERIALIZER
```
public static final ByteBufferSerializer<Vector> VARIABLE_SERIALIZER
```
    Serializer using varint encoding.
  - elements
```
protected final double[] elements
```
    Array for internal storage of elements.
  - ERR_VEC_DIMENSIONS
```
public static final String ERR_VEC_DIMENSIONS
```
    Error message (in assertions!) when vector dimensionalities do not agree.
    
    See Also:
    Constant Field Values
  - ERR_MATRIX_INNERDIM
```
public static final String ERR_MATRIX_INNERDIM
```
    Error message (in assertions!) when matrix dimensionalities do not agree.
    
    See Also:
    Constant Field Values
  - ERR_DIMENSIONS
```
private static final String ERR_DIMENSIONS
```
    Error message (in assertions!) when dimensionalities do not agree.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Vector
```
public Vector(double... values)
```
    Construct a vector from a given array.
    
    Parameters:
    values - array of doubles
  - Vector
```
public Vector(int m)
```
    Constructor
    
    Parameters:
    m - the number of rows
- Method Detail
  - randomNormalizedVector
```
public static final Vector randomNormalizedVector(int dimensionality)
```
    Returns a randomly created vector of length 1.0.
    
    Parameters:
    dimensionality - dimensionality
    
    Returns:
    the dimensionality of the vector
  - unitVector
```
public static final Vector unitVector(int dimensionality,
                int i)
```
    Returns the ith unit vector of the specified dimensionality.
    
    Parameters:
    dimensionality - the dimensionality of the vector
    i - the index
    
    Returns:
    the ith unit vector of the specified dimensionality
  - copy
```
public final Vector copy()
```
    Returns a copy of this vector.
    
    Returns:
    a copy of this vector
  - clone
```
public Vector clone()
```
    Overrides:
    
    clone in class Object
  - getArrayRef
```
public final double[] getArrayRef()
```
    Access the internal two-dimensional array.
    
    Returns:
    Pointer to the two-dimensional array of matrix elements.
  - getArrayCopy
```
public final double[] getArrayCopy()
```
    Copy the internal two-dimensional array.
    
    Returns:
    Two-dimensional array copy of matrix elements.
  - getDimensionality
```
public final int getDimensionality()
```
    Returns the dimensionality of this vector.
    
    Specified by:
    
    getDimensionality in interface FeatureVector<Number>
    
    Specified by:
    
    getDimensionality in interface SpatialComparable
    
    Returns:
    the dimensionality of this vector
  - get
```
public final double get(int i)
```
    Returns the value at the specified row.
    
    Parameters:
    i - the row index
    
    Returns:
    the value at row i
  - set
```
public final Vector set(int i,
         double value)
```
    Sets the value at the specified row.
    
    Parameters:
    i - the row index
    value - the value to be set
    
    Returns:
    the modified vector
  - set
```
public final Vector set(Vector v)
```
    Copy the values of another vector into the current vector.
    
    Parameters:
    v - Other vector
    
    Returns:
    This vector
  - plus
```
public final Vector plus(Vector v)
```
    Returns a new vector which is the result of this vector plus the specified vector.
    
    Parameters:
    v - the vector to be added
    
    Returns:
    the resulting vector
  - plusTimes
```
public final Vector plusTimes(Vector v,
               double s)
```
    Returns a new vector which is the result of this vector plus the specified vector times the given factor.
    
    Parameters:
    v - the vector to be added
    s - the scalar
    
    Returns:
    the resulting vector
  - plusEquals
```
public final Vector plusEquals(Vector b)
```
    a = a + b.
    
    Parameters:
    b - another vector
    
    Returns:
    a + b in this vector
  - plusTimesEquals
```
public final Vector plusTimesEquals(Vector b,
                     double s)
```
    a = a + s * b.
    
    Parameters:
    b - another vector
    s - Scalar
    
    Returns:
    a + s * b in this vector
  - plusEquals
```
public final Vector plusEquals(double d)
```
    Add a constant value to all dimensions.
    
    Parameters:
    d - Value to add
    
    Returns:
    Modified vector
  - minus
```
public final Vector minus(Vector v)
```
    Returns this vector minus the specified vector v.
    
    Parameters:
    v - the vector to be subtracted from this vector
    
    Returns:
    this vector minus the specified vector v
  - minusTimes
```
public final Vector minusTimes(Vector v,
                double s)
```
    Returns this vector minus the specified vector v times s.
    
    Parameters:
    v - the vector to be subtracted from this vector
    s - the scaling factor
    
    Returns:
    this vector minus the specified vector v
  - minusEquals
```
public final Vector minusEquals(Vector b)
```
    a = a - b.
    
    Parameters:
    b - another vector
    
    Returns:
    a - b in this vector
  - minusTimesEquals
```
public final Vector minusTimesEquals(Vector b,
                      double s)
```
    a = a - s * b.
    
    Parameters:
    b - another vector
    s - Scalar
    
    Returns:
    a - s * b in this vector
  - minusEquals
```
public final Vector minusEquals(double d)
```
    Subtract a constant value from all dimensions.
    
    Parameters:
    d - Value to subtract
    
    Returns:
    Modified vector
  - times
```
public final Vector times(double s)
```
    Returns a new vector which is the result of this vector multiplied by the specified scalar.
    
    Parameters:
    s - the scalar to be multiplied
    
    Returns:
    the resulting vector
  - timesEquals
```
public final Vector timesEquals(double s)
```
    Multiply a matrix by a scalar in place, A = s*A.
    
    Parameters:
    s - scalar
    
    Returns:
    replace A by s*A
  - times
```
public final Matrix times(Matrix B)
```
    Linear algebraic matrix multiplication, A * B.
    
    Parameters:
    B - another matrix
    
    Returns:
    Matrix product, A * B
  - transposeTimes
```
public final Matrix transposeTimes(Matrix B)
```
    Linear algebraic matrix multiplication, A^T * B.
    
    Parameters:
    B - another matrix
    
    Returns:
    Matrix product, A^T * B
  - transposeTimesTimes
```
public final double transposeTimesTimes(Matrix B,
                         Vector c)
```
    Linear algebraic matrix multiplication, a^T * B * c.
    
    Parameters:
    B - matrix
    c - vector on the right
    
    Returns:
    Matrix product, a^T * B * c
  - transposeTimes
```
public final double transposeTimes(Vector B)
```
    Linear algebraic matrix multiplication, A^T * B.
    
    Parameters:
    B - another vector
    
    Returns:
    Matrix product, A^T * B
  - timesTranspose
```
public final Matrix timesTranspose(Matrix B)
```
    Linear algebraic matrix multiplication, A * B^T.
    
    Parameters:
    B - another matrix
    
    Returns:
    Matrix product, A * B^T
  - timesTranspose
```
public final Matrix timesTranspose(Vector B)
```
    Linear algebraic matrix multiplication, A * B^T.
    
    Parameters:
    B - another matrix
    
    Returns:
    Matrix product, A * B^T
  - squaredEuclideanLength
```
public final double squaredEuclideanLength()
```
    Returns the squared length of this vector: v^T * v.
    
    Returns:
    the squared length of this vector
  - euclideanLength
```
public final double euclideanLength()
```
    Returns the length of this vector.
    
    Returns:
    the length of this vector
  - normalize
```
public final Vector normalize()
```
    Normalizes this vector to the length of 1.0.
    
    Returns:
    this vector
  - projection
```
public final Vector projection(Matrix v)
```
    Projects this row vector into the subspace formed by the specified matrix v.
    
    Parameters:
    v - the subspace matrix
    
    Returns:
    the projection of p into the subspace formed by v
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public final String toString()
```
    Returns a string representation of this vector.
    
    Specified by:
    
    toString in interface FeatureVector<Number>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this vector.
  - toStringNoWhitespace
```
public final String toStringNoWhitespace()
```
    Returns a string representation of this vector without adding extra whitespace.
    
    Returns:
    a string representation of this vector.
  - setZero
```
public void setZero()
```
    Reset the Vector to 0.
  - rotate90Equals
```
public Vector rotate90Equals()
```
    Rotate vector by 90 degrees.
    
    Returns:
    self, for operation chaining.
  - cross3D
```
public Vector cross3D(Vector other)
```
    Cross product for 3d vectors, i.e. this x other
    
    Parameters:
    other - Other vector
    
    Returns:
    Cross product of this vector and the other vector
  - getMin
```
public double getMin(int dimension)
```
    Description copied from interface: SpatialComparable
    
    Returns the minimum coordinate at the specified dimension.
    
    Specified by:
    
    getMin in interface SpatialComparable
    
    Parameters:
    dimension - the dimension for which the coordinate should be returned, where 0 ≤ dimension < getDimensionality()
    
    Returns:
    the minimum coordinate at the specified dimension
  - getMax
```
public double getMax(int dimension)
```
    Description copied from interface: SpatialComparable
    
    Returns the maximum coordinate at the specified dimension.
    
    Specified by:
    
    getMax in interface SpatialComparable
    
    Parameters:
    dimension - the dimension for which the coordinate should be returned, where 0 ≤ dimension < getDimensionality()
    
    Returns:
    the maximum coordinate at the specified dimension
  - getValue
```
@Deprecated
public Double getValue(int dimension)
```
    Deprecated.
    
    Description copied from interface: FeatureVector
    
    Returns the value in the specified dimension.
    
    Specified by:
    
    getValue in interface FeatureVector<Number>
    
    Specified by:
    
    getValue in interface NumberVector
    
    Parameters:
    dimension - the desired dimension, where 0 ≤ dimension ≤ this.getDimensionality()-1
    
    Returns:
    the value in the specified dimension
  - doubleValue
```
public double doubleValue(int dimension)
```
    Description copied from interface: NumberVector
    
    Returns the value in the specified dimension as double. Note: this might seem redundant with respect to getValue(dim).doubleValue(), but usually this is much more efficient due to boxing/unboxing cost.
    
    Specified by:
    
    doubleValue in interface NumberVector
    
    Parameters:
    dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()
    
    Returns:
    the value in the specified dimension
  - floatValue
```
public float floatValue(int dimension)
```
    Description copied from interface: NumberVector
    
    Returns the value in the specified dimension as float. Note: this might seem redundant with respect to getValue(dim).floatValue(), but usually this is much more efficient due to boxing/unboxing cost.
    
    Specified by:
    
    floatValue in interface NumberVector
    
    Parameters:
    dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()
    
    Returns:
    the value in the specified dimension
  - intValue
```
public int intValue(int dimension)
```
    Description copied from interface: NumberVector
    
    Returns the value in the specified dimension as int. Note: this might seem redundant with respect to getValue(dim).intValue(), but usually this is much more efficient due to boxing/unboxing cost.
    
    Specified by:
    
    intValue in interface NumberVector
    
    Parameters:
    dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()
    
    Returns:
    the value in the specified dimension
  - longValue
```
public long longValue(int dimension)
```
    Description copied from interface: NumberVector
    
    Returns the value in the specified dimension as long. Note: this might seem redundant with respect to getValue(dim).longValue(), but usually this is much more efficient due to boxing/unboxing cost.
    
    Specified by:
    
    longValue in interface NumberVector
    
    Parameters:
    dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()
    
    Returns:
    the value in the specified dimension
  - shortValue
```
public short shortValue(int dimension)
```
    Description copied from interface: NumberVector
    
    Returns the value in the specified dimension as short. Note: this might seem redundant with respect to getValue(dim).shortValue(), but usually this is much more efficient due to boxing/unboxing cost.
    
    Specified by:
    
    shortValue in interface NumberVector
    
    Parameters:
    dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()
    
    Returns:
    the value in the specified dimension
  - byteValue
```
public byte byteValue(int dimension)
```
    Description copied from interface: NumberVector
    
    Returns the value in the specified dimension as byte. Note: this might seem redundant with respect to getValue(dim).byteValue(), but usually this is much more efficient due to boxing/unboxing cost.
    
    Specified by:
    
    byteValue in interface NumberVector
    
    Parameters:
    dimension - the desired dimension, where 0 ≤ dimension < this.getDimensionality()
    
    Returns:
    the value in the specified dimension
  - getColumnVector
```
public Vector getColumnVector()
```
    Description copied from interface: NumberVector
    
    Returns a Vector representing in one column and getDimensionality() rows the values of this NumberVector of V.
    
    Specified by:
    
    getColumnVector in interface NumberVector
    
    Returns:
    a Matrix representing in one column and getDimensionality() rows the values of this NumberVector of V

Class Vector

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FACTORY

BYTE_SERIALIZER

SHORT_SERIALIZER

VARIABLE_SERIALIZER

elements

ERR_VEC_DIMENSIONS

ERR_MATRIX_INNERDIM

ERR_DIMENSIONS

Constructor Detail

Vector

Vector

Method Detail

randomNormalizedVector

unitVector

copy

clone

getArrayRef

getArrayCopy

getDimensionality

get

set

set

plus

plusTimes

plusEquals

plusTimesEquals

plusEquals

minus

minusTimes

minusEquals

minusTimesEquals

minusEquals

times

timesEquals

times

transposeTimes

transposeTimesTimes

transposeTimes

timesTranspose

timesTranspose

squaredEuclideanLength

euclideanLength

normalize

projection

hashCode

equals

toString

toStringNoWhitespace

setZero

rotate90Equals

cross3D

getMin

getMax

getValue

doubleValue

floatValue

intValue

longValue

shortValue

byteValue

getColumnVector