maspack.matrix

Interface VectorObject<T>

All Superinterfaces:

Clonable, java.lang.Cloneable, Scannable

All Known Implementing Classes:

CubaturePoint3d, FrameBlock, IntersectionPoint, Matrix1x1, Matrix1x1Block, Matrix1x3, Matrix1x3Block, Matrix1x6, Matrix1x6Block, Matrix2d, Matrix2x2Block, Matrix2x3, Matrix2x3Block, Matrix2x6, Matrix2x6Block, Matrix3d, Matrix3x1, Matrix3x1Block, Matrix3x2, Matrix3x2Block, Matrix3x3Block, Matrix3x3DiagBlock, Matrix3x4, Matrix3x4Block, Matrix3x6, Matrix3x6Block, Matrix4d, Matrix4x3, Matrix4x3Block, Matrix4x4Block, Matrix6d, Matrix6dBlock, Matrix6dDiagBlock, Matrix6x1, Matrix6x1Block, Matrix6x2, Matrix6x2Block, Matrix6x3, Matrix6x3Block, MatrixNd, MatrixNdBlock, Point2d, Point3d, QuadraturePoint, SpatialInertia, SubMatrixNd, Vector2d, Vector3d, Vector4d, VectorNd

public interface VectorObject<T>
extends Scannable, Clonable

Defines basic vector operations for a type T. The scale, add, and scaledAdd operations are currently named scaleObj(), addObj() and scaledAddObj(), since the corresponding scale(), add() and scaledAdd() methods in the Vector and Matrix subclasses sometimes may incompatitable return types (some return a reference to their object, while others return void).

Method Summary

Modifier and Type	Method and Description
void	addObj(T v1) Adds v1 to this vector.
boolean	epsilonEquals(T v1, double tol) Returns true if the components of this vector are equal to those of v1, within the tolerance tol.
default boolean	getThreeVectorValue(Vector3d vec) Where possible, maps or projects this VectorObject onto a 3-vector.
void	scaledAddObj(double s, T v1) Scales v1 by s and adds it to this vector.
void	scaleObj(double s) Scales this vector by s.
void	set(T v1) Sets this vector to v1
void	setZero() Sets this vector to zero.

Methods inherited from interface maspack.util.Scannable

isWritable, scan, write

Methods inherited from interface maspack.util.Clonable

clone

Method Detail

scaleObj

void scaleObj(double s)

Scales this vector by s.

addObj

void addObj(T v1)

Adds v1 to this vector.

scaledAddObj

void scaledAddObj(double s,
                  T v1)

Scales v1 by s and adds it to this vector.

set

void set(T v1)

Sets this vector to v1

setZero

void setZero()

Sets this vector to zero.

epsilonEquals

boolean epsilonEquals(T v1,
                      double tol)

Returns true if the components of this vector are equal to those of v1, within the tolerance tol. If tol = 0, then exact equality is required.

getThreeVectorValue

default boolean getThreeVectorValue(Vector3d vec)

Where possible, maps or projects this VectorObject onto a 3-vector. Currently used for rendering vector fields.