co.paralleluniverse.geodesy.vector

Class Vector3

java.lang.Object

co.paralleluniverse.geodesy.matrix.Matrix

co.paralleluniverse.geodesy.vector.Vector3

All Implemented Interfaces:

Externalizable, Serializable, Cloneable

Direct Known Subclasses:

AccelerationVector, LocationVector, VelocityVector

public class Vector3
extends Matrix
implements Externalizable

A 3-dimensional vector.

This class and all it subclasses are mutable, therefore it should only be used to hold intermediate results, and never shared among threads.

See Also:

Serialized Form

Field Summary

Fields inherited from class co.paralleluniverse.geodesy.matrix.Matrix

cols, rows

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Vector3()
protected	Vector3(double e0, double e1, double e2)
protected	Vector3(Vector3 vec)

Method Summary

Methods

Modifier and Type	Method and Description
Vector3	add(Vector3 vec) Adds (destructively) a given vector to this vector
static Vector3	add(Vector3 vec1, Vector3 vec2) Adds two vectors.
static Vector3	cross(Vector3 vec1, Vector3 vec2) Computes the cross product of two vectors.
static double	dot(Vector3 vec1, Vector3 vec2) Computes the dot product of two vectors.
boolean	equals(Object obj)
double	get(int coordIndex) Returns the value of a given coordinate
int	hashCode()
double	norm() Returns the norm of this vector
double	normSqr() Returns the norm of this vector, squared
void	readExternal(ObjectInput in)
Vector3	scale(double value) Scaled (destructively) this vector by a given value
static Vector3	scale(Vector3 vec, double value) Scales a vector by a scalar.
protected void	set(double coord0, double coord1, double coord2) Sets this vector to the given coordinates
void	set(int coordIndex, double value) Sets the specified coordinate to the given value
void	set(Vector3 vec) Sets this vector to the value of a given vector
Vector3	sub(Vector3 vec) Subtracts (destructively) a given vector from this vector
static Vector3	sub(Vector3 vec1, Vector3 vec2) Subtracts two vectors.
String	toString()
Matrix	toVector4()
void	writeExternal(ObjectOutput out)

Methods inherited from class co.paralleluniverse.geodesy.matrix.Matrix

add, add, clone, copy, get, getData, mult, mult, multTranspose, multTranspose, set, subtract, transpose, transpose

Methods inherited from class java.lang.Object

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

Constructor Detail

Vector3

protected Vector3()

Vector3

protected Vector3(double e0,
       double e1,
       double e2)

Vector3

protected Vector3(Vector3 vec)

Method Detail

set

public final void set(int coordIndex,
       double value)

Sets the specified coordinate to the given value

Parameters:

coordIndex - the coordinate index (0-2)

value - the value

set

public final void set(Vector3 vec)

Sets this vector to the value of a given vector

Parameters:

vec -

get

public double get(int coordIndex)

Returns the value of a given coordinate

Parameters:

coordIndex - the coordinate index (0-2)

Returns:

the value of the coordinate

set

protected final void set(double coord0,
       double coord1,
       double coord2)

Sets this vector to the given coordinates

toVector4

public Matrix toVector4()

norm

public double norm()

Returns the norm of this vector

normSqr

public double normSqr()

Returns the norm of this vector, squared

add

public Vector3 add(Vector3 vec)

Adds (destructively) a given vector to this vector

Parameters:

vec - the vector to add

Returns:

this

sub

public Vector3 sub(Vector3 vec)

Subtracts (destructively) a given vector from this vector

Parameters:

vec - the vector to subtract

Returns:

this

scale

public Vector3 scale(double value)

Scaled (destructively) this vector by a given value

Parameters:

value - the amount by which to scale this vector

Returns:

this

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Matrix

add

public static Vector3 add(Vector3 vec1,
          Vector3 vec2)

Adds two vectors. Both vector arguments remain unmodified.

Parameters:

vec1 - the first vector

vec2 - the second vector

Returns:

a new vector equal to the sum of both vectors

sub

public static Vector3 sub(Vector3 vec1,
          Vector3 vec2)

Subtracts two vectors. Both vector arguments remain unmodified.

Parameters:

vec1 - the first vector, from which we subtract

vec2 - the second vector, to be subtracted from the first

Returns:

a new vector equal to vec1 - vec2.

scale

public static Vector3 scale(Vector3 vec,
            double value)

Scales a vector by a scalar. The vector argument remains unmodified.

Parameters:

vec - the vector to scale

value - the value by which to scale the vector

Returns:

a new vector equal the given vector scaled by the given scalar value.

dot

public static double dot(Vector3 vec1,
         Vector3 vec2)

Computes the dot product of two vectors.

Parameters:

vec1 - the first vector

vec2 - the second vector

Returns:

the dot product of vec1 and vec2

cross

public static Vector3 cross(Vector3 vec1,
            Vector3 vec2)

Computes the cross product of two vectors.

Parameters:

vec1 - the first vector

vec2 - the second vector

Returns:

the cross product of vec1 and vec2, i.e. vec1 x vec2

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException