Package com.singularsys.extensions.field
Interface FieldI
-
- All Superinterfaces:
java.io.Serializable
- All Known Subinterfaces:
MatrixFieldI
- All Known Implementing Classes:
AbstractComparativeField
,AbstractMatrixField
,BigDecimalField
,BigIntegerField
,BigIntegerToRationalDecorator
,BigModulusField
,BooleanField
,ComplexField
,ComplexFieldWithRealOrder
,ComplexMatrixField
,DoubleField
,DoubleMatrixField
,ExactIntegerField
,ExtDocsTest.StringField
,ExtDocsTest.StringField2
,ExtDocsTest.StringField3
,FieldCollection
,FieldConsole.AllToComplesDecerator
,FieldConsole.RationalBigDecToDoubleDecerator
,FieldConsole.RationalToBigDecDecerator
,FieldDecorator
,FieldMatrixField
,GenericField
,GenericFieldMatrixField
,GenericMatrixField
,GenericPowerField
,IntegerField
,IntegerToBigIntegerDecorator
,LongField
,MatrixFieldCollection
,ModulusField
,NumberAsBooleanField
,NumberToComplexDecorator
,NumberToDoubleDecorator
,RationalField
,SequenceMatrixField
,ShortField
,SimpleMatrixField
,StandardField
,StringField
public interface FieldI extends java.io.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 returnsnull
.- Author:
- Richard Morris
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object
add(java.lang.Object l, java.lang.Object r)
Add two members of the field.java.lang.Boolean
and(java.lang.Object l, java.lang.Object r)
Logical and.java.lang.Object
div(java.lang.Object l, java.lang.Object r)
Divides two members of the field.java.lang.Boolean
eq(java.lang.Object l, java.lang.Object r)
Equalsjava.lang.Boolean
ge(java.lang.Object l, java.lang.Object r)
Greater or equal tojava.lang.Object
getOne()
Get the multiplicative identity for this field.java.lang.Object
getZero()
Get the additive identity for this fieldjava.lang.Boolean
gt(java.lang.Object l, java.lang.Object r)
Greater thanjava.lang.Boolean
le(java.lang.Object l, java.lang.Object r)
Less than or equals tojava.lang.Boolean
lt(java.lang.Object l, java.lang.Object r)
Less thanjava.lang.Object
mod(java.lang.Object l, java.lang.Object r)
The modulus of two members of the field.java.lang.Object
mul(java.lang.Object l, java.lang.Object r)
Multiplies two members of the field.java.lang.Boolean
ne(java.lang.Object l, java.lang.Object r)
Not Equalsjava.lang.Object
neg(java.lang.Object l)
The negation -x of an element.java.lang.Boolean
not(java.lang.Object l)
Logical not.java.lang.Boolean
or(java.lang.Object l, java.lang.Object r)
Logical or.java.lang.Object
pow(java.lang.Object l, java.lang.Object r)
The power operator.java.lang.Object
sub(java.lang.Object l, java.lang.Object r)
Subtract two members of the field.
-
-
-
Method Detail
-
add
java.lang.Object add(java.lang.Object l, java.lang.Object r) throws EvaluationException
Add two members of the field.- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
sub
java.lang.Object sub(java.lang.Object l, java.lang.Object r) throws EvaluationException
Subtract two members of the field.- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
neg
java.lang.Object neg(java.lang.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
java.lang.Object mul(java.lang.Object l, java.lang.Object r) throws EvaluationException
Multiplies two members of the field.- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
div
java.lang.Object div(java.lang.Object l, java.lang.Object r) throws EvaluationException
Divides two members of the field.- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
mod
java.lang.Object mod(java.lang.Object l, java.lang.Object r) throws EvaluationException
The modulus of two members of the field.- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
pow
java.lang.Object pow(java.lang.Object l, java.lang.Object r) throws EvaluationException
The power operator.- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
eq
java.lang.Boolean eq(java.lang.Object l, java.lang.Object r) throws EvaluationException
Equals- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
ne
java.lang.Boolean ne(java.lang.Object l, java.lang.Object r) throws EvaluationException
Not Equals- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
gt
java.lang.Boolean gt(java.lang.Object l, java.lang.Object r) throws EvaluationException
Greater than- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
ge
java.lang.Boolean ge(java.lang.Object l, java.lang.Object r) throws EvaluationException
Greater or equal to- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
lt
java.lang.Boolean lt(java.lang.Object l, java.lang.Object r) throws EvaluationException
Less than- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
le
java.lang.Boolean le(java.lang.Object l, java.lang.Object r) throws EvaluationException
Less than or equals to- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
and
java.lang.Boolean and(java.lang.Object l, java.lang.Object r) throws EvaluationException
Logical and.- Parameters:
l
- left hand argument implimentationr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
or
java.lang.Boolean or(java.lang.Object l, java.lang.Object r) throws EvaluationException
Logical or.- Parameters:
l
- left hand argumentr
- right hand argument- Returns:
- an object representing the result or null if it can not be evaluated.
- Throws:
EvaluationException
- on error
-
not
java.lang.Boolean not(java.lang.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
java.lang.Object getZero()
Get the additive identity for this field- Returns:
- object representing zero or null if undefined for this field
-
getOne
java.lang.Object getOne()
Get the multiplicative identity for this field.- Returns:
- object representing one or null if undefined for this field
-
-