maspack.matrix

Class Matrix3x1

java.lang.Object

maspack.matrix.MatrixBase

maspack.matrix.DenseMatrixBase

maspack.matrix.Matrix3x1

All Implemented Interfaces:

java.lang.Cloneable, DenseMatrix, LinearTransformNd, Matrix, VectorObject<Matrix3x1>, Clonable, Scannable

Direct Known Subclasses:

Matrix3x1Block

public class Matrix3x1
extends DenseMatrixBase
implements VectorObject<Matrix3x1>

Implements a 3 x 1 matrix.

Nested Class Summary

Nested classes/interfaces inherited from interface maspack.matrix.Matrix

Matrix.Partition, Matrix.WriteFormat

Field Summary

Fields

Modifier and Type	Field and Description
double	m00
double	m10
double	m20
static Matrix3x1	ZERO Global zero matrix.

Fields inherited from interface maspack.matrix.Matrix

INDEFINITE, POSITIVE_DEFINITE, SPD, SYMMETRIC

Constructor Summary

Constructors

Constructor and Description
Matrix3x1() Creates a new Matrix3x1.

Method Summary

Modifier and Type	Method and Description
void	add(Matrix M) Adds this matrix to M and places the result in this matrix.
void	add(Matrix3x1 M) Adds the contents of a Matrix3x1 to this matrix block.
void	add(Matrix3x1 M1, Matrix3x1 M2) Computes M1 + M2 and places the result in this matrix.
void	addObj(Matrix3x1 M1) Adds v1 to this vector.
Matrix3x1	clone() Creates a clone of this matrix.
int	colSize() Number of columns in the matrix associated with this transformation.
double	dot(Vector3d v) Forms the dot product of this Matrix3x1 with a vector.
boolean	epsilonEquals(Matrix3x1 M1, double tol) Returns true if the components of this vector are equal to those of v1, within the tolerance tol.
boolean	equals(Matrix3x1 M1)
double	get(int i, int j) Gets a single element of this matrix.
void	get(Vector3d v) Gets the contents of this Matrix3x1 into a Vector3d.
void	mulAdd(Matrix M1, Matrix M2) Multiplies M1 by M2 and places the result in this matrix.
static void	mulScaledTransposeRightAdd(Matrix3d MR, double s, Matrix3x1 M1, Matrix3x1 M2) Computes
void	mulTransposeLeftAdd(Matrix M1, Matrix M2) Multiplies M1^T by M2 and places the result in this matrix.
void	mulTransposeRightAdd(Matrix M1, Matrix M2) Multiplies M1 by M2^T and places the result in this matrix.
void	negate() Negates this matrix in place.
void	negate(Matrix3x1 M) Sets this matrix to the negative of M.
int	rowSize() Number of rows in the matrix associated with this transformation.
void	scale(double s) Scales the elements of this matrix by s.
void	scale(double s, Matrix3x1 M) Computes s M and places the result in this matrix.
void	scale(double s, Vector3d v1) Scales the elements of vector v1 by s and places the results in this vector.
void	scaledAdd(double s, Matrix M) Scales the matrix M and add the result to this matrix.
void	scaledAdd(double s, Matrix3x1 M) Adds the scaled contents of a Matrix3x1 to this matrix block.
void	scaledAdd(double s, Matrix3x1 M1, Matrix3x1 M2) Computes s M1 + M2 and places the result in this matrix.
void	scaledAdd(double s, Vector3d v1) Computes s v1 and adds the result to this matrix.
void	scaledAddObj(double s, Matrix3x1 M1) Scales v1 by s and adds it to this vector.
void	scaleObj(double s) Scales this vector by s.
void	set(double[] values) Sets the elements of this matrix from an array of doubles.
void	set(int i, int j, double value) Sets a single element of this matrix.
void	set(Matrix M) Sets the size and values of this matrix to those of another matrix.
void	set(Matrix3x1 M) Sets the contents of this Matrix3x1 to those of a specified block.
void	set(Vector3d v) Sets the contents of this Matrix3x1 from a Vector3d.
void	setColumn(int j, double[] values) Sets a column of this matrix from an array of doubles.
void	setRow(int i, double[] values) Set a row of this matrix from an array of doubles.
void	setZero() Sets the elements of this matrix to zero.
void	sub(Matrix M) Subtracts this matrix from M and places the result in this matrix.
void	sub(Matrix3x1 M) Subtracts the contents of a Matrix3x1 from this matrix block.
void	sub(Matrix3x1 M1, Matrix3x1 M2) Computes M1 - M2 places the result in this matrix.
void	transpose(Matrix1x3 M) Sets this matrix to the transpose of M
java.lang.String	transposeToString()
java.lang.String	transposeToString(NumberFormat fmt)
java.lang.String	transposeToString(java.lang.String fmtStr)

Methods inherited from class maspack.matrix.DenseMatrixBase

add, checkConsistency, set, set, set, setCCSValues, setColumn, setCRSValues, setRandom, setRow, setSubMatrix

Methods inherited from class maspack.matrix.MatrixBase

