Package com.singularsys.extensions.matrix.genericmat

Class GenericMatrixField<E>

java.lang.Object

com.singularsys.extensions.matrix.genericmat.GenericMatrixField<E>

Type Parameters:

E - Type of the individual elements.

Subclasses should implement the methods addEle(Object, Object) to add elements of the base field.

All Implemented Interfaces:

FieldI, IntegerConvertor, MatrixFieldI, JepComponent, Serializable

Direct Known Subclasses:

ComplexMatrixField, FieldMatrixField, GenericFieldMatrixField, SimpleMatrixField

public abstract class GenericMatrixField<E>
extends Object
implements MatrixFieldI

A Generic matrix field providing default implementations for all operations. Sub classes just need to provide implementations of addEle(Object, Object) etc.

Author:

Richard Morris

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final GenericMatrixFactory<E>	mf

Constructor Summary

Constructors

Constructor	Description
GenericMatrixField(GenericMatrixFactory<E> mf)	Standard constructor.
GenericMatrixField(GenericMatrixFactory<E> mf, boolean skipElements)	Constructor where operations on the base field can be switched off.

Method Summary

Modifier and Type	Method	Description
protected GenericMatrix<E>	add(GenericMatrix<E> lm, GenericMatrix<E> rm)
protected GenericVector<E>	add(GenericVector<E> lv, GenericVector<E> rv)
Object	add(Object l, Object r)	Add two members of the field.
protected abstract E	addEle(E l, E r)	Adds two elements of the vector/matrix
Boolean	and(Object l, Object r)	Logical and.
protected abstract Boolean	andEle(E l, E r)
protected E	calcSize(E ele)	Get the current "size" of an element
protected boolean	cmpSize(E size, E max)	Compare current "size" to maximum.
Object	cross(GenericVector<E> lv, GenericVector<E> rv)
Object	cross(Object l, Object r)	The cross product of two vectors
protected E	det(GenericMatrix<E> l)
Object	det(Object l)	The determinant of a matrix
protected GenericMatrix<E>	div(GenericMatrix<E> lm, Object r)
protected GenericVector<E>	div(GenericVector<E> lv, Object r)
Object	div(Object l, Object r)	Divides two members of the field.
protected abstract E	divEle(E l, E r)
protected E	dot(GenericVector<E> lv, GenericVector<E> rv)
Object	dot(Object l, Object r)	The dot product of two vectors
E	elementValue(Object o)	Try to convert argument to base type of elements of Vector/Matrix.
protected boolean	eq(GenericMatrix<E> lm, GenericMatrix<E> rm)
protected boolean	eq(GenericVector<E> lv, GenericVector<E> rv)
Boolean	eq(Object l, Object r)	Equals
protected abstract Boolean	eqEle(E l, E r)
Boolean	ge(Object l, Object r)	Greater or equal to
protected abstract Boolean	geEle(E l, E r)
JepComponent	getLightWeightInstance()	Gets a light-weight instance suitable for using in multiple threads.
abstract E	getOne()	Get the multiplicative identity for this field.
abstract E	getZero()	Get the additive identity for this field
Boolean	gt(Object l, Object r)	Greater than
protected abstract Boolean	gtEle(E l, E r)
Object	inv(Object l)	Returns the inverse of a square matrix.
protected GenericMatrix<E>	invMat(GenericMatrix<E> mat)
Boolean	le(Object l, Object r)	Less than or equals to
protected abstract Boolean	leEle(E l, E r)
Boolean	lt(Object l, Object r)	Less than
protected abstract Boolean	ltEle(E l, E r)
protected GenericMatrix<E>	minor(GenericMatrix<E> l, int row, int col)	Creates the matrix of minors by excluding one row and one column
Object	mod(Object l, Object r)	Mod operation not defined for matrices
protected abstract E	modEle(E l, E r)
protected GenericMatrix<E>	mul(GenericMatrix<E> lm, GenericMatrix<E> rm)
protected GenericVector<E>	mul(GenericMatrix<E> lm, GenericVector<E> rv)
protected GenericMatrix<E>	mul(GenericMatrix<E> lm, Object r)
protected GenericVector<E>	mul(GenericVector<E> lv, GenericMatrix<E> rm)
protected GenericMatrix<E>	mul(GenericVector<E> lv, GenericVector<E> rv)
protected GenericVector<E>	mul(GenericVector<E> lv, Object r)
Object	mul(Object l, Object r)	Multiplies two members of the field.
protected abstract E	mulEle(E l, E r)
Boolean	ne(Object l, Object r)	Not Equals
protected abstract Boolean	neEle(E l, E r)
protected GenericMatrix<E>	neg(GenericMatrix<E> lm)
protected GenericVector<E>	neg(GenericVector<E> lv)
Object	neg(Object l)	The negation -x of an element.
protected abstract E	negEle(E l)
Boolean	not(Object l)	Logical not.
protected abstract Boolean	notEle(E l)
Boolean	or(Object l, Object r)	Logical or.
protected abstract Boolean	orEle(E l, E r)
Object	pow(Object l, Object r)	Pow operation not defined for matrices
protected abstract E	powEle(E l, E r)
Object	solve(Object A, Object B)	Solve equation A * X = B
protected MatrixI	solveMM(GenericMatrix<E> A, GenericMatrix<E> b)
protected VectorI	solveMV(GenericMatrix<E> A, GenericVector<E> b)
protected GenericMatrix<E>	sub(GenericMatrix<E> lm, GenericMatrix<E> rm)
protected GenericVector<E>	sub(GenericVector<E> lv, GenericVector<E> rv)
Object	sub(Object l, Object r)	Subtract two members of the field.
protected abstract E	subEle(E l, E r)
protected void	subtractMul(GenericMatrix<E> m, int targetRow, int sourceRow, E mul)	Subtracts a multiple of the source row from the target m(t,j) = m(t,j) - mul * m(s,j)
protected void	swapRows(MatrixI m, int i, int j)	In place swap of two rows
Object	trace(GenericMatrix<E> l)
Object	trace(Object l)	Returns the trace of a matrix.
protected GenericMatrix<E>	trans(GenericMatrix<E> l)
protected GenericVector<E>	trans(GenericVector<E> l)
Object	trans(Object l)	Transpose of a matrix

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.singularsys.extensions.field.IntegerConvertor

