org.apache.flink.ml.math

Class DenseVector

java.lang.Object

org.apache.flink.ml.math.DenseVector

All Implemented Interfaces:

Serializable, Vector, scala.Equals, scala.Product

public class DenseVector
extends Object
implements Vector, scala.Serializable, scala.Product

Dense vector implementation of Vector. The data is represented in a continuous array of doubles.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DenseVector(double[] data)

Method Summary

Modifier and Type	Method and Description
double	apply(int index) Element wise access function
DenseVector	copy() Copies the vector instance
double[]	data()
static Object	denseVectorConverter() BreezeVectorConverter implementation for DenseVector
double	dot(Vector other) Returns the dot product of the recipient and the argument
boolean	equals(Object obj)
static DenseVector	eye(int size)
int	hashCode()
static DenseVector	init(int size, double value)
double	magnitude() Magnitude of a vector
Matrix	outer(Vector other) Returns the outer product (a.k.a.
int	size() Number of elements in a vector
SparseVector	toSparseVector()
String	toString()
void	update(int index, double value) Updates the element at the given index with the provided value
static DenseVector	zeros(int size)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flink.ml.math.Vector

equalsVector

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual

Constructor Detail

DenseVector

public DenseVector(double[] data)

Method Detail

zeros

public static DenseVector zeros(int size)

eye

public static DenseVector eye(int size)

init

public static DenseVector init(int size,
                               double value)

denseVectorConverter

public static Object denseVectorConverter()

BreezeVectorConverter implementation for DenseVector

This allows to convert Breeze vectors into DenseVector.

data

public double[] data()

size

public int size()

Number of elements in a vector

Specified by:

size in interface Vector

Returns:

apply

public double apply(int index)

Element wise access function

Specified by:

apply in interface Vector

Parameters:

index - index of the accessed element

Returns:

element at the given index

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface scala.Equals

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copy

public DenseVector copy()

Copies the vector instance

Specified by:

copy in interface Vector

Returns:

Copy of the vector instance

update

public void update(int index,
                   double value)

Updates the element at the given index with the provided value

Specified by:

update in interface Vector

Parameters:

index - Index whose value is updated.

value - The value used to update the index.

dot

public double dot(Vector other)

Returns the dot product of the recipient and the argument

Specified by:

dot in interface Vector

Parameters:

other - a Vector

Returns:

a scalar double of dot product

outer

public Matrix outer(Vector other)

Returns the outer product (a.k.a. Kronecker product) of this with other. The result will given in SparseMatrix representation if other is sparse and as DenseMatrix otherwise.

Specified by:

outer in interface Vector

Parameters:

other - a Vector

Returns:

the Matrix which equals the outer product of this with other.

magnitude

public double magnitude()

Magnitude of a vector

Specified by:

magnitude in interface Vector

Returns:

toSparseVector

public SparseVector toSparseVector()