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

Class AbstractVector

java.lang.Object

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

All Implemented Interfaces:

Serializable, ImmutableVector, Vector

Direct Known Subclasses:

DenseVector

public abstract class AbstractVector
extends Object
implements Vector

Abstract base class for Vector implementations.

The only methods to be implemented by subclasses are get, set and size.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractVector()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Vector that) Adds the Vector that to this one in place: this += that.
double	dot(Vector that) Computes the inner product with another Vector.
abstract 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.
void	multAdd(double factor, ImmutableVector that) this += factor * that.
double	norm2() Computes the L2 norm of this Vector.
double	norm2Sqr() Computes the square of the L2 norm of this Vector.
void	normalize() Normalizes the Vector according to the L2 norm.
void	scale(double factor) Scales this Vector: this *= factor.
abstract void	set(int i, double v) Set dimension i of the Vector to value v.
abstract 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

Methods inherited from interface org.apache.reef.examples.group.utils.math.Vector

newInstance

Methods inherited from interface org.apache.reef.examples.group.utils.math.ImmutableVector

dot, get, min, norm2, norm2Sqr, size, sum

Constructor Detail

AbstractVector

public AbstractVector()

Method Detail

set

public abstract void set(int i,
       double v)

Description copied from interface: Vector

Set dimension i of the Vector to value v.

Specified by:

set in interface Vector

Parameters:

i - the index

v - value

add

public void add(Vector that)

Description copied from interface: Vector

Adds the Vector that to this one in place: this += that.

Specified by:

add in interface Vector

multAdd

public void multAdd(double factor,
           ImmutableVector that)

Description copied from interface: Vector

this += factor * that.

Specified by:

multAdd in interface Vector

scale

public void scale(double factor)

Description copied from interface: Vector

Scales this Vector: this *= factor.

Specified by:

scale in interface Vector

Parameters:

factor - the scaling factor.

normalize

public void normalize()

Description copied from interface: Vector

Normalizes the Vector according to the L2 norm.

Specified by:

normalize in interface Vector

get

public abstract double get(int i)

Description copied from interface: ImmutableVector

Access the value of the Vector at dimension i.

Specified by:

get in interface ImmutableVector

Parameters:

i - index

Returns:

the value at index i

size

public abstract 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