convertFromInt, convertToInt

Methods inherited from interface com.singularsys.jep.JepComponent

init

Field Details

mf

protected final GenericMatrixFactory<E> mf

Constructor Details

GenericMatrixField

public GenericMatrixField(GenericMatrixFactory<E> mf)

Standard constructor.

Parameters:

mf - The factory used to generate matrices

GenericMatrixField

public GenericMatrixField(GenericMatrixFactory<E> mf,
 boolean skipElements)

Constructor where operations on the base field can be switched off. By default, the add operator will add vectors/matrices over a base field and also add elements in that field. So it will calculate (2,3)+(4,5) but also 6+7. Setting skipElements to true means that it will calculate (2,3)+(4,5) but return null if given 6+7. This will need to be specified by some other field. It is not intended to use this constructor but left here for case where it is needed.

Parameters:

mf - The factory used to generate matrices

skipElements - whether to skip operations on the base elements

Method Details

addEle

protected abstract E addEle(E l,
 E r)
                     throws EvaluationException

Adds two elements of the vector/matrix

Parameters:

l - lhs element

r - rhs element

Returns:

their sum

Throws:

EvaluationException

subEle

protected abstract E subEle(E l,
 E r)
                     throws EvaluationException

Throws:

EvaluationException

negEle

protected abstract E negEle(E l)
                     throws EvaluationException

Throws:

EvaluationException

mulEle

protected abstract E mulEle(E l,
 E r)
                     throws EvaluationException

Throws:

EvaluationException

modEle

protected abstract E modEle(E l,
 E r)
                     throws EvaluationException

Throws:

EvaluationException

divEle

protected abstract E divEle(E l,
 E r)
                     throws EvaluationException

Throws:

EvaluationException

powEle

protected abstract E powEle(E l,
 E r)
                     throws EvaluationException

Throws:

EvaluationException

eqEle

protected abstract Boolean eqEle(E l,
 E r)
                          throws EvaluationException

Throws:

EvaluationException

neEle

protected abstract Boolean neEle(E l,
 E r)
                          throws EvaluationException

Throws:

EvaluationException

ltEle

protected abstract Boolean ltEle(E l,
 E r)
                          throws EvaluationException

Throws:

EvaluationException

leEle

protected abstract Boolean leEle(E l,
 E r)
                          throws EvaluationException

Throws:

EvaluationException

gtEle

protected abstract Boolean gtEle(E l,
 E r)
                          throws EvaluationException

Throws:

EvaluationException

geEle

protected abstract Boolean geEle(E l,
 E r)
                          throws EvaluationException

Throws:

EvaluationException

andEle

protected abstract Boolean andEle(E l,
 E r)
                           throws EvaluationException

Throws:

EvaluationException

orEle

protected abstract Boolean orEle(E l,
 E r)
                          throws EvaluationException

Throws:

EvaluationException

notEle

protected abstract Boolean notEle(E l)
                           throws EvaluationException

Throws:

EvaluationException

add

