JSci.maths
Class DoubleVector

java.lang.Object
  JSci.maths.MathVector
      JSci.maths.DoubleVector

All Implemented Interfaces:

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

Direct Known Subclasses:

Double3Vector, DoubleSparseVector

public class DoubleVector
extends MathVector
implements BanachSpace.Member

The DoubleVector class encapsulates double vectors.

Version:

2.1

Author:

Mark Hale

See Also:

Serialized Form

Field Summary

protected static int	ARRAY_1D Storage format identifier.
protected double[]	vector Array containing the components of the vector.

Fields inherited from class JSci.maths.MathVector

CLASS_SPECIFIC, N, storageFormat

Constructor Summary

	DoubleVector(double[] array) Constructs a vector by wrapping an array.
	DoubleVector(int dim) Constructs an empty vector.
protected	DoubleVector(int dim, int storeID)

Method Summary

AbelianGroup.Member	add(AbelianGroup.Member v) Returns the addition of this vector and another.
DoubleVector	add(DoubleVector v) Returns the addition of this vector and another.
boolean	equals(java.lang.Object a) Compares two double vectors for equality.
double	getComponent(int n) Returns a component of this vector.
int	hashCode() Returns a hashcode for this vector.
double	infNorm() Returns the l-norm.
DoubleVector	mapComponents(Mapping f) 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.
void	normalize() Makes the norm of this vector equal to 1.
DoubleVector	scalarDivide(double x) Returns the division of this vector by a scalar.
VectorSpace.Member	scalarDivide(Field.Member x) Returns the division of this vector by a scalar.
DoubleVector	scalarMultiply(double x) 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(DoubleVector v) Returns the scalar product of this vector and another.
void	setComponent(int n, double x) Sets the value of a component of this vector.
AbelianGroup.Member	subtract(AbelianGroup.Member v) Returns the subtraction of this vector by another.
DoubleVector	subtract(DoubleVector v) Returns the subtraction of this vector by another.
ComplexVector	toComplexVector() Converts this vector to a complex vector.
IntegerVector	toIntegerVector() Converts this vector to an integer vector.
java.lang.String	toString() Returns a comma delimited string representing the value of this vector.

Methods inherited from class JSci.maths.MathVector

dimension, getInvalidComponentMsg

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ARRAY_1D

protected static final int ARRAY_1D

Storage format identifier.

See Also:

Constant Field Values

vector

protected double[] vector

Array containing the components of the vector.

Constructor Detail

DoubleVector

protected DoubleVector(int dim,
                       int storeID)

DoubleVector

public DoubleVector(int dim)

Constructs an empty vector.

Parameters:

dim - the dimension of the vector.

DoubleVector

public DoubleVector(double[] array)

Constructs a vector by wrapping an array.

Parameters:

array - an assigned value.

Method Detail

equals

public boolean equals(java.lang.Object a)

Compares two double vectors for equality.

Overrides:

equals in class java.lang.Object

Parameters:

a - a double vector.

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

toIntegerVector

public IntegerVector toIntegerVector()

Converts this vector to an integer vector.

Returns:

an integer vector.

toComplexVector

public ComplexVector toComplexVector()

Converts this vector to a complex vector.

Returns:

a complex vector.

getComponent

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

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

normalize

public void normalize()

Makes the norm of this vector equal to 1.

infNorm

public double infNorm()

Returns the l-norm.

negate

public AbelianGroup.Member negate()

Returns the negative of this vector.

Specified by:

negate in interface AbelianGroup.Member

add

public AbelianGroup.Member add(AbelianGroup.Member v)

Returns the addition of this vector and another.

Specified by:

add in interface AbelianGroup.Member

Parameters:

v - a group member

add

public DoubleVector add(DoubleVector v)

Returns the addition of this vector and another.

Parameters:

v - a double vector.

Throws:

VectorDimensionException - If the vectors are different sizes.

subtract

public AbelianGroup.Member subtract(AbelianGroup.Member v)

Returns the subtraction of this vector by another.

Specified by:

subtract in interface AbelianGroup.Member

Parameters:

v - a group member

subtract

public DoubleVector subtract(DoubleVector v)

Returns the subtraction of this vector by another.

Parameters:

v - a double vector.

Throws:

VectorDimensionException - If the vectors are different sizes.

scalarMultiply

public Module.Member scalarMultiply(Ring.Member x)

Returns the multiplication of this vector by a scalar.

Specified by:

scalarMultiply in interface Module.Member

Parameters:

x - a ring member

scalarMultiply

public DoubleVector scalarMultiply(double x)

Returns the multiplication of this vector by a scalar.

Parameters:

x - a double.

scalarDivide

public VectorSpace.Member scalarDivide(Field.Member x)

Returns the division of this vector by a scalar.

Specified by:

scalarDivide in interface VectorSpace.Member

Parameters:

x - a field member

scalarDivide

public DoubleVector scalarDivide(double x)

Returns the division of this vector by a scalar.

Parameters:

x - a double.

Throws:

java.lang.ArithmeticException - If divide by zero.

scalarProduct

public double scalarProduct(DoubleVector 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 DoubleVector mapComponents(Mapping f)

Applies a function on all the vector components.

Parameters:

f - a user-defined function.

Returns:

a double vector.