org.jlinalg.bigdecimalwrapper

Class BigDecimalWrapper

java.lang.Object

org.jlinalg.RingElement<RE>

org.jlinalg.FieldElement<BigDecimalWrapper>

org.jlinalg.bigdecimalwrapper.BigDecimalWrapper

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BigDecimalWrapper>, IRingElement<BigDecimalWrapper>

public class BigDecimalWrapper
extends FieldElement<BigDecimalWrapper>
implements IRingElement<BigDecimalWrapper>

This class wraps a BigDecimal value and performs all FieldElement operations on that BigDecimal. Fast but not without rounding errors.

Author:

Georg Thimm

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) BigDecimalWrapperFactory	FACTORY The factory for BigDecimalWrapper
(package private) static java.util.regex.Pattern	fractionPattern used in BigDecimalWrapperFactory.get(Object) to parse fractions.
private static long	serialVersionUID
protected java.math.BigDecimal	value The encapsulated value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BigDecimalWrapper(java.math.BigDecimal value, FAC factory) Builds an element from a BigDecimal value.

Method Summary

Modifier and Type	Method and Description
BigDecimalWrapper	abs() Returns absolute value of this element
BigDecimalWrapper	add(BigDecimalWrapper val) Calculates the sum of this element and another one.
int	compareTo(BigDecimalWrapper o) Implements Comparable.compareTo(Object).
BigDecimalWrapper	divide(BigDecimalWrapper val) Calculates the quotient of this element and another one.
double	doubleValue() Returns the double-precision floating-point value of this element.
boolean	equals(java.lang.Object obj) Checks two FieldElements for equality.
BigDecimalWrapperFactory	getFactory() Give access to the factory for this type.
java.math.BigDecimal	getValue()
int	hashCode()
BigDecimalWrapper	invert() Calculates the inverse element of multiplication for this element.
boolean	isZero() Tests if this RingElement is the neutral element of addition (zero).
BigDecimalWrapper	multiply(BigDecimalWrapper val) Calculates the product of this element and another one.
BigDecimalWrapper	negate() Calculates the inverse element of addition for this element.
BigDecimalWrapper	sqrt()
BigDecimalWrapper	subtract(BigDecimalWrapper val) Calculates the product of this element and another one.
java.lang.String	toString() Returns a String representation of this element.

Methods inherited from class org.jlinalg.FieldElement

norm

Methods inherited from class org.jlinalg.RingElement

apply, ge, gt, isOne, le, lt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jlinalg.IRingElement

apply, ge, gt, isOne, le, lt, norm

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

value

protected java.math.BigDecimal value

The encapsulated value.

FACTORY

final BigDecimalWrapperFactory FACTORY

The factory for BigDecimalWrapper

fractionPattern

static final java.util.regex.Pattern fractionPattern

used in BigDecimalWrapperFactory.get(Object) to parse fractions.

Constructor Detail

BigDecimalWrapper

protected BigDecimalWrapper(java.math.BigDecimal value,
                            FAC factory)

Builds an element from a BigDecimal value.

Parameters:

value - a BigDecimal value to be wrapped

factory - the factory encapsulating the context in which the new value is created. See java.math.MathContext

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

the hashCode of the encapsulated value.

See Also:

Object.hashCode()

getValue

public java.math.BigDecimal getValue()

Returns:

the BigDecimal value this instance wraps.

add

public BigDecimalWrapper add(BigDecimalWrapper val)

Calculates the sum of this element and another one.

Specified by:

add in interface IRingElement<BigDecimalWrapper>

Parameters:

val -

Returns:

sum

subtract

public BigDecimalWrapper subtract(BigDecimalWrapper val)

Calculates the product of this element and another one.

Specified by:

subtract in interface IRingElement<BigDecimalWrapper>

Overrides:

subtract in class FieldElement<BigDecimalWrapper>

Parameters:

val -

Returns:

product

multiply

public BigDecimalWrapper multiply(BigDecimalWrapper val)

Calculates the product of this element and another one.

Specified by:

multiply in interface IRingElement<BigDecimalWrapper>

Parameters:

val -

Returns:

product

divide

public BigDecimalWrapper divide(BigDecimalWrapper val)
                         throws DivisionByZeroException

Calculates the quotient of this element and another one.

Specified by:

divide in interface IRingElement<BigDecimalWrapper>

Overrides:

divide in class FieldElement<BigDecimalWrapper>

Parameters:

val -

Returns:

this / val

Throws:

DivisionByZeroException - if a division is possible for the type, but val is the zero element.

negate

public BigDecimalWrapper negate()

Calculates the inverse element of addition for this element.

Specified by:

negate in interface IRingElement<BigDecimalWrapper>

Returns:

negated (-value)

invert

public BigDecimalWrapper invert()
                         throws DivisionByZeroException

Calculates the inverse element of multiplication for this element.

Specified by:

invert in interface IRingElement<BigDecimalWrapper>

Overrides:

invert in class RingElement<BigDecimalWrapper>

Returns:

inverted (1/value)

Throws:

InvalidOperationException - if original value is zero

DivisionByZeroException - if an inversion is possible for the type, but the element is the zero element.

equals

public boolean equals(java.lang.Object obj)

Checks two FieldElements for equality.

Specified by:

equals in interface IRingElement<BigDecimalWrapper>

Overrides:

equals in class RingElement<BigDecimalWrapper>

Parameters:

obj -

Returns:

true if the two FieldElements are mathematically equal.

isZero

public boolean isZero()

Description copied from class: RingElement

Tests if this RingElement is the neutral element of addition (zero).

Specified by:

isZero in interface IRingElement<BigDecimalWrapper>

Overrides:

isZero in class RingElement<BigDecimalWrapper>

Returns:

true if zero

See Also:

RingElement.isZero()

toString

public java.lang.String toString()

Returns a String representation of this element.

Overrides:

toString in class java.lang.Object

Returns:

String representation

doubleValue

public double doubleValue()

Returns the double-precision floating-point value of this element.

Returns:

value

compareTo

public int compareTo(BigDecimalWrapper o)

Implements Comparable.compareTo(Object).

Specified by:

compareTo in interface java.lang.Comparable<BigDecimalWrapper>

Specified by:

compareTo in interface IRingElement<BigDecimalWrapper>

Parameters:

o - the object

Returns:

-,+,0} as this object is less than, equal to, or greater than the specified object.

sqrt

public BigDecimalWrapper sqrt()

Returns:

the square root of this value.

Throws:

InvalidOperationException - if the precision of the factory is 0 (that is infinite precision) or the value is negative.

getFactory

public BigDecimalWrapperFactory getFactory()

Description copied from interface: IRingElement

Give access to the factory for this type. This is to replace in a consistent manner the constructors of

Specified by:

getFactory in interface IRingElement<BigDecimalWrapper>

Returns:

the singleton factory for this type.

abs

public BigDecimalWrapper abs()

Description copied from interface: IRingElement

Returns absolute value of this element

Specified by:

abs in interface IRingElement<BigDecimalWrapper>

Returns:

the absolute value.