public Object add(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Add two members of the field.

Specified by:

add in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

elementValue

public E elementValue(Object o)
               throws EvaluationException

Try to convert argument to base type of elements of Vector/Matrix. Calls MatrixFactoryI.elementValue(Object) to check base value is correct type.

Parameters:

o - item to convert

Returns:

o

Throws:

EvaluationException - if the argument is a vector or matrix

add

protected GenericVector<E> add(GenericVector<E> lv,
 GenericVector<E> rv)
                        throws EvaluationException

Throws:

EvaluationException

add

protected GenericMatrix<E> add(GenericMatrix<E> lm,
 GenericMatrix<E> rm)
                        throws EvaluationException

Throws:

EvaluationException

sub

public Object sub(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Subtract two members of the field.

Specified by:

sub in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

sub

protected GenericMatrix<E> sub(GenericMatrix<E> lm,
 GenericMatrix<E> rm)
                        throws EvaluationException

Throws:

EvaluationException

sub

protected GenericVector<E> sub(GenericVector<E> lv,
 GenericVector<E> rv)
                        throws EvaluationException

Throws:

EvaluationException

neg

public Object neg(Object l)
           throws EvaluationException

Description copied from interface: FieldI

The negation -x of an element.

Specified by:

neg in interface FieldI

Parameters:

l - the argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

neg

protected GenericMatrix<E> neg(GenericMatrix<E> lm)
                        throws EvaluationException

Throws:

EvaluationException

neg

protected GenericVector<E> neg(GenericVector<E> lv)
                        throws EvaluationException

Throws:

EvaluationException

mul

public Object mul(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Multiplies two members of the field.

Specified by:

mul in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

mul

protected GenericMatrix<E> mul(GenericMatrix<E> lm,
 GenericMatrix<E> rm)
                        throws EvaluationException

Throws:

EvaluationException

mul

protected GenericVector<E> mul(GenericMatrix<E> lm,
 GenericVector<E> rv)
                        throws EvaluationException

Throws:

EvaluationException

mul

protected GenericVector<E> mul(GenericVector<E> lv,
 GenericMatrix<E> rm)
                        throws EvaluationException

Throws:

EvaluationException

mul

protected GenericMatrix<E> mul(GenericVector<E> lv,
 GenericVector<E> rv)
                        throws EvaluationException

Throws:

EvaluationException

mul

protected GenericMatrix<E> mul(GenericMatrix<E> lm,
 Object r)
                        throws EvaluationException

Throws:

EvaluationException

mul

protected GenericVector<E> mul(GenericVector<E> lv,
 Object r)
                        throws EvaluationException

Throws:

EvaluationException

div

public Object div(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Divides two members of the field.

Specified by:

div in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

div

protected GenericVector<E> div(GenericVector<E> lv,
 Object r)
                        throws EvaluationException

Throws:

EvaluationException

div

protected GenericMatrix<E> div(GenericMatrix<E> lm,
 Object r)
                        throws EvaluationException

Throws:

EvaluationException

mod

public Object mod(Object l,
 Object r)
           throws EvaluationException

Mod operation not defined for matrices

Specified by:

mod in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

null

Throws:

EvaluationException

pow

public Object pow(Object l,
 Object r)
           throws EvaluationException

Pow operation not defined for matrices

Specified by:

pow in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

null

Throws:

EvaluationException

eq

public Boolean eq(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Equals

Specified by:

eq in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

ne

public Boolean ne(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Not Equals

Specified by:

ne in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

eq

protected boolean eq(GenericMatrix<E> lm,
 GenericMatrix<E> rm)
              throws EvaluationException

Throws:

EvaluationException

eq

protected boolean eq(GenericVector<E> lv,
 GenericVector<E> rv)
              throws EvaluationException

Throws:

EvaluationException

gt

public Boolean gt(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Greater than

Specified by:

gt in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

ge

public Boolean ge(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Greater or equal to

Specified by:

ge in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

lt

public Boolean lt(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Less than

Specified by:

lt in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

le

public Boolean le(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Less than or equals to

Specified by:

le in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

and

public Boolean and(Object l,
 Object r)
            throws EvaluationException

Description copied from interface: FieldI

Logical and.

Specified by:

and in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

or

public Boolean or(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Logical or.

Specified by:

or in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

not

public Boolean not(Object l)
            throws EvaluationException

Description copied from interface: FieldI

Logical not.

Specified by:

not in interface FieldI

Parameters:

l - argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

det

public Object det(Object l)
           throws EvaluationException

Description copied from interface: MatrixFieldI

The determinant of a matrix

Specified by:

det in interface MatrixFieldI

Parameters:

l -

Returns:

the determinant of mat if it is a matrix

Throws:

EvaluationException

det

protected E det(GenericMatrix<E> l)
         throws EvaluationException

Throws:

EvaluationException

trace

public Object trace(Object l)
             throws EvaluationException

Description copied from interface: MatrixFieldI

Returns the trace of a matrix.

Specified by:

trace in interface MatrixFieldI

Parameters:

l - the matrix

Returns:

the trace

Throws:

EvaluationException

trace

public Object trace(GenericMatrix<E> l)
             throws EvaluationException

Throws:

EvaluationException

minor

protected GenericMatrix<E> minor(GenericMatrix<E> l,
 int row,
 int col)

Creates the matrix of minors by excluding one row and one column

Parameters:

l -

row - the row to exclude

col - the column to exclude

Returns:

matrix of minors

trans

public Object trans(Object l)
             throws EvaluationException

Description copied from interface: MatrixFieldI

Transpose of a matrix

Specified by:

trans in interface MatrixFieldI

Parameters:

l - the matrix

Returns:

a matrix containing the transpose

Throws:

EvaluationException

trans

protected GenericMatrix<E> trans(GenericMatrix<E> l)

trans

protected GenericVector<E> trans(GenericVector<E> l)
                          throws EvaluationException

Throws:

EvaluationException

dot

public Object dot(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: MatrixFieldI

The dot product of two vectors

Specified by:

dot in interface MatrixFieldI

Parameters:

l -

r -

Returns:

the dot product if both arguments are vectors, null otherwise.

Throws:

EvaluationException

dot

protected E dot(GenericVector<E> lv,
 GenericVector<E> rv)
         throws EvaluationException

Throws:

EvaluationException

cross

public Object cross(Object l,
 Object r)
             throws EvaluationException

Description copied from interface: MatrixFieldI

The cross product of two vectors

Specified by:

cross in interface MatrixFieldI

Parameters:

l -

r -

Returns:

a vector with the cross product

Throws:

EvaluationException - if either vectors not of length 3

cross

public Object cross(GenericVector<E> lv,
 GenericVector<E> rv)
             throws EvaluationException

Throws:

EvaluationException

swapRows

protected void swapRows(MatrixI m,
 int i,
 int j)
                 throws EvaluationException

In place swap of two rows

Parameters:

m - matrix

i - index of first row

j - index of second row

Throws:

EvaluationException

subtractMul

protected void subtractMul(GenericMatrix<E> m,
 int targetRow,
 int sourceRow,
 E mul)
                    throws EvaluationException

Subtracts a multiple of the source row from the target m(t,j) = m(t,j) - mul * m(s,j)

Parameters:

m -

targetRow -

sourceRow -

mul -

Throws:

EvaluationException

getZero

public abstract E getZero()

Description copied from interface: FieldI

Get the additive identity for this field

Specified by:

getZero in interface FieldI

Returns:

object representing zero or null if undefined for this field

getOne

public abstract E getOne()

Description copied from interface: FieldI

Get the multiplicative identity for this field.

Specified by:

getOne in interface FieldI

Returns:

object representing one or null if undefined for this field

invMat

protected GenericMatrix<E> invMat(GenericMatrix<E> mat)
                           throws EvaluationException

Throws:

EvaluationException

calcSize

protected E calcSize(E ele)
              throws EvaluationException

Get the current "size" of an element

Parameters:

ele -

Returns:

Throws:

EvaluationException

cmpSize

protected boolean cmpSize(E size,
 E max)
                   throws EvaluationException

Compare current "size" to maximum.

Parameters:

size - current

max - maximum

Returns:

true is size > max

Throws:

EvaluationException

inv

public Object inv(Object l)
           throws EvaluationException

Description copied from interface: MatrixFieldI

Returns the inverse of a square matrix.

Specified by:

inv in interface MatrixFieldI

Parameters:

l - the matrix

Returns:

the trace

Throws:

EvaluationException - if matrix is not square or is singular

solveMM

protected MatrixI solveMM(GenericMatrix<E> A,
 GenericMatrix<E> b)
                   throws EvaluationException

Throws:

EvaluationException

solveMV

protected VectorI solveMV(GenericMatrix<E> A,
 GenericVector<E> b)
                   throws EvaluationException

Throws:

EvaluationException

solve

public Object solve(Object A,
 Object B)
             throws EvaluationException

Description copied from interface: MatrixFieldI

Solve equation A * X = B

Specified by:

solve in interface MatrixFieldI

Parameters:

A - a square matrix

B - either a vector or matrix with same number of rows as A

Returns:

a vector or matrix solving equations

Throws:

EvaluationException - if matrix is not square or is singular

getLightWeightInstance

public JepComponent getLightWeightInstance()

Description copied from interface: JepComponent

Gets a light-weight instance suitable for using in multiple threads.

Specified by:

getLightWeightInstance in interface JepComponent

Returns:

either a new instance, null or 'this'.