mikera.vectorz

Class AVector

java.lang.Object

mikera.vectorz.AVector

All Implemented Interfaces:

Cloneable, Comparable<AVector>

Direct Known Subclasses:

ArrayVector, JoinedVector, PrimitiveVector, WrappedSubVector

public abstract class AVector
extends Object
implements Cloneable, Comparable<AVector>

Main abstract base class for all types of vector Contains default implementations for most vector operations which can be overriden to achieve better performance in derived classes.

Author:

Mike

Constructor Summary

Constructors

Constructor and Description
AVector()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(AVector v) Adds another vector to this one
void	addMultiple(AVector v, double factor) Adds a scaled multiple of another vector to this one
AVector	clone() Clones the vector, creating a new copy of all data
int	compareTo(AVector a)
void	copyTo(double[] data, int offset) Copies a the contents of a vector to a double array at the specified offset
double	dotProduct(AVector v)
boolean	equals(Object o) Test for equality on vectors.
void	fill(double value) Fills a vector with a given value
abstract double	get(int i)
int	hashCode()
abstract int	length()
double	magnitude() Returns the magnitude (Euclidean length) of the vector
double	magnitudeSquared()
void	multiply(double factor) Multiplies the vector by a constant factor
void	normalise()
abstract void	set(int i, double value)
void	subtract(AVector v) Subtracts a vector from this vector
void	subtractMultiple(AVector v, double factor) Subtracts a scaled multiple of another vector from this vector
AVector	subVector(int offset, int length)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AVector

public AVector()

Method Detail

length

public abstract int length()

get

public abstract double get(int i)

set

public abstract void set(int i,
       double value)

subVector

public AVector subVector(int offset,
                int length)

compareTo

public int compareTo(AVector a)

Specified by:

compareTo in interface Comparable<AVector>

equals

public boolean equals(Object o)

Test for equality on vectors. Returns true iff all values in the vector are identical

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copyTo

public void copyTo(double[] data,
          int offset)

Copies a the contents of a vector to a double array at the specified offset

fill

public void fill(double value)

Fills a vector with a given value

Parameters:

value -

multiply

public void multiply(double factor)

Multiplies the vector by a constant factor

Parameters:

factor - Factor by which to multiply each component of the vector

magnitudeSquared

public double magnitudeSquared()

dotProduct

public double dotProduct(AVector v)

magnitude

public double magnitude()

Returns the magnitude (Euclidean length) of the vector

Returns:

normalise

public void normalise()

clone

public AVector clone()

Clones the vector, creating a new copy of all data

Overrides:

clone in class Object

add

public void add(AVector v)

Adds another vector to this one

Parameters:

v -

addMultiple

public void addMultiple(AVector v,
               double factor)

Adds a scaled multiple of another vector to this one

Parameters:

v -

subtract

public void subtract(AVector v)

Subtracts a vector from this vector

Parameters:

v -

subtractMultiple

public void subtractMultiple(AVector v,
                    double factor)

Subtracts a scaled multiple of another vector from this vector

Parameters:

v -

toString

public String toString()

Overrides:

toString in class Object