Package primitives

Class NonZeroVector

java.lang.Object

primitives.Triple

primitives.Vector

primitives.NonZeroVector

Direct Known Subclasses:

NormalizedVector

public class NonZeroVector
extends Vector

The NonZeroVector class represents a NonZeroVector with it's base at the origin and it's head at the Point 'head'.

Field Summary

Fields inherited from class primitives.Triple

x, y, z

Constructor Summary

Constructors

Constructor	Description
NonZeroVector(double x, double y, double z)	This constructor accepts 3 doubles and returns the appropriate NonZeroVector

Method Summary

Modifier and Type	Method	Description
NonZeroVector	add(Triple triple)	Adds two NonZeroVectors and returns a new NonZeroVector.
double	angle(NonZeroVector v)	Calculates the angle in radians between this vector and the given vector.
NonZeroVector	cross(NonZeroVector vector)	Calculates the cross product of two NonZeroVectors.
NormalizedVector	normalized()	Creates a new NonZeroVector with the same direction as this one but with a magnitude of one.
NonZeroVector	reversed()	An alias for Vector.scale(double) with factor -1.
NonZeroVector	scale(double factor)	Constructs a new NonZeroVector which is a scalar multiplication of this NonZeroVector by a scalar.
NonZeroVector	subtract(Vector vector)	Subtracts two NonZeroVectors and returns a new NonZeroVector.

Methods inherited from class primitives.Vector

add, cross, cross, dot, length, scale, squareLength, subtract, toString

Methods inherited from class primitives.Triple

equals, equals, hashCode, transform, transform

Methods inherited from class java.lang.Object

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

Constructor Details

NonZeroVector

public NonZeroVector(double x,
double y,
double z)

This constructor accepts 3 doubles and returns the appropriate NonZeroVector

Parameters:

x - The value of the x coordinate.

y - The value of the y coordinate.

z - The value of the z coordinate.

Throws:

ZeroVectorException - if the NonZeroVector is the zero vector.

Method Details

add

public NonZeroVector add(Triple triple)

Adds two NonZeroVectors and returns a new NonZeroVector.

Overrides:

add in class Vector

Parameters:

triple - The Triple which is to be added to this NonZeroVector.

Returns:

The sum of the two NonZeroVectors.

Throws:

ZeroVectorException - when adding a NonZeroVector with its reverse.

subtract

public NonZeroVector subtract(Vector vector)

Subtracts two NonZeroVectors and returns a new NonZeroVector.

Overrides:

subtract in class Vector

Parameters:

vector - The Vector to be subtracted from this NonZeroVector.

Returns:

The sum of this NonZeroVector and the negation of the given Vector.

Throws:

ZeroVectorException - if a NonZeroVector is subtracted from itself.

scale

public NonZeroVector scale(double factor)

Constructs a new NonZeroVector which is a scalar multiplication of this NonZeroVector by a scalar.

Overrides:

scale in class Vector

Parameters:

factor - The scalar by which to multiply this NonZeroVector

Returns:

New scaled NonZeroVector

Throws:

ZeroVectorException - if the scale factor is zero.

cross

public NonZeroVector cross(NonZeroVector vector)

Calculates the cross product of two NonZeroVectors.

Parameters:

vector - The NonZeroVector by which to multiply this NonZeroVector

Returns:

The resulting NonZeroVector which is the cross product of the two NonZeroVectors

Throws:

ZeroVectorException - if the result vector is the zero vector.

normalized

public NormalizedVector normalized()

Creates a new NonZeroVector with the same direction as this one but with a magnitude of one.

Returns:

new NonZeroVector

angle

public double angle(NonZeroVector v)

Calculates the angle in radians between this vector and the given vector. The angle is normalized between zero and Pi.

Parameters:

v - The other vector to be used to calculate the angle.

Returns:

The angle in radians between the vectors between zero and Pi.

reversed

public NonZeroVector reversed()

Description copied from class: Vector

An alias for Vector.scale(double) with factor -1.

Overrides:

reversed in class Vector

Returns:

New reversed Vector