Package com.singularsys.extensions.matrix

Class AbstractMatrixField

java.lang.Object

com.singularsys.extensions.matrix.AbstractMatrixField

All Implemented Interfaces:

FieldI, IntegerConvertor, MatrixFieldI, JepComponent, Serializable

Direct Known Subclasses:

DoubleMatrixField, SequenceMatrixField

public abstract class AbstractMatrixField
extends Object
implements MatrixFieldI

An abstract base class for implementations of MatrixFieldI. In general the GenericMatrixField should be used. This class is for case when the matrix does not implement GenericMatrix such as an double[][].

Since:

Jep 3.5 / Extensions 2.0

Author:

Richard Morris

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final MatrixFactoryI	mf

Constructor Summary

Constructors

Constructor	Description
AbstractMatrixField(MatrixFactoryI mf)	Construction
AbstractMatrixField(MatrixFactoryI mf, boolean skipElements)	Constructor where operations on the base field can be switched off.

Method Summary

Modifier and Type	Method	Description
Object	add(Object l, Object r)	Adds two matrices or vectors.
protected abstract Object	addEle(Object l, Object r)
protected abstract MatrixI	addMM(MatrixI l, MatrixI r)
protected abstract VectorI	addVV(VectorI lv, VectorI rv)	Add two vectors
Boolean	and(Object l, Object r)	Logical and.
protected abstract Boolean	andEle(Object l, Object r)
Object	cross(Object l, Object r)	Default inefficient implementation.
protected Object	crossVV(VectorI lv, VectorI rv)	Default inefficient implementation.
Object	det(Object m)	Determinant of a matrix
protected Object	detM(MatrixI mat)	Return the determinant of a matrix.
Object	div(Object l, Object r)	Divides two members of the field.
protected abstract Object	divEle(Object l, Object r)
protected abstract MatrixI	divMO(MatrixI l, Object r)
protected abstract VectorI	divVO(VectorI l, Object r)
Object	dot(Object l, Object r)	The dot product of two vectors
protected Object	dotVV(VectorI lv, VectorI rv)	Default inefficient implementation.
Object	elementValue(Object o)	Try to convert argument to base type of elements of Vector/Matrix.
Boolean	eq(Object l, Object r)	Equals
protected abstract Boolean	eqEle(Object l, Object r)
protected abstract Boolean	eqMM(MatrixI l, MatrixI r)
protected abstract Boolean	eqVV(VectorI l, VectorI r)
Boolean	ge(Object l, Object r)	Greater or equal to
protected abstract Boolean	geEle(Object l, Object r)
Boolean	gt(Object l, Object r)	Greater than
protected abstract Boolean	gtEle(Object l, Object r)
Object	inv(Object l)	Returns the inverse of a square matrix.
protected MatrixI	invM(MatrixI mat)	Finds the inverse of a matrix.
Boolean	le(Object l, Object r)	Less than or equals to
protected abstract Boolean	leEle(Object l, Object r)
Boolean	lt(Object l, Object r)	Less than
protected abstract Boolean	ltEle(Object l, Object r)
protected MatrixI	minor(MatrixI m, int row, int col)	Finds the minor matrix formed by excluding a row and vector
Object	mod(Object l, Object r)	The modulus of two members of the field.
protected abstract Object	modEle(Object l, Object r)
Object	mul(Object l, Object r)	Multiplies two members of the field.
protected abstract Object	mulEle(Object l, Object r)
protected abstract MatrixI	mulMM(MatrixI l, MatrixI r)
protected abstract MatrixI	mulMO(MatrixI l, Object r)
protected abstract VectorI	mulMV(MatrixI l, VectorI r)
protected void	mulRow(MatrixI m, int row, Object mul)	In place multiply all elements of a row by a number
protected abstract VectorI	mulVM(VectorI l, MatrixI r)
protected abstract VectorI	mulVO(VectorI l, Object r)
protected abstract MatrixI	mulVV(VectorI l, VectorI r)
Boolean	ne(Object l, Object r)	Not Equals
protected abstract Boolean	neEle(Object l, Object r)
Object	neg(Object l)	The negation -x of an element.
protected abstract Object	negEle(Object l)
protected abstract MatrixI	negM(MatrixI l)
protected abstract VectorI	negV(VectorI lv)
protected abstract Boolean	neMM(MatrixI l, MatrixI r)
protected abstract Boolean	neVV(VectorI l, VectorI r)
Boolean	not(Object l)	Logical not.
protected abstract Boolean	notEle(Object l)
Boolean	or(Object l, Object r)	Logical or.
protected abstract Boolean	orEle(Object l, Object r)
Object	pow(Object l, Object r)	The power operator.
protected abstract Object	powEle(Object l, Object r)
Object	solve(Object A, Object B)	Solve equation A * X = B
protected MatrixI	solveMM(MatrixI A, MatrixI b)
protected VectorI	solveMV(MatrixI A, VectorI b)
Object	sub(Object l, Object r)	Subtract two members of the field.
protected abstract Object	subEle(Object l, Object r)
protected abstract MatrixI	subMM(MatrixI l, MatrixI r)
protected void	subtractMul(MatrixI m, int targetRow, int sourceRow, Object mul)	In place subtract a multiple of the source row from the target m(t,j) = m(t,j) - mul * m(s,j)
protected abstract VectorI	subVV(VectorI lv, VectorI rv)
protected void	swapRows(MatrixI m, int i, int j)	In place swap of two rows
Object	trace(Object l)	Trace of a matrix
protected Object	traceM(MatrixI m)	Default inefficient implementation.
Object	trans(Object l)	Transpose of a matrix
protected Object	transM(MatrixI mat)
Object	transV(VectorI l)	Transpose of a vector, i.e. a copy of the vector.

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.FieldI

getOne, getZero

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

convertFromInt, convertToInt

Methods inherited from interface com.singularsys.jep.JepComponent

getLightWeightInstance, init

Field Details

mf

protected final MatrixFactoryI mf

Constructor Details

AbstractMatrixField

public AbstractMatrixField(MatrixFactoryI mf)

Construction

Parameters:

mf - corresponding matrix factory

AbstractMatrixField

public AbstractMatrixField(MatrixFactoryI 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 Object addEle(Object l,
 Object r)
                          throws EvaluationException

Throws:

EvaluationException

addVV

protected abstract VectorI addVV(VectorI lv,
 VectorI rv)
                          throws EvaluationException

Add two vectors

Parameters:

lv - lhs vector

rv - rhs vector

Returns:

the sum of the vectors

Throws:

EvaluationException - if the dimension do not match

addMM

protected abstract MatrixI addMM(MatrixI l,
 MatrixI r)
                          throws EvaluationException

Throws:

EvaluationException

add

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

Adds two matrices or vectors. Calls either addVV(VectorI, VectorI), addMM(MatrixI, MatrixI) or addEle(Object, Object) * depending on the arguments.

Specified by:

add in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

the sum of the arguments if l and r are of both of type VectorI or both of type MatrixI or null otherwise.

Throws:

EvaluationException - if sizes do not match or attempts to add object of other types

elementValue

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

subEle

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

Throws:

EvaluationException

subVV

protected abstract VectorI subVV(VectorI lv,
 VectorI rv)
                          throws EvaluationException

Throws:

EvaluationException

subMM

protected abstract MatrixI subMM(MatrixI l,
 MatrixI r)
                          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

negEle

protected abstract Object negEle(Object l)
                          throws EvaluationException

Throws:

EvaluationException

negV

protected abstract VectorI negV(VectorI lv)
                         throws EvaluationException

Throws:

EvaluationException

negM

protected abstract MatrixI negM(MatrixI l)
                         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

mulEle

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

Throws:

EvaluationException

mulVO

protected abstract VectorI mulVO(VectorI l,
 Object r)
                          throws EvaluationException

Throws:

EvaluationException

mulMO

protected abstract MatrixI mulMO(MatrixI l,
 Object r)
                          throws EvaluationException

Throws:

EvaluationException

mulVV

protected abstract MatrixI mulVV(VectorI l,
 VectorI r)
                          throws EvaluationException

Throws:

EvaluationException

mulVM

protected abstract VectorI mulVM(VectorI l,
 MatrixI r)
                          throws EvaluationException

Throws:

EvaluationException

mulMV

protected abstract VectorI mulMV(MatrixI l,
 VectorI r)
                          throws EvaluationException

Throws:

EvaluationException

mulMM

protected abstract MatrixI mulMM(MatrixI l,
 MatrixI r)
                          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

divEle

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

Throws:

EvaluationException

divVO

protected abstract VectorI divVO(VectorI l,
 Object r)
                          throws EvaluationException

Throws:

EvaluationException

divMO

protected abstract MatrixI divMO(MatrixI l,
 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

modEle

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

Throws:

EvaluationException

mod

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

Description copied from interface: FieldI

The modulus of two members of the field.

Specified by:

mod 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

powEle

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

Throws:

EvaluationException

pow

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

Description copied from interface: FieldI

The power operator.

Specified by:

pow 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

eqEle

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

Throws:

EvaluationException

eqVV

protected abstract Boolean eqVV(VectorI l,
 VectorI r)
                         throws EvaluationException

Throws:

EvaluationException

eqMM

protected abstract Boolean eqMM(MatrixI l,
 MatrixI r)
                         throws EvaluationException

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

neEle

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

Throws:

EvaluationException

neVV

protected abstract Boolean neVV(VectorI l,
 VectorI r)
                         throws EvaluationException

Throws:

EvaluationException

neMM

protected abstract Boolean neMM(MatrixI l,
 MatrixI r)
                         throws EvaluationException

Throws:

EvaluationException

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

andEle

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

Throws:

EvaluationException

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

orEle

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

Throws:

EvaluationException

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

notEle

protected abstract Boolean notEle(Object l)
                           throws EvaluationException

Throws:

EvaluationException

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

gtEle

protected abstract Boolean gtEle(Object l,
 Object r)
                          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

geEle

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

Throws:

EvaluationException

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

ltEle

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

Throws:

EvaluationException

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

leEle

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

Throws:

EvaluationException

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

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

transM

protected Object transM(MatrixI mat)
                 throws EvaluationException

Throws:

EvaluationException

transV

public Object transV(VectorI l)
              throws EvaluationException

Transpose of a vector, i.e. a copy of the vector. Default implementation is just to inefficiently return a copy of the vector.

Parameters:

l - a vector

Returns:

a new vector

Throws:

EvaluationException - if necessary

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

dotVV

protected Object dotVV(VectorI lv,
 VectorI rv)
                throws EvaluationException

Default inefficient implementation. Will only be called if vectors are of equal lengths

Parameters:

lv - lhs vector

rv - rhs vector

Returns:

The dot product

Throws:

EvaluationException - on error

cross

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

Default inefficient implementation.

Specified by:

cross in interface MatrixFieldI

Parameters:

l -

r -

Returns:

a vector with the cross product

Throws:

EvaluationException - if vectors not of length 3

crossVV

protected Object crossVV(VectorI lv,
 VectorI rv)
                  throws EvaluationException

Default inefficient implementation.

Throws:

EvaluationException

traceM

protected Object traceM(MatrixI m)
                 throws EvaluationException

Default inefficient implementation.

Throws:

EvaluationException

trace

public Object trace(Object l)
             throws EvaluationException

Trace of a matrix

Specified by:

trace in interface MatrixFieldI

Parameters:

l - the matrix

Returns:

the trace

Throws:

EvaluationException

det

public Object det(Object m)
           throws EvaluationException

Determinant of a matrix

Specified by:

det in interface MatrixFieldI

Parameters:

m - the matrix

Returns:

the determinant

Throws:

EvaluationException - if matrix is not square.

detM

protected Object detM(MatrixI mat)
               throws EvaluationException

Return the determinant of a matrix. Does not check sizes.

Parameters:

mat - the matrix

Returns:

the determinant

Throws:

EvaluationException - on error

minor

protected MatrixI minor(MatrixI m,
 int row,
 int col)
                 throws EvaluationException

Finds the minor matrix formed by excluding a row and vector

Parameters:

m - the matrix

row - row to remove

col - column to remove

Returns:

new smaller matrix

Throws:

EvaluationException - on error

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 - on error

mulRow

protected void mulRow(MatrixI m,
 int row,
 Object mul)
               throws EvaluationException

In place multiply all elements of a row by a number

Parameters:

m - the matrix

row - the row to multiply

mul - value to multiply by

Throws:

EvaluationException - on error

subtractMul

protected void subtractMul(MatrixI m,
 int targetRow,
 int sourceRow,
 Object mul)
                    throws EvaluationException

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

Parameters:

m - matrix to operate on

targetRow - row to modify

sourceRow - source row

mul - multiplier

Throws:

EvaluationException

invM

protected MatrixI invM(MatrixI mat)
                throws EvaluationException

Finds the inverse of a matrix. Default implementation uses Gauss-Jordan with partial pivoting

Parameters:

mat - the matrix

Returns:

the inverse

Throws:

EvaluationException - if matrix is singular

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(MatrixI A,
 MatrixI b)
                   throws EvaluationException

Throws:

EvaluationException

solveMV

protected VectorI solveMV(MatrixI A,
 VectorI 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