Package com.singularsys.extensions.field.implementations

Class BigModulusField

java.lang.Object

com.singularsys.extensions.field.implementations.AbstractComparativeField

com.singularsys.extensions.field.implementations.GenericField<java.math.BigInteger>

com.singularsys.extensions.field.implementations.BigModulusField

All Implemented Interfaces:

FieldI, IntegerConvertor, java.io.Serializable

public class BigModulusField
extends GenericField<java.math.BigInteger>

A field to work with modulus values of any value, used BigInteger.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BigModulusField(java.math.BigInteger modulus)

Method Summary

Modifier and Type	Method	Description
java.math.BigInteger	addG(java.math.BigInteger l, java.math.BigInteger r)	Adds two elements of type E.
java.math.BigInteger	cast(java.lang.Object l)	Convert the input to type E.
java.lang.Integer	cmpG(java.math.BigInteger l, java.math.BigInteger r)	Not implemented for this field.
java.math.BigInteger	convertFromInt(java.lang.Integer l)	Attempt to convert argument from an integer
java.lang.Integer	convertToIntE(java.math.BigInteger l)	If possible convert the argument to an Integer to enable integral powers.
java.math.BigInteger	divG(java.math.BigInteger l, java.math.BigInteger r)	Divides two elements of type E.
java.lang.Boolean	eq(java.lang.Object lo, java.lang.Object ro)	Equals
java.lang.Boolean	ge(java.lang.Object l, java.lang.Object r)	Not implemented for this field.
java.math.BigInteger	getOne()	Get the multiplicative identity for this field.
java.math.BigInteger	getZero()	Get the additive identity for this field
java.lang.Boolean	gt(java.lang.Object l, java.lang.Object r)	Not implemented for this field.
java.lang.Boolean	le(java.lang.Object l, java.lang.Object r)	Not implemented for this field.
java.lang.Boolean	lt(java.lang.Object l, java.lang.Object r)	Not implemented for this field.
java.math.BigInteger	modG(java.math.BigInteger l, java.math.BigInteger r)	Modulus of two elements of type E.
java.math.BigInteger	mulG(java.math.BigInteger l, java.math.BigInteger r)	Multiplies two elements of type E.
java.lang.Boolean	ne(java.lang.Object lo, java.lang.Object ro)	Not Equals
java.math.BigInteger	negG(java.math.BigInteger l)	Negates an elements of type E.
java.math.BigInteger	powG(java.math.BigInteger l, java.math.BigInteger r)	Raises l to the power of r
java.math.BigInteger	subG(java.math.BigInteger l, java.math.BigInteger r)	Subtracts two elements of type E.

Methods inherited from class com.singularsys.extensions.field.implementations.GenericField

add, and, cmp, convertToInt, div, mod, mul, neg, not, or, pow, sub

Methods inherited from class java.lang.Object

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

Constructor Detail

BigModulusField

public BigModulusField(java.math.BigInteger modulus)

Method Detail

cast

public java.math.BigInteger cast(java.lang.Object l)

Description copied from class: GenericField

Convert the input to type E.

Specified by:

cast in class GenericField<java.math.BigInteger>

Returns:

l if l is a BigInteger modulo the modulus, null otherwise

addG

public java.math.BigInteger addG(java.math.BigInteger l,
                                 java.math.BigInteger r)
                          throws EvaluationException

Description copied from class: GenericField

Adds two elements of type E.

Specified by:

addG in class GenericField<java.math.BigInteger>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the sum

Throws:

EvaluationException - on error

subG

public java.math.BigInteger subG(java.math.BigInteger l,
                                 java.math.BigInteger r)
                          throws EvaluationException

Description copied from class: GenericField

Subtracts two elements of type E.

Specified by:

subG in class GenericField<java.math.BigInteger>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the difference

Throws:

EvaluationException - on error

negG

public java.math.BigInteger negG(java.math.BigInteger l)
                          throws EvaluationException

Description copied from class: GenericField

Negates an elements of type E.

Specified by:

negG in class GenericField<java.math.BigInteger>

Parameters:

l - the argument

Returns:

the negation

Throws:

EvaluationException - on error

mulG

public java.math.BigInteger mulG(java.math.BigInteger l,
                                 java.math.BigInteger r)
                          throws EvaluationException

Description copied from class: GenericField

Multiplies two elements of type E.

Specified by:

mulG in class GenericField<java.math.BigInteger>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the product

Throws:

EvaluationException - on error

divG

public java.math.BigInteger divG(java.math.BigInteger l,
                                 java.math.BigInteger r)
                          throws EvaluationException

Description copied from class: GenericField

Divides two elements of type E.

Specified by:

divG in class GenericField<java.math.BigInteger>

Parameters:

l - numerator

r - denominator

Returns:

the division

Throws:

EvaluationException - on error

modG

public java.math.BigInteger modG(java.math.BigInteger l,
                                 java.math.BigInteger r)
                          throws EvaluationException

Description copied from class: GenericField

Modulus of two elements of type E.

Specified by:

modG in class GenericField<java.math.BigInteger>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the modulus

Throws:

EvaluationException - on error

powG

public java.math.BigInteger powG(java.math.BigInteger l,
                                 java.math.BigInteger r)
                          throws EvaluationException

Description copied from class: GenericField

Raises l to the power of r

Specified by:

powG in class GenericField<java.math.BigInteger>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the power

Throws:

EvaluationException - on error

cmpG

public java.lang.Integer cmpG(java.math.BigInteger l,
                              java.math.BigInteger r)
                       throws EvaluationException

Not implemented for this field.

Specified by:

cmpG in class GenericField<java.math.BigInteger>

Parameters:

l - left argument

r - right argument

Returns:

-1, 0, 1 or null

Throws:

EvaluationException

eq

public java.lang.Boolean eq(java.lang.Object lo,
                            java.lang.Object ro)
                     throws EvaluationException

Description copied from interface: FieldI

Equals

Specified by:

eq in interface FieldI

Overrides:

eq in class AbstractComparativeField

Parameters:

lo - left hand argument

ro - right hand argument

Returns:

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

Throws:

EvaluationException - on error

ne

public java.lang.Boolean ne(java.lang.Object lo,
                            java.lang.Object ro)
                     throws EvaluationException

Description copied from interface: FieldI

Not Equals

Specified by:

ne in interface FieldI

Overrides:

ne in class AbstractComparativeField

Parameters:

lo - left hand argument

ro - right hand argument

Returns:

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

Throws:

EvaluationException - on error

gt

public java.lang.Boolean gt(java.lang.Object l,
                            java.lang.Object r)
                     throws EvaluationException

Not implemented for this field.

Specified by:

gt in interface FieldI

Overrides:

gt in class AbstractComparativeField

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 java.lang.Boolean ge(java.lang.Object l,
                            java.lang.Object r)
                     throws EvaluationException

Not implemented for this field.

Specified by:

ge in interface FieldI

Overrides:

ge in class AbstractComparativeField

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 java.lang.Boolean lt(java.lang.Object l,
                            java.lang.Object r)
                     throws EvaluationException

Not implemented for this field.

Specified by:

lt in interface FieldI

Overrides:

lt in class AbstractComparativeField

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 java.lang.Boolean le(java.lang.Object l,
                            java.lang.Object r)
                     throws EvaluationException

Not implemented for this field.

Specified by:

le in interface FieldI

Overrides:

le in class AbstractComparativeField

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

getOne

public java.math.BigInteger getOne()

Description copied from interface: FieldI

Get the multiplicative identity for this field.

Specified by:

getOne in interface FieldI

Specified by:

getOne in class GenericField<java.math.BigInteger>

Returns:

object representing one or null if undefined for this field

getZero

public java.math.BigInteger getZero()

Description copied from interface: FieldI

Get the additive identity for this field

Specified by:

getZero in interface FieldI

Specified by:

getZero in class GenericField<java.math.BigInteger>

Returns:

object representing zero or null if undefined for this field

convertToIntE

public java.lang.Integer convertToIntE(java.math.BigInteger l)
                                throws EvaluationException

Description copied from class: GenericField

If possible convert the argument to an Integer to enable integral powers. If the argument cannot be converted null should be returned and the powG(E,E) method will be called.

Specified by:

convertToIntE in class GenericField<java.math.BigInteger>

Parameters:

l - argument to convert.

Returns:

an integer or null if argument cannot be converted

Throws:

EvaluationException

convertFromInt

public java.math.BigInteger convertFromInt(java.lang.Integer l)
                                    throws EvaluationException

Description copied from interface: IntegerConvertor

Attempt to convert argument from an integer

Specified by:

convertFromInt in interface IntegerConvertor

Specified by:

convertFromInt in class GenericField<java.math.BigInteger>

Parameters:

l - value to convert

Returns:

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

Throws:

EvaluationException - probably never