containsNaN, determinant, epsilonEquals, equals, frobeniusNorm, frobeniusNormSquared, get, get, getCCSIndices, getCCSIndices, getCCSIndices, getCCSValues, getCCSValues, getCCSValues, getColumn, getColumn, getColumn, getCRSIndices, getCRSIndices, getCRSIndices, getCRSValues, getCRSValues, getCRSValues, getDefaultFormat, getRow, getRow, getRow, getSize, getSubMatrix, hasNaN, idString, infinityNorm, isFixedSize, isSymmetric, isWritable, maxNorm, mul, mul, mul, mulAdd, mulAdd, mulAdd, mulTranspose, mulTranspose, mulTranspose, mulTransposeAdd, mulTransposeAdd, mulTransposeAdd, numNonZeroVals, numNonZeroVals, oneNorm, scan, scan, setCRSValues, setDefaultFormat, setSize, toString, toString, toString, trace, write, write, write, write, write, write, write, writeToFile

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface maspack.matrix.VectorObject

getThreeVectorValue

Methods inherited from interface maspack.util.Scannable

isWritable, scan, write

Methods inherited from interface maspack.matrix.Matrix

determinant, epsilonEquals, equals, frobeniusNorm, frobeniusNormSquared, get, getCCSIndices, getCCSIndices, getCCSIndices, getCCSValues, getCCSValues, getCCSValues, getColumn, getColumn, getColumn, getCRSIndices, getCRSIndices, getCRSIndices, getCRSValues, getCRSValues, getCRSValues, getRow, getRow, getRow, getSize, getSubMatrix, infinityNorm, isFixedSize, isSymmetric, maxNorm, mul, mul, mul, mulAdd, mulAdd, mulAdd, mulTranspose, mulTranspose, mulTranspose, mulTransposeAdd, mulTransposeAdd, mulTransposeAdd, numNonZeroVals, numNonZeroVals, oneNorm, scan, setSize, toString, toString, trace, write, write, write

Field Detail

m00

public double m00

m10

public double m10

m20

public double m20

ZERO

public static final Matrix3x1 ZERO

Global zero matrix. Should not be modified.

Constructor Detail

Matrix3x1

public Matrix3x1()

Creates a new Matrix3x1.

Method Detail

rowSize

public int rowSize()

Number of rows in the matrix associated with this transformation. This will equal the size of the output vector in mul.

Specified by:

rowSize in interface LinearTransformNd

Specified by:

rowSize in interface Matrix

Specified by:

rowSize in class MatrixBase

Returns:

number of rows

colSize

public int colSize()

Number of columns in the matrix associated with this transformation. This will equal the size of the input vector in mul.

Specified by:

colSize in interface LinearTransformNd

Specified by:

colSize in interface Matrix

Specified by:

colSize in class MatrixBase

Returns:

number of columns

get

public double get(int i,
                  int j)

Gets a single element of this matrix.

Specified by:

get in interface Matrix

Specified by:

get in class MatrixBase

Parameters:

i - element row index

j - element column index

Returns:

element value

get

public void get(Vector3d v)

Gets the contents of this Matrix3x1 into a Vector3d.

Parameters:

v - vector to return contents in

set

public void set(int i,
                int j,
                double value)

Sets a single element of this matrix.

Specified by:

set in interface DenseMatrix

Specified by:

set in class DenseMatrixBase

Parameters:

i - element row index

j - element column index

value - element value

set

public void set(double[] values)

Sets the elements of this matrix from an array of doubles. The elements in the array should be stored using row-major order, so that element (i,j) is stored at location i*colSize()+j.

Specified by:

set in interface DenseMatrix

Overrides:

set in class DenseMatrixBase

Parameters:

values - array from which values are copied

setColumn

public void setColumn(int j,
                      double[] values)

Sets a column of this matrix from an array of doubles.

Specified by:

setColumn in interface DenseMatrix

Overrides:

setColumn in class DenseMatrixBase

Parameters:

j - column index

values - array from which column values are copied

setRow

public void setRow(int i,
                   double[] values)

Set a row of this matrix from an array of doubles.

Specified by:

setRow in interface DenseMatrix

Overrides:

setRow in class DenseMatrixBase

Parameters:

i - row index

values - array from which the row is copied

setZero

public void setZero()

Sets the elements of this matrix to zero.

Specified by:

setZero in interface VectorObject<Matrix3x1>

set

public void set(Matrix M)

Description copied from class: DenseMatrixBase

Sets the size and values of this matrix to those of another matrix.

Specified by:

set in interface Matrix

Overrides:

set in class DenseMatrixBase

Parameters:

M - matrix whose size and values are copied

set

public void set(Matrix3x1 M)

Sets the contents of this Matrix3x1 to those of a specified block.

Specified by:

set in interface VectorObject<Matrix3x1>

Parameters:

M - matrix block providing new values

set

public void set(Vector3d v)

Sets the contents of this Matrix3x1 from a Vector3d.

Parameters:

v - vector providing new values

scale

public void scale(double s)

Scales the elements of this matrix by s.

Parameters:

s - scaling factor

scale

public void scale(double s,
                  Matrix3x1 M)

Computes s M and places the result in this matrix.

Parameters:

s - scaling factor

M - matrix to scale

scale

public void scale(double s,
                  Vector3d v1)

Scales the elements of vector v1 by s and places the results in this vector.

Parameters:

s - scaling factor

v1 - vector to be scaled

scaledAdd

public void scaledAdd(double s,
                      Vector3d v1)

Computes s v1 and adds the result to this matrix.

Parameters:

s - scaling factor

v1 - vector to be scaled

add

public void add(Matrix M)

Adds this matrix to M and places the result in this matrix.

Parameters:

M - right-hand matrix

Throws:

ImproperSizeException - if this matrix and M have different sizes

scaledAdd

public void scaledAdd(double s,
                      Matrix M)

Scales the matrix M and add the result to this matrix.

Parameters:

s - scaling factor

M - matrix to be scaled and added

Throws:

ImproperSizeException - if this matrix and M have different sizes

add

public void add(Matrix3x1 M)

Adds the contents of a Matrix3x1 to this matrix block.

Parameters:

M - matrix block to add

add

public void add(Matrix3x1 M1,
                Matrix3x1 M2)

Computes M1 + M2 and places the result in this matrix.

Parameters:

M1 - first matrix to add

M2 - second matrix to add

scaledAdd

public void scaledAdd(double s,
                      Matrix3x1 M)

Adds the scaled contents of a Matrix3x1 to this matrix block.

Parameters:

M - matrix block to add

scaledAdd

public void scaledAdd(double s,
                      Matrix3x1 M1,
                      Matrix3x1 M2)

Computes s M1 + M2 and places the result in this matrix.

Parameters:

s - scaling factor

M1 - matrix to be scaled

M2 - matrix to be added

negate

public void negate(Matrix3x1 M)

Sets this matrix to the negative of M.

Parameters:

M - matrix to negate

negate

public void negate()

Negates this matrix in place.

sub

public void sub(Matrix M)

Subtracts this matrix from M and places the result in this matrix.

Parameters:

M - right-hand matrix

Throws:

ImproperSizeException - if this matrix and M have different sizes

sub

public void sub(Matrix3x1 M)

Subtracts the contents of a Matrix3x1 from this matrix block.

Parameters:

M - matrix block to subtract

sub

public void sub(Matrix3x1 M1,
                Matrix3x1 M2)

Computes M1 - M2 places the result in this matrix.

Parameters:

M1 - first matrix

M2 - matrix to subtract

dot

public double dot(Vector3d v)

Forms the dot product of this Matrix3x1 with a vector.

Parameters:

v - vector to take dot product with

mulAdd

public void mulAdd(Matrix M1,
                   Matrix M2)

Multiplies M1 by M2 and places the result in this matrix.

Parameters:

M1 - left matrix term

M2 - right matrix term

mulTransposeRightAdd

public void mulTransposeRightAdd(Matrix M1,
                                 Matrix M2)

Multiplies M1 by M2^T and places the result in this matrix.

Parameters:

M1 - left matrix term

M2 - right matrix term

mulTransposeLeftAdd

public void mulTransposeLeftAdd(Matrix M1,
                                Matrix M2)

Multiplies M1^T by M2 and places the result in this matrix.

Parameters:

M1 - left matrix term

M2 - right matrix term

mulScaledTransposeRightAdd

public static void mulScaledTransposeRightAdd(Matrix3d MR,
                                              double s,
                                              Matrix3x1 M1,
                                              Matrix3x1 M2)

Computes

s M1 * M2^T

and adds the result to matrix MR.

Parameters:

MR - matrix to add result to

s - scale value

M1 - left matrix

M2 - right matrix transpose

transposeToString

public java.lang.String transposeToString()

transposeToString

public java.lang.String transposeToString(java.lang.String fmtStr)

transposeToString

public java.lang.String transposeToString(NumberFormat fmt)

transpose

public void transpose(Matrix1x3 M)

Sets this matrix to the transpose of M

Parameters:

M - matrix to take the transpose of

clone

public Matrix3x1 clone()

Creates a clone of this matrix.

Specified by:

clone in interface Clonable

Overrides:

clone in class java.lang.Object

scaleObj

public void scaleObj(double s)

Scales this vector by s.

Specified by:

scaleObj in interface VectorObject<Matrix3x1>

addObj

public void addObj(Matrix3x1 M1)

Adds v1 to this vector.

Specified by:

addObj in interface VectorObject<Matrix3x1>

scaledAddObj

public void scaledAddObj(double s,
                         Matrix3x1 M1)

Scales v1 by s and adds it to this vector.

Specified by:

scaledAddObj in interface VectorObject<Matrix3x1>

equals

public boolean equals(Matrix3x1 M1)

epsilonEquals

public boolean epsilonEquals(Matrix3x1 M1,
                             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.

Specified by:

epsilonEquals in interface VectorObject<Matrix3x1>