Package com.singularsys.extensions.field.implementations

Class ExactIntegerField

java.lang.Object

com.singularsys.extensions.field.implementations.AbstractComparativeField

com.singularsys.extensions.field.implementations.GenericField<E>

com.singularsys.extensions.field.implementations.GenericPowerField<java.lang.Integer>

com.singularsys.extensions.field.implementations.ExactIntegerField

All Implemented Interfaces:

FieldI, IntegerConvertor, java.io.Serializable

public class ExactIntegerField
extends GenericPowerField<java.lang.Integer>

A integer field where results are always integers and Exceptions are thrown on error. The actual exception thrown is an ArithmeticException wrapped in EvaluationExceptions. Where possible it uses the Math.addExact(int,int) etc. methods.

Author:

Richard Morris

See Also:

Serialized Form

Field Summary

Fields inherited from class com.singularsys.extensions.field.implementations.GenericPowerField

one, zero

Constructor Summary

Constructors

Constructor	Description
ExactIntegerField(boolean checkDivide)	Constructor

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	addG(java.lang.Integer l, java.lang.Integer r)	Adds two elements of type E.
java.lang.Integer	cast(java.lang.Object l)	Convert the input to type E.
java.lang.Integer	cmpG(java.lang.Integer l, java.lang.Integer r)	Compare two objects of the same type.
java.lang.Integer	convertFromInt(java.lang.Integer l)	Attempt to convert argument from an integer
java.lang.Integer	convertToIntE(java.lang.Integer l)	If possible convert the argument to an Integer to enable integral powers.
java.lang.Integer	divG(java.lang.Integer l, java.lang.Integer r)	Divides two elements of type E.
java.lang.Integer	getOne()	Get the multiplicative identity for this field.
java.lang.Integer	getZero()	Get the additive identity for this field
java.lang.Integer	modG(java.lang.Integer l, java.lang.Integer r)	Modulus of two elements of type E.
java.lang.Integer	mulG(java.lang.Integer l, java.lang.Integer r)	Multiplies two elements of type E.
java.lang.Integer	negG(java.lang.Integer l)	Negates an elements of type E.
java.lang.Integer	powG(java.lang.Integer l, java.lang.Integer r)	If r is integral (convertToInt returns non-null) call powI otherwise call powNI
protected java.lang.Integer	powI(java.lang.Integer l, java.lang.Integer r)
java.lang.Integer	powNonInt(java.lang.Integer l, java.lang.Integer r)	Called when the power is not an integer
java.lang.Integer	subG(java.lang.Integer l, java.lang.Integer 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 com.singularsys.extensions.field.implementations.AbstractComparativeField

eq, ge, gt, le, lt, ne

Methods inherited from class java.lang.Object

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

Constructor Detail

ExactIntegerField

public ExactIntegerField(boolean checkDivide)

Constructor

Parameters:

checkDivide - whether to throw exception is division is not integral

Method Detail

cast

public java.lang.Integer cast(java.lang.Object l)

Description copied from class: GenericField

Convert the input to type E.

Specified by:

cast in class GenericField<java.lang.Integer>

Returns:

l cast to type E if possible or null if casting is not possible

addG

public java.lang.Integer addG(java.lang.Integer l,
                              java.lang.Integer r)
                       throws EvaluationException

Description copied from class: GenericField

Adds two elements of type E.

Specified by:

addG in class GenericField<java.lang.Integer>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the sum

Throws:

EvaluationException - on error

subG

public java.lang.Integer subG(java.lang.Integer l,
                              java.lang.Integer r)
                       throws EvaluationException

Description copied from class: GenericField

Subtracts two elements of type E.

Specified by:

subG in class GenericField<java.lang.Integer>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the difference

Throws:

EvaluationException - on error

negG

public java.lang.Integer negG(java.lang.Integer l)
                       throws EvaluationException

Description copied from class: GenericField

Negates an elements of type E.

Specified by:

negG in class GenericField<java.lang.Integer>

Parameters:

l - the argument

Returns:

the negation

Throws:

EvaluationException - on error

mulG

public java.lang.Integer mulG(java.lang.Integer l,
                              java.lang.Integer r)
                       throws EvaluationException

Description copied from class: GenericField

Multiplies two elements of type E.

Specified by:

mulG in class GenericField<java.lang.Integer>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the product

Throws:

EvaluationException - on error

divG

public java.lang.Integer divG(java.lang.Integer l,
                              java.lang.Integer r)
                       throws EvaluationException

Description copied from class: GenericField

Divides two elements of type E.

Specified by:

divG in class GenericField<java.lang.Integer>

Parameters:

l - numerator

r - denominator

Returns:

the division

Throws:

EvaluationException - on error

modG

public java.lang.Integer modG(java.lang.Integer l,
                              java.lang.Integer r)
                       throws EvaluationException

Description copied from class: GenericField

Modulus of two elements of type E.

Specified by:

modG in class GenericField<java.lang.Integer>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the modulus

Throws:

EvaluationException - on error

powG

public java.lang.Integer powG(java.lang.Integer l,
                              java.lang.Integer r)
                       throws EvaluationException

Description copied from class: GenericPowerField

If r is integral (convertToInt returns non-null) call powI otherwise call powNI

Overrides:

powG in class GenericPowerField<java.lang.Integer>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the power

Throws:

EvaluationException - on error

cmpG

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

Description copied from class: GenericField

Compare two objects of the same type.

Specified by:

cmpG in class GenericField<java.lang.Integer>

Parameters:

l - left argument

r - right argument

Returns:

-1, 0, 1 or null

Throws:

EvaluationException

powNonInt

public java.lang.Integer powNonInt(java.lang.Integer l,
                                   java.lang.Integer r)
                            throws EvaluationException

Description copied from class: GenericPowerField

Called when the power is not an integer

Specified by:

powNonInt in class GenericPowerField<java.lang.Integer>

Returns:

Throws:

EvaluationException

powI

protected java.lang.Integer powI(java.lang.Integer l,
                                 java.lang.Integer r)
                          throws EvaluationException

Overrides:

powI in class GenericPowerField<java.lang.Integer>

Throws:

EvaluationException

getOne

public java.lang.Integer 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.lang.Integer>

Returns:

object representing one or null if undefined for this field

getZero

public java.lang.Integer 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.lang.Integer>

Returns:

object representing zero or null if undefined for this field

convertToIntE

public java.lang.Integer convertToIntE(java.lang.Integer 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.lang.Integer>

Parameters:

l - argument to convert.

Returns:

an integer or null if argument cannot be converted

Throws:

EvaluationException

convertFromInt

public java.lang.Integer 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.lang.Integer>

Parameters:

l - value to convert

Returns:

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

Throws:

EvaluationException - probably never