org.monospark.geometrix.matrix

Class Mat<R extends OneMin,C extends OneMin>

java.lang.Object

org.monospark.geometrix.GeometrixObject

org.monospark.geometrix.matrix.Mat<R,C>

Type Parameters:

R - the row-dimension of the matrix

C - the column-dimension of the matrix

public final class Mat<R extends OneMin,C extends OneMin>
extends GeometrixObject

Represents a R*C matrix.

See Also:

MatHelper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mat.ElementOrder

Method Summary

Modifier and Type	Method and Description
static <R extends OneMin,C extends OneMin> Mat<R,C>	create(R rowDim, C columnDim, Mat.ElementOrder order, double... elements) Constructs a matrix using elements from an array.
boolean	equals(java.lang.Object o)
static Mat<Four,Four>	fourByFour(Mat.ElementOrder order, double... elements) Constructs a new four by four Mat object.
C	getColumnDimension()
double	getElement(int row, int column) Gets the element of this matrix at a specified location.
R	getRowDimension()
int	hashCode()
static <D extends OneMin> Mat<D,D>	identity(D dim) Creates a new identity matrix with a specified dimension.
static Mat<One,One>	oneByOne(Mat.ElementOrder order, double element) Constructs a new one by one Mat object.
boolean	resembles(java.lang.Object o)
static Mat<Three,Three>	threeByThree(Mat.ElementOrder order, double... elements) Constructs a new three by three Mat object.
java.lang.String	toString()
static Mat<Two,Two>	twoByTwo(Mat.ElementOrder order, double... elements) Constructs a new two by two Mat object.
static <R extends OneMin,C extends OneMin> Mat<R,C>	zero(R rowDim, C columnDim) Constructs a new Mat object which contains only zeros.

Methods inherited from class java.lang.Object

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

Method Detail

zero

public static <R extends OneMin,C extends OneMin> Mat<R,C> zero(R rowDim,
                                                                C columnDim)

Constructs a new Mat object which contains only zeros.

Parameters:

rowDim - the row-dimension of the matrix

columnDim - the column-dimension of the matrix

Throws:

java.lang.NullPointerException - if one argument is null

oneByOne

public static Mat<One,One> oneByOne(Mat.ElementOrder order,
                                    double element)

Constructs a new one by one Mat object.

Parameters:

element - the one and only elment of the matrix

Throws:

java.lang.IllegalArgumentException - if element is equal to (+/-)Infinity or NaN

twoByTwo

public static Mat<Two,Two> twoByTwo(Mat.ElementOrder order,
                                    double... elements)

Constructs a new two by two Mat object.

Parameters:

elements - the elements of the matrix in row-major order

Throws:

java.lang.IllegalArgumentException - if the amount of elements is not 4

java.lang.IllegalArgumentException - if one element is equal to (+/-)Infinity or NaN

threeByThree

public static Mat<Three,Three> threeByThree(Mat.ElementOrder order,
                                            double... elements)

Constructs a new three by three Mat object.

Parameters:

elements - the elements of the matrix in row-major order

Throws:

java.lang.IllegalArgumentException - if the amount of elements is not 9

java.lang.IllegalArgumentException - if one element is equal to (+/-)Infinity or NaN

fourByFour

public static Mat<Four,Four> fourByFour(Mat.ElementOrder order,
                                        double... elements)

Constructs a new four by four Mat object.

Parameters:

elements - the elements of the matrix in row-major order

Throws:

java.lang.IllegalArgumentException - if the amount of elments is not 16

java.lang.IllegalArgumentException - if one element is equal to (+/-)Infinity or NaN

identity

public static <D extends OneMin> Mat<D,D> identity(D dim)

Creates a new identity matrix with a specified dimension.

Parameters:

dim - the row-dimension and column-dimension of the matrix

Throws:

java.lang.NullPointerException - if dim is null

create

public static <R extends OneMin,C extends OneMin> Mat<R,C> create(R rowDim,
                                                                  C columnDim,
                                                                  Mat.ElementOrder order,
                                                                  double... elements)

Constructs a matrix using elements from an array.

Parameters:

rowDim - the row-dimension of the matrix

columnDim - the column-dimension of the matrix

order - the order of the elements in the elements array

elements - the elements of the matrix

Returns:

a matrix filled with the specified values

Throws:

java.lang.NullPointerException - if one parameter is null

java.lang.IllegalArgumentException - if the specified dimensions and the amount of values doesn't match

java.lang.IllegalArgumentException - if at least one value is equal either to (+/-)Infinity or NaN

getElement

public double getElement(int row,
                         int column)

Gets the element of this matrix at a specified location.

Parameters:

row - the row-location of the element

column - the column-location of the element

Returns:

the element of this matrix at [row][column]

Throws:

java.lang.IllegalArgumentException - if row or column is out of bounds

resembles

public boolean resembles(java.lang.Object o)

Specified by:

resembles in class GeometrixObject

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class GeometrixObject

hashCode

public int hashCode()

Specified by:

hashCode in class GeometrixObject

toString

public java.lang.String toString()

Specified by:

toString in class GeometrixObject

getRowDimension

public R getRowDimension()

Returns:

the row-dimension of this matrix

getColumnDimension

public C getColumnDimension()

Returns:

the column-dimension of this matrix