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

Class SparseVector

java.lang.Object

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

All Implemented Interfaces:

ImmutableVector

public final class SparseVector
extends Object

A sparse vector represented by an index and value array.

Constructor Summary

Constructors

Constructor and Description
SparseVector(double[] values, int[] indices)
SparseVector(double[] values, int[] indices, int size)

Method Summary

Methods

Modifier and Type	Method and Description
double	dot(Vector that) Computes the inner product with another Vector.
double	get(int index) 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.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SparseVector

public SparseVector(double[] values,
            int[] indices,
            int size)

SparseVector

public SparseVector(double[] values,
            int[] indices)

Method Detail

get

public double get(int index)

Description copied from interface: ImmutableVector

Access the value of the Vector at dimension i

Specified by:

get in interface ImmutableVector

Parameters:

index - index

Returns:

the value at index i

size

public int size()

Description copied from interface: ImmutableVector

The size (dimensionality) of the Vector

Specified by:

size in interface ImmutableVector

Returns:

the size of the Vector.

dot

public double dot(Vector that)

Description copied from interface: ImmutableVector

Computes the inner product with another Vector.

Specified by:

dot in interface ImmutableVector

Returns:

the inner product between two Vectors.

sum

public double sum()

Description copied from interface: ImmutableVector

Computes the computeSum of all entries in the Vector.

Specified by:

sum in interface ImmutableVector

Returns:

the computeSum of all entries in this Vector

norm2

public double norm2()

Description copied from interface: ImmutableVector

Computes the L2 norm of this Vector.

Specified by:

norm2 in interface ImmutableVector

Returns:

the L2 norm of this Vector.

norm2Sqr

public double norm2Sqr()

Description copied from interface: ImmutableVector

Computes the square of the L2 norm of this Vector.

Specified by:

norm2Sqr in interface ImmutableVector

Returns:

the square of the L2 norm of this Vector.

toString

public String toString()

Overrides:

toString in class Object

min

public Tuple<Integer,Double> min()

Description copied from interface: ImmutableVector

Computes the min of all entries in the Vector

Specified by:

min in interface ImmutableVector

Returns:

the min of all entries in this Vector