Package com.singularsys.extensions.field

Interface FieldI

All Superinterfaces:

Serializable

All Known Subinterfaces:

MatrixFieldI

All Known Implementing Classes:

AbstractComparativeField, AbstractMatrixField, BigDecimalField, BigIntegerField, BigIntegerToRationalDecorator, BigModulusField, BooleanField, ComplexField, ComplexFieldWithRealOrder, ComplexFieldWithTotalOrder, ComplexMatrixField, DoubleField, DoubleMatrixField, ExactIntegerField, ExtDocsTest.StringField, ExtDocsTest.StringField2, ExtDocsTest.StringField3, ExternalMatrixField, FieldCollection, FieldConsole.AllToComplexDecorator, FieldConsole.RationalBigDecToDoubleDecorator, FieldConsole.RationalToBigDecDecorator, FieldDecorator, FieldMatrixField, FixedPointField, GenericField, GenericFieldMatrixField, GenericMatrixField, GenericPowerField, IntegerField, IntegerToBigIntegerDecorator, LongField, MatrixFieldCollection, ModulusField, NumberAsBooleanField, NumberToComplexDecorator, NumberToDoubleDecorator, RationalField, SequenceMatrixField, ShortField, SimpleMatrixField, SimpleVectorField, StandardField, StringField

public interface FieldI
extends Serializable

Defines the methods which each field should implement - add, sub, mul, div, mod, pow, eq, ne, gt, ge, lt, le, and, or, not. The general contract is that if a field can calculate the result then it returns that value. If a field cannot calculate a value it returns null.

Author:

Richard Morris

Method Summary

Modifier and Type	Method	Description
Object	add(Object l, Object r)	Add two members of the field.
Boolean	and(Object l, Object r)	Logical and.
Object	div(Object l, Object r)	Divides two members of the field.
Boolean	eq(Object l, Object r)	Equals
Boolean	ge(Object l, Object r)	Greater or equal to
Object	getOne()	Get the multiplicative identity for this field.
Object	getZero()	Get the additive identity for this field
Boolean	gt(Object l, Object r)	Greater than
Boolean	le(Object l, Object r)	Less than or equals to
Boolean	lt(Object l, Object r)	Less than
Object	mod(Object l, Object r)	The modulus of two members of the field.
Object	mul(Object l, Object r)	Multiplies two members of the field.
Boolean	ne(Object l, Object r)	Not Equals
Object	neg(Object l)	The negation -x of an element.
Boolean	not(Object l)	Logical not.
Boolean	or(Object l, Object r)	Logical or.
Object	pow(Object l, Object r)	The power operator.
Object	sub(Object l, Object r)	Subtract two members of the field.

Method Details

add

Object add(Object l,
 Object r)
    throws EvaluationException

Add two members of the field.

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

Object sub(Object l,
 Object r)
    throws EvaluationException

Subtract two members of the field.

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

neg

Object neg(Object l)
    throws EvaluationException

The negation -x of an element.

Parameters:

l - the argument

Returns:

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

Throws:

EvaluationException - on error

mul

Object mul(Object l,
 Object r)
    throws EvaluationException

Multiplies two members of the field.

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

Object div(Object l,
 Object r)
    throws EvaluationException

Divides two members of the field.

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

mod

Object mod(Object l,
 Object r)
    throws EvaluationException

The modulus of two members of the field.

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

pow

Object pow(Object l,
 Object r)
    throws EvaluationException

The power operator.

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

Boolean eq(Object l,
 Object r)
    throws EvaluationException

Equals

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

Boolean ne(Object l,
 Object r)
    throws EvaluationException

Not Equals

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

gt

Boolean gt(Object l,
 Object r)
    throws EvaluationException

Greater than

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

Boolean ge(Object l,
 Object r)
    throws EvaluationException

Greater or equal to

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

Boolean lt(Object l,
 Object r)
    throws EvaluationException

Less than

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

Boolean le(Object l,
 Object r)
    throws EvaluationException

Less than or equals to

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

Boolean and(Object l,
 Object r)
     throws EvaluationException

Logical and.

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

Boolean or(Object l,
 Object r)
    throws EvaluationException

Logical or.

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

Boolean not(Object l)
     throws EvaluationException

Logical not.

Parameters:

l - argument

Returns:

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

Throws:

EvaluationException - on error

getZero

Object getZero()

Get the additive identity for this field

Returns:

object representing zero or null if undefined for this field

getOne

Object getOne()

Get the multiplicative identity for this field.

Returns:

object representing one or null if undefined for this field