maspack.matrix

Class Matrix1x1

java.lang.Object

maspack.matrix.MatrixBase

maspack.matrix.DenseMatrixBase

maspack.matrix.Matrix1x1

All Implemented Interfaces:

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

Direct Known Subclasses:

Matrix1x1Block

public class Matrix1x1
extends DenseMatrixBase
implements VectorObject<Matrix1x1>

Implements a 1 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
static Matrix1x1	ZERO Global zero matrix.

Fields inherited from interface maspack.matrix.Matrix

INDEFINITE, POSITIVE_DEFINITE, SPD, SYMMETRIC

Constructor Summary

Constructors

Constructor and Description
Matrix1x1() Creates a new Matrix1x1.

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(Matrix1x1 M) Adds the contents of a Matrix1x1 to this matrix block.
void	add(Matrix1x1 M1, Matrix1x1 M2) Computes M1 + M2 and places the result in this matrix.
void	addObj(Matrix1x1 M1) Adds v1 to this vector.
Matrix1x1	clone() Creates a clone of this matrix.
int	colSize() Number of columns in the matrix associated with this transformation.
boolean	epsilonEquals(Matrix1x1 M1, double tol) Returns true if the components of this vector are equal to those of v1, within the tolerance tol.
boolean	equals(Matrix1x1 M1)
double	get(int i, int j) Gets a single element of this matrix.
void	mulAdd(Matrix M1, Matrix M2) Multiplies M1 by M2 and places the result in this matrix.
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(Matrix1x1 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, Matrix1x1 M) Computes s M and places the result in this matrix.
void	scaledAdd(double s, Matrix M) Scales the matrix M and add the result to this matrix.
void	scaledAdd(double s, Matrix1x1 M) Adds the scaled contents of a Matrix1x1 to this matrix block.
void	scaledAdd(double s, Matrix1x1 M1, Matrix1x1 M2) Computes s M1 + M2 and places the result in this matrix.
void	scaledAddObj(double s, Matrix1x1 M1) Scales v1 by s and adds it to this vector.
void	scaleObj(double s) Scales this vector by s.
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(Matrix1x1 M) Sets the contents of this Matrix1x1 to those of a specified block.
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(Matrix1x1 M) Subtracts the contents of a Matrix1x1 from this matrix block.
void	sub(Matrix1x1 M1, Matrix1x1 M2) Computes M1 - M2 places the result in this matrix.
void	transpose(Matrix1x1 M) Sets this matrix to the transpose of M

Methods inherited from class maspack.matrix.DenseMatrixBase

add, checkConsistency, set, set, set, set, setCCSValues, setColumn, setColumn, setCRSValues, setRandom, setRow, 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

ZERO

public static final Matrix1x1 ZERO

Global zero matrix. Should not be modified.

Constructor Detail

Matrix1x1

public Matrix1x1()

Creates a new Matrix1x1.

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

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

setZero

public void setZero()

Sets the elements of this matrix to zero.

Specified by:

setZero in interface VectorObject<Matrix1x1>

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(Matrix1x1 M)

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

Specified by:

set in interface VectorObject<Matrix1x1>

Parameters:

M - matrix block 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,
                  Matrix1x1 M)

Computes s M and places the result in this matrix.

Parameters:

s - scaling factor

M - matrix to scale

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

scaledAdd

public void scaledAdd(double s,
                      Matrix1x1 M1,
                      Matrix1x1 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

add

public void add(Matrix1x1 M)

Adds the contents of a Matrix1x1 to this matrix block.

Parameters:

M - matrix block to add

add

public void add(Matrix1x1 M1,
                Matrix1x1 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,
                      Matrix1x1 M)

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

Parameters:

M - matrix block to add

negate

public void negate(Matrix1x1 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(Matrix1x1 M)

Subtracts the contents of a Matrix1x1 from this matrix block.

Parameters:

M - matrix block to subtract

sub

public void sub(Matrix1x1 M1,
                Matrix1x1 M2)

Computes M1 - M2 places the result in this matrix.

Parameters:

M1 - first matrix

M2 - matrix to subtract

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

transpose

public void transpose(Matrix1x1 M)

Sets this matrix to the transpose of M

Parameters:

M - matrix to take the transpose of

clone

public Matrix1x1 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<Matrix1x1>

addObj

public void addObj(Matrix1x1 M1)

Adds v1 to this vector.

Specified by:

addObj in interface VectorObject<Matrix1x1>

scaledAddObj

public void scaledAddObj(double s,
                         Matrix1x1 M1)

Scales v1 by s and adds it to this vector.

Specified by:

scaledAddObj in interface VectorObject<Matrix1x1>

equals

public boolean equals(Matrix1x1 M1)

epsilonEquals

public boolean epsilonEquals(Matrix1x1 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<Matrix1x1>