Package com.singularsys.extensions.field.implementations

Class FixedPointField

java.lang.Object

com.singularsys.extensions.field.AbstractComparativeField

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

com.singularsys.extensions.field.implementations.FixedPointField

All Implemented Interfaces:

FieldI, IntegerConvertor, Serializable

public class FixedPointField
extends GenericField<BigDecimal>

Implementation of field methods using BigDecimals

Author:

Richard Morris

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FixedPointField(MathContext mc, int decimalDigits)

Method Summary

Modifier and Type	Method	Description
BigDecimal	addG(BigDecimal l, BigDecimal r)	Adds two elements of type E.
BigDecimal	cast(Object l)	Convert the input to type E.
Integer	cmpG(BigDecimal l, BigDecimal r)	Compare two objects of the same type.
BigDecimal	convertFromInt(Integer l)	Attempt to convert argument from an integer
Integer	convertToIntE(BigDecimal l)	If possible convert the argument to an Integer to enable integral powers.
BigDecimal	divG(BigDecimal l, BigDecimal r)	Divides two elements of type E.
BigDecimal	getOne()	Get the multiplicative identity for this field.
BigDecimal	getZero()	Get the additive identity for this field
BigDecimal	modG(BigDecimal l, BigDecimal r)	Modulus of two elements of type E.
BigDecimal	mulG(BigDecimal l, BigDecimal r)	Multiplies two elements of type E.
BigDecimal	negG(BigDecimal l)	Negates an elements of type E.
BigDecimal	powG(BigDecimal l, BigDecimal r)	Only integral values are allowed.
BigDecimal	subG(BigDecimal l, BigDecimal 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.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 Details

FixedPointField

public FixedPointField(MathContext mc,
 int decimalDigits)

Method Details

cast

public BigDecimal cast(Object l)

Description copied from class: GenericField

Convert the input to type E.

Specified by:

cast in class GenericField<BigDecimal>

Parameters:

l -

Returns:

l if l is a BigDecimal, null otherwise

addG

public BigDecimal addG(BigDecimal l,
 BigDecimal r)
                throws EvaluationException

Description copied from class: GenericField

Adds two elements of type E.

Specified by:

addG in class GenericField<BigDecimal>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the sum

Throws:

EvaluationException - on error

subG

public BigDecimal subG(BigDecimal l,
 BigDecimal r)
                throws EvaluationException

Description copied from class: GenericField

Subtracts two elements of type E.

Specified by:

subG in class GenericField<BigDecimal>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the difference

Throws:

EvaluationException - on error

negG

public BigDecimal negG(BigDecimal l)

Description copied from class: GenericField

Negates an elements of type E.

Specified by:

negG in class GenericField<BigDecimal>

Parameters:

l - the argument

Returns:

the negation

mulG

public BigDecimal mulG(BigDecimal l,
 BigDecimal r)
                throws EvaluationException

Description copied from class: GenericField

Multiplies two elements of type E.

Specified by:

mulG in class GenericField<BigDecimal>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the product

Throws:

EvaluationException - on error

divG

public BigDecimal divG(BigDecimal l,
 BigDecimal r)
                throws EvaluationException

Description copied from class: GenericField

Divides two elements of type E.

Specified by:

divG in class GenericField<BigDecimal>

Parameters:

l - numerator

r - denominator

Returns:

the division

Throws:

EvaluationException - on error

modG

public BigDecimal modG(BigDecimal l,
 BigDecimal r)

Description copied from class: GenericField

Modulus of two elements of type E.

Specified by:

modG in class GenericField<BigDecimal>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the modulus

powG

public BigDecimal powG(BigDecimal l,
 BigDecimal r)
                throws EvaluationException

Only integral values are allowed.

Specified by:

powG in class GenericField<BigDecimal>

Parameters:

l - lhs argument

r - rhs argument

Returns:

the power

Throws:

EvaluationException - for non integral values.

cmpG

public Integer cmpG(BigDecimal l,
 BigDecimal r)

Description copied from class: GenericField

Compare two objects of the same type.

Specified by:

cmpG in class GenericField<BigDecimal>

Parameters:

l - left argument

r - right argument

Returns:

-1, 0, 1 or null

getOne

public BigDecimal 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<BigDecimal>

Returns:

object representing one or null if undefined for this field

getZero

public BigDecimal 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<BigDecimal>

Returns:

object representing zero or null if undefined for this field

convertFromInt

public BigDecimal convertFromInt(Integer l)

Description copied from interface: IntegerConvertor

Attempt to convert argument from an integer

Specified by:

convertFromInt in interface IntegerConvertor

Specified by:

convertFromInt in class GenericField<BigDecimal>

Parameters:

l - value to convert

Returns:

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

convertToIntE

public Integer convertToIntE(BigDecimal l)

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<BigDecimal>

Parameters:

l - argument to convert.

Returns:

an integer or null if argument cannot be converted