jsci.maths.vectors

Class AbstractDoubleVector

java.lang.Object

jsci.maths.vectors.MathVector

jsci.maths.vectors.AbstractDoubleVector

All Implemented Interfaces:

java.io.Serializable, BanachSpace.Member, Module.Member, VectorSpace.Member, AbelianGroup.Member, Member

Direct Known Subclasses:

Double2Vector, Double3Vector, DoubleSparseVector, DoubleVector

public abstract class AbstractDoubleVector
extends MathVector
implements BanachSpace.Member

The AbstractDoubleVector class encapsulates vectors containing doubles.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
abstract AbstractDoubleVector	add(AbstractDoubleVector v) Returns the addition of this vector and another.
boolean	equals(java.lang.Object obj) Compares two double vectors for equality.
boolean	equals(java.lang.Object obj, double tol)
abstract double	getComponent(int n) Returns a component of this vector.
java.lang.Object	getSet()
int	hashCode() Returns a hashcode for this vector.
double	infNorm() Returns the l-norm.
abstract AbstractDoubleVector	mapComponents(Mapping f) Applies a function on all the vector components.
double	mass() Returns the mass (l1-norm).
double	norm() Returns the l2-norm (magnitude).
double	norm(int n) Returns the ln-norm.
AbstractDoubleVector	normalize() Returns a normalised vector (a vector with norm equal to one).
abstract AbstractDoubleVector	scalarDivide(double x) Returns the division of this vector by a scalar.
abstract AbstractDoubleVector	scalarMultiply(double x) Returns the multiplication of this vector by a scalar.
abstract double	scalarProduct(AbstractDoubleVector v) Returns the scalar product of this vector and another.
abstract void	setComponent(int n, double x) Sets the value of a component of this vector.
abstract AbstractDoubleVector	subtract(AbstractDoubleVector v) Returns the subtraction of this vector by another.
java.lang.String	toString() Returns a comma delimited string representing the value of this vector.

Methods inherited from class jsci.maths.vectors.MathVector

dimension

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jsci.maths.algebras.VectorSpace.Member

scalarDivide

Methods inherited from interface jsci.maths.algebras.Module.Member

scalarMultiply

Methods inherited from interface jsci.maths.groups.AbelianGroup.Member

add, negate, subtract

Method Detail

equals

public final boolean equals(java.lang.Object obj)

Compares two double vectors for equality. Two vectors are considered to be equal if the norm of their difference is within the zero tolerance.

Overrides:

equals in class java.lang.Object

Parameters:

obj - a double vector

equals

public boolean equals(java.lang.Object obj,
                      double tol)

toString

public java.lang.String toString()

Returns a comma delimited string representing the value of this vector.

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Returns a hashcode for this vector.

Overrides:

hashCode in class java.lang.Object

getComponent

public abstract double getComponent(int n)

Returns a component of this vector.

Parameters:

n - index of the vector component.

Throws:

VectorDimensionException - If attempting to access an invalid component.

setComponent

public abstract void setComponent(int n,
                                  double x)

Sets the value of a component of this vector.

Parameters:

n - index of the vector component.

x - a number.

Throws:

VectorDimensionException - If attempting to access an invalid component.

getSet

public java.lang.Object getSet()

Specified by:

getSet in interface Member

norm

public double norm(int n)

Returns the lⁿ-norm.

norm

public double norm()

Returns the l²-norm (magnitude).

Specified by:

norm in interface BanachSpace.Member

Specified by:

norm in class MathVector

infNorm

public double infNorm()

Returns the l-norm.

mass

public double mass()

Returns the mass (l¹-norm).

add

public abstract AbstractDoubleVector add(AbstractDoubleVector v)

Returns the addition of this vector and another.

Parameters:

v - a double vector.

Throws:

VectorDimensionException - If the vectors are different sizes.

subtract

public abstract AbstractDoubleVector subtract(AbstractDoubleVector v)

Returns the subtraction of this vector by another.

Parameters:

v - a double vector.

Throws:

VectorDimensionException - If the vectors are different sizes.

scalarMultiply

public abstract AbstractDoubleVector scalarMultiply(double x)

Returns the multiplication of this vector by a scalar.

Parameters:

x - a double.

scalarDivide

public abstract AbstractDoubleVector scalarDivide(double x)

Returns the division of this vector by a scalar.

Parameters:

x - a double.

Throws:

java.lang.ArithmeticException - If divide by zero.

normalize

public AbstractDoubleVector normalize()

Returns a normalised vector (a vector with norm equal to one).

scalarProduct

public abstract double scalarProduct(AbstractDoubleVector v)

Returns the scalar product of this vector and another.

Parameters:

v - a double vector.

Throws:

VectorDimensionException - If the vectors are different sizes.

mapComponents

public abstract AbstractDoubleVector mapComponents(Mapping f)

Applies a function on all the vector components.

Parameters:

f - a user-defined function.

Returns:

a double vector.