jsci.maths.vectors

Class Double2Vector

java.lang.Object

jsci.maths.vectors.MathVector

jsci.maths.vectors.AbstractDoubleVector

jsci.maths.vectors.Double2Vector

All Implemented Interfaces:

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

public final class Double2Vector
extends AbstractDoubleVector

An optimised implementation of a 2D double vector.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Double2Vector() Constructs an empty 2-vector.
Double2Vector(double[] array) Constructs a 2-vector.
Double2Vector(double x, double y) Constructs a 2-vector.

Method Summary

Modifier and Type	Method and Description
AbelianGroup.Member	add(AbelianGroup.Member vec) Returns the addition of this vector and another.
AbstractDoubleVector	add(AbstractDoubleVector vec) Returns the addition of this vector and another.
boolean	equals(java.lang.Object obj, double tol) Compares two double vectors for equality.
double	getComponent(int n) Returns a component of this vector.
double	infNorm() Returns the l-norm.
AbstractDoubleVector	mapComponents(Mapping mapping) Applies a function on all the vector components.
AbelianGroup.Member	negate() Returns the negative of this vector.
double	norm() Returns the l2-norm (magnitude).
double	norm(int n) Returns the ln-norm.
AbstractDoubleVector	scalarDivide(double k) Returns the division of this vector by a scalar.
VectorSpace.Member	scalarDivide(Field.Member x) Returns the division of this vector by a scalar.
AbstractDoubleVector	scalarMultiply(double k) Returns the multiplication of this vector by a scalar.
Module.Member	scalarMultiply(Ring.Member x) Returns the multiplication of this vector by a scalar.
double	scalarProduct(AbstractDoubleVector vec) Returns the scalar product of this vector and another.
void	setComponent(int n, double value) Sets the value of a component of this vector.
AbelianGroup.Member	subtract(AbelianGroup.Member vec) Returns the subtraction of this vector by another.
AbstractDoubleVector	subtract(AbstractDoubleVector vec) Returns the subtraction of this vector by another.
AbstractComplexVector	toComplexVector() Converts this 2-vector to a complex 2-vector.
AbstractIntegerVector	toIntegerVector() Converts this 2-vector to an integer 2-vector.
java.lang.String	toString() Returns a comma delimited string representing the value of this vector.

Methods inherited from class jsci.maths.vectors.AbstractDoubleVector

equals, getSet, hashCode, mass, normalize

Methods inherited from class jsci.maths.vectors.MathVector

dimension

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Double2Vector

public Double2Vector()

Constructs an empty 2-vector.

Double2Vector

public Double2Vector(double x,
                     double y)

Constructs a 2-vector.

Parameters:

x - x coordinate.

y - y coordinate.

Double2Vector

public Double2Vector(double[] array)

Constructs a 2-vector.

Method Detail

equals

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

Compares two double vectors for equality.

Overrides:

equals in class AbstractDoubleVector

Parameters:

obj - a double 2-vector

toString

public java.lang.String toString()

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

Overrides:

toString in class AbstractDoubleVector

toIntegerVector

public AbstractIntegerVector toIntegerVector()

Converts this 2-vector to an integer 2-vector.

Returns:

an integer 2-vector

toComplexVector

public AbstractComplexVector toComplexVector()

Converts this 2-vector to a complex 2-vector.

Returns:

a complex 2-vector

getComponent

public double getComponent(int n)

Returns a component of this vector.

Specified by:

getComponent in class AbstractDoubleVector

Parameters:

n - index of the vector component

Throws:

VectorDimensionException - If attempting to access an invalid component.

setComponent

public void setComponent(int n,
                         double value)

Sets the value of a component of this vector. Should only be used to initialise this vector.

Specified by:

setComponent in class AbstractDoubleVector

Parameters:

n - index of the vector component

value - a number

Throws:

VectorDimensionException - If attempting to access an invalid component.

norm

public double norm(int n)

Returns the lⁿ-norm.

Overrides:

norm in class AbstractDoubleVector

norm

public double norm()

Returns the l²-norm (magnitude).

Specified by:

norm in interface BanachSpace.Member

Overrides:

norm in class AbstractDoubleVector

infNorm

public double infNorm()

Returns the l-norm.

Overrides:

infNorm in class AbstractDoubleVector

negate

public AbelianGroup.Member negate()

Returns the negative of this vector.

add

public AbelianGroup.Member add(AbelianGroup.Member vec)

Returns the addition of this vector and another.

Parameters:

vec - a group member

add

public AbstractDoubleVector add(AbstractDoubleVector vec)

Returns the addition of this vector and another.

Specified by:

add in class AbstractDoubleVector

Parameters:

vec - a double 2-vector

subtract

public AbelianGroup.Member subtract(AbelianGroup.Member vec)

Returns the subtraction of this vector by another.

Parameters:

vec - a group member

subtract

public AbstractDoubleVector subtract(AbstractDoubleVector vec)

Returns the subtraction of this vector by another.

Specified by:

subtract in class AbstractDoubleVector

Parameters:

vec - a double 2-vector

scalarMultiply

public Module.Member scalarMultiply(Ring.Member x)

Returns the multiplication of this vector by a scalar.

Parameters:

x - a ring member

scalarMultiply

public AbstractDoubleVector scalarMultiply(double k)

Returns the multiplication of this vector by a scalar.

Specified by:

scalarMultiply in class AbstractDoubleVector

Parameters:

k - a double

Returns:

a double 2-vector

scalarDivide

public VectorSpace.Member scalarDivide(Field.Member x)

Returns the division of this vector by a scalar.

Parameters:

x - a field member

scalarDivide

public AbstractDoubleVector scalarDivide(double k)

Returns the division of this vector by a scalar.

Specified by:

scalarDivide in class AbstractDoubleVector

Parameters:

k - a double

Returns:

a double 2-vector

Throws:

java.lang.ArithmeticException - If divide by zero.

scalarProduct

public double scalarProduct(AbstractDoubleVector vec)

Returns the scalar product of this vector and another.

Specified by:

scalarProduct in class AbstractDoubleVector

Parameters:

vec - a double 2-vector

mapComponents

public AbstractDoubleVector mapComponents(Mapping mapping)

Applies a function on all the vector components.

Specified by:

mapComponents in class AbstractDoubleVector

Parameters:

mapping - a user-defined function

Returns:

a double 2-vector