gov.sandia.cognition.math.matrix

Interface Vector3D

All Superinterfaces:

java.lang.Cloneable, CloneableSerializable, java.lang.Iterable<VectorEntry>, Ring<Vector>, java.io.Serializable, Triple<java.lang.Double,java.lang.Double,java.lang.Double>, Vector, Vectorizable, VectorSpace<Vector,VectorEntry>

All Known Implementing Classes:

Vector3

public interface Vector3D
extends Vector, Triple<java.lang.Double,java.lang.Double,java.lang.Double>

An interface for a 3-dimensional vector. Adds convenience methods for accessing the three values (x, y, z).

Since:

3.0

Author:

Justin Basilico

Nested Class Summary

Nested classes/interfaces inherited from interface gov.sandia.cognition.math.matrix.Vector

Vector.IndexValueConsumer, Vector.IndexValueTransform

Nested classes/interfaces inherited from interface gov.sandia.cognition.math.matrix.VectorSpace

VectorSpace.Entry

Method Summary

Modifier and Type	Method and Description
double	getX() Gets the value of the first dimension (x).
double	getY() Gets the value of the second dimension (y).
double	getZ() Gets the value of the third dimension (z).
void	setX(double x) Sets the value of the first dimension (x).
void	setXYZ(double x, double y, double z) Sets the value of all three dimensions of this vector.
void	setY(double y) Sets the value of the second dimension (y).
void	setZ(double z) Sets the value of the third dimension (z).

Methods inherited from interface gov.sandia.cognition.math.matrix.Vector

assertDimensionalityEquals, assertSameDimensionality, checkSameDimensionality, clone, countNonZeros, decrement, decrement, dotDivide, dotDivideEquals, forEachElement, forEachEntry, forEachNonZero, get, getDimensionality, getElement, getEntryCount, getVectorFactory, increment, increment, isSparse, outerProduct, set, setElement, stack, subVector, times, toArray, toString, toString, toString, transform, transform, transformEquals, transformEquals, transformNonZeros, transformNonZeros, transformNonZerosEquals, transformNonZerosEquals, valuesAsList

Methods inherited from interface gov.sandia.cognition.math.matrix.VectorSpace

angle, cosine, dot, dotProduct, euclideanDistance, euclideanDistanceSquared, getMaxValue, getMinValue, isUnitVector, isUnitVector, norm, norm1, norm2, norm2Squared, normInfinity, sum, unitVector, unitVectorEquals

Methods inherited from interface gov.sandia.cognition.math.Ring

dotTimes, dotTimesEquals, equals, equals, isZero, isZero, minus, minusEquals, negative, negativeEquals, plus, plusEquals, scale, scaledMinus, scaledMinusEquals, scaledPlus, scaledPlusEquals, scaleEquals, zero

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface gov.sandia.cognition.math.matrix.Vectorizable

convertFromVector, convertToVector

Methods inherited from interface gov.sandia.cognition.util.Triple

getFirst, getSecond, getThird

Method Detail

getX

double getX()

Gets the value of the first dimension (x).

Returns:

The value of the first dimension (x).

setX

void setX(double x)

Sets the value of the first dimension (x).

Parameters:

x - The value for the first dimension (x).

getY

double getY()

Gets the value of the second dimension (y).

Returns:

The value of the second dimension (y).

setY

void setY(double y)

Sets the value of the second dimension (y).

Parameters:

y - The value of the second dimension (y).

getZ

double getZ()

Gets the value of the third dimension (z).

Returns:

The value of the third dimension (z).

setZ

void setZ(double z)

Sets the value of the third dimension (z).

Parameters:

z - The value of the third dimension (z).

setXYZ

void setXYZ(double x,
            double y,
            double z)

Sets the value of all three dimensions of this vector.

Parameters:

x - The value of the first dimension (x).

y - The value of the second dimension (y).

z - The value of the third dimension (z).