Package com.singularsys.extensions.matrix.genericmat

Class GenericFieldMatrixField<E>

java.lang.Object

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

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

Type Parameters:

E - base type for elements

All Implemented Interfaces:

FieldI, IntegerConvertor, MatrixFieldI, JepComponent, Serializable

public class GenericFieldMatrixField<E>
extends GenericMatrixField<E>

A MatrixField where the elements of the matrices and vectors are of type E and the evaluation is carried out using a GenericPowerField of type E. Generally there is no need to provide a concrete subclass just using

 RationalField rf = new RationalField();
 MatrixFactoryI mfact
     = new GenericMatrixFactory<>(rf);
 MatrixFieldI mfield = new GenericFieldMatrixField<>(mfact,rf);
 

A concrete implementation would just need to provide a constructor. An example use is at RationalMatrix2Test.

Since:

Jep 3.5 / Extensions 2.0

See Also:

• GenericMatrixFactory
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final GenericField<E>	base

Fields inherited from class com.singularsys.extensions.matrix.genericmat.GenericMatrixField

mf

Constructor Summary

Constructors

Constructor	Description
GenericFieldMatrixField(GenericMatrixFactory<E> mf, GenericField<E> base)	Standard constructor.
GenericFieldMatrixField(GenericMatrixFactory<E> mf, GenericPowerField<E> base, boolean skipElements)	Constructor where operations on the base field can be switched off.
GenericFieldMatrixField(MatrixFactoryI mf, GenericField<E> base)	Constructor which is easier to use, but has an unchecked cast.

Method Summary

Modifier and Type	Method	Description
protected E	addEle(E l, E r)	Adds two elements of the vector/matrix
protected Boolean	andEle(E l, E r)
Object	convertFromInt(Integer l)	Attempt to convert argument from an integer
Integer	convertToInt(Object l)	Attempt to convert argument to an integer
protected E	divEle(E l, E r)
protected Boolean	eqEle(E l, E r)
Boolean	geEle(E l, E r)
JepComponent	getLightWeightInstance()	Returns this
E	getOne()	Get the multiplicative identity for this field.
E	getZero()	Get the additive identity for this field
Boolean	gtEle(E l, E r)
void	init(Jep jep)	Initialize the component.
Boolean	leEle(E l, E r)
Boolean	ltEle(E l, E r)
protected E	modEle(E l, E r)
protected E	mulEle(E l, E r)
Boolean	neEle(E l, E r)
protected E	negEle(E l)
protected Boolean	notEle(E l)
protected Boolean	orEle(E l, E r)
protected E	powEle(E l, E r)
protected E	subEle(E l, E r)

Methods inherited from class com.singularsys.extensions.matrix.genericmat.GenericMatrixField

add, add, add, and, calcSize, cmpSize, cross, cross, det, det, div, div, div, dot, dot, elementValue, eq, eq, eq, ge, gt, inv, invMat, le, lt, minor, mod, mul, mul, mul, mul, mul, mul, mul, ne, neg, neg, neg, not, or, pow, solve, solveMM, solveMV, sub, sub, sub, subtractMul, swapRows, trace, trace, trans, trans, trans

Methods inherited from class java.lang.Object

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

Field Details

base

protected final GenericField<E> base

Constructor Details

GenericFieldMatrixField

public GenericFieldMatrixField(GenericMatrixFactory<E> mf,
 GenericField<E> base)

Standard constructor.

Parameters:

mf - The factory used to generate matrices

base - base field for calculations on elements

GenericFieldMatrixField

public GenericFieldMatrixField(MatrixFactoryI mf,
 GenericField<E> base)

Constructor which is easier to use, but has an unchecked cast. Use the GenericFieldMatrixField(GenericMatrixFactory, GenericPowerField, boolean) constructor to ensure type safety.

Parameters:

mf -

base -

GenericFieldMatrixField

public GenericFieldMatrixField(GenericMatrixFactory<E> mf,
 GenericPowerField<E> base,
 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

base - base field for calculations on elements

skipElements - whether to skip operations on the base elements

Method Details

addEle

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

Description copied from class: GenericMatrixField

Adds two elements of the vector/matrix

Specified by:

addEle in class GenericMatrixField<E>

Parameters:

l - lhs element

r - rhs element

Returns:

their sum

Throws:

EvaluationException

subEle

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

Specified by:

subEle in class GenericMatrixField<E>

Throws:

EvaluationException

negEle

protected E negEle(E l)
            throws EvaluationException

Specified by:

negEle in class GenericMatrixField<E>

Throws:

EvaluationException

mulEle

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

Specified by:

mulEle in class GenericMatrixField<E>

Throws:

EvaluationException

modEle

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

Specified by:

modEle in class GenericMatrixField<E>

Throws:

EvaluationException

divEle

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

Specified by:

divEle in class GenericMatrixField<E>

Throws:

EvaluationException

powEle

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

Specified by:

powEle in class GenericMatrixField<E>

Throws:

EvaluationException

eqEle

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

Specified by:

eqEle in class GenericMatrixField<E>

Throws:

EvaluationException

neEle

public Boolean neEle(E l,
 E r)
              throws EvaluationException

Specified by:

neEle in class GenericMatrixField<E>

Throws:

EvaluationException

gtEle

public Boolean gtEle(E l,
 E r)
              throws EvaluationException

Specified by:

gtEle in class GenericMatrixField<E>

Throws:

EvaluationException

geEle

public Boolean geEle(E l,
 E r)
              throws EvaluationException

Specified by:

geEle in class GenericMatrixField<E>

Throws:

EvaluationException

ltEle

public Boolean ltEle(E l,
 E r)
              throws EvaluationException

Specified by:

ltEle in class GenericMatrixField<E>

Throws:

EvaluationException

leEle

public Boolean leEle(E l,
 E r)
              throws EvaluationException

Specified by:

leEle in class GenericMatrixField<E>

Throws:

EvaluationException

andEle

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

Specified by:

andEle in class GenericMatrixField<E>

Throws:

EvaluationException

orEle

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

Specified by:

orEle in class GenericMatrixField<E>

Throws:

EvaluationException

notEle

protected Boolean notEle(E l)
                  throws EvaluationException

Specified by:

notEle in class GenericMatrixField<E>

Throws:

EvaluationException

getZero

public E getZero()

Description copied from interface: FieldI

Get the additive identity for this field

Specified by:

getZero in interface FieldI

Specified by:

getZero in class GenericMatrixField<E>

Returns:

object representing zero or null if undefined for this field

getOne

public E getOne()

Description copied from interface: FieldI

Get the multiplicative identity for this field.

Specified by:

getOne in interface FieldI

Specified by:

getOne in class GenericMatrixField<E>

Returns:

object representing one or null if undefined for this field

convertFromInt

public Object convertFromInt(Integer l)
                      throws EvaluationException

Description copied from interface: IntegerConvertor

Attempt to convert argument from an integer

Parameters:

l - value to convert

Returns:

corresponding value in this field or null if it cannot be converted

Throws:

EvaluationException - probably never

convertToInt

public Integer convertToInt(Object l)
                     throws EvaluationException

Description copied from interface: IntegerConvertor

Attempt to convert argument to an integer

Parameters:

l - value to convert

Returns:

corresponding integer or null if it cannot be converted

Throws:

EvaluationException - on error

init

public void init(Jep jep)

Description copied from interface: JepComponent

Initialize the component. This method is called whenever a component is added to Jep. Hence, it allows components to keep track of the other components they may rely on.

Parameters:

jep - the current Jep instance

getLightWeightInstance

public JepComponent getLightWeightInstance()

Returns this

Specified by:

getLightWeightInstance in interface JepComponent

Overrides:

getLightWeightInstance in class GenericMatrixField<E>

Returns:

either a new instance, null or 'this'.