org.apache.reef.examples.group.utils.math

Interface ImmutableVector

All Known Subinterfaces:

Vector

All Known Implementing Classes:

AbstractVector, DenseVector, SparseVector

public interface ImmutableVector

Represents an immutable vector.

Method Summary

Methods

Modifier and Type	Method and Description
double	dot(Vector that) Computes the inner product with another Vector.
double	get(int i) Access the value of the Vector at dimension i.
Tuple<Integer,Double>	min() Computes the min of all entries in the Vector.
double	norm2() Computes the L2 norm of this Vector.
double	norm2Sqr() Computes the square of the L2 norm of this Vector.
int	size() The size (dimensionality) of the Vector.
double	sum() Computes the computeSum of all entries in the Vector.

Method Detail

get

double get(int i)

Access the value of the Vector at dimension i.

Parameters:

i - index

Returns:

the value at index i

size

int size()

The size (dimensionality) of the Vector.

Returns:

the size of the Vector.

dot

double dot(Vector that)

Computes the inner product with another Vector.

Parameters:

that -

Returns:

the inner product between two Vectors.

sum

double sum()

Computes the computeSum of all entries in the Vector.

Returns:

the computeSum of all entries in this Vector

norm2

double norm2()

Computes the L2 norm of this Vector.

Returns:

the L2 norm of this Vector.

norm2Sqr

double norm2Sqr()

Computes the square of the L2 norm of this Vector.

Returns:

the square of the L2 norm of this Vector.

min

Tuple<Integer,Double> min()

Computes the min of all entries in the Vector.

Returns:

the min of all entries in this Vector