Package org.apfloat.jscience

Class ApfloatField

java.lang.Object

java.lang.Number

org.jscience.mathematics.number.Number<T>

org.apfloat.jscience.AbstractField<ApfloatField,org.apfloat.Apfloat>

org.apfloat.jscience.ApfloatField

All Implemented Interfaces:

Serializable, Comparable<ApfloatField>, javolution.lang.Immutable, javolution.lang.Realtime, javolution.lang.ValueType, javolution.xml.XMLSerializable, org.jscience.mathematics.structure.Field<ApfloatField>, org.jscience.mathematics.structure.GroupAdditive<ApfloatField>, org.jscience.mathematics.structure.GroupMultiplicative<ApfloatField>, org.jscience.mathematics.structure.Ring<ApfloatField>, org.jscience.mathematics.structure.Structure<ApfloatField>

public class ApfloatField
extends AbstractField<ApfloatField,org.apfloat.Apfloat>

This class represents an arbitrary precision floating-point number.

The precision of each calculation is determined separately, which means that loss of precision can easily accumulate in complicated calculations (e.g. matrix inversion). If this should be avoided, and a fixed precision is required, then it may be better to use FixedPrecisionApfloatField instead.

Since:

1.8.0

Version:

1.8.0

Author:

Mikko Tommila

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ApfloatField(org.apfloat.Apfloat value)	Constructs a new floating-point field object with the specified value.

Method Summary

Modifier and Type	Method	Description
ApfloatField	copy()	Returns a copy of this object.
ApfloatField	inverse()	Returns the multiplicative inverse of this object.
ApfloatField	opposite()	Returns the additive inverse of this object.
ApfloatField	plus(ApfloatField that)	Returns the sum of this object with the one specified.
ApfloatField	times(ApfloatField that)	Returns the product of this object with the one specified.

Methods inherited from class org.apfloat.jscience.AbstractField

compareTo, doubleValue, equals, hashCode, isLargerThan, longValue, toText, value

Methods inherited from class org.jscience.mathematics.number.Number

byteValue, floatValue, intValue, isGreaterThan, isLessThan, minus, pow, shortValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ApfloatField

public ApfloatField(org.apfloat.Apfloat value)

Constructs a new floating-point field object with the specified value.

Parameters:

value - The value.

Method Detail

plus

public ApfloatField plus(ApfloatField that)

Description copied from class: AbstractField

Returns the sum of this object with the one specified.

Specified by:

plus in interface org.jscience.mathematics.structure.GroupAdditive<ApfloatField>

Specified by:

plus in class AbstractField<ApfloatField,org.apfloat.Apfloat>

Parameters:

that - The addend.

Returns:

this + that

opposite

public ApfloatField opposite()

Description copied from class: AbstractField

Returns the additive inverse of this object.

Specified by:

opposite in interface org.jscience.mathematics.structure.GroupAdditive<ApfloatField>

Specified by:

opposite in class AbstractField<ApfloatField,org.apfloat.Apfloat>

Returns:

-this

times

public ApfloatField times(ApfloatField that)

Description copied from class: AbstractField

Returns the product of this object with the one specified.

Specified by:

times in interface org.jscience.mathematics.structure.GroupMultiplicative<ApfloatField>

Specified by:

times in interface org.jscience.mathematics.structure.Ring<ApfloatField>

Specified by:

times in class AbstractField<ApfloatField,org.apfloat.Apfloat>

Parameters:

that - The multiplicand.

Returns:

this * that

inverse

public ApfloatField inverse()
                     throws ArithmeticException

Description copied from class: AbstractField

Returns the multiplicative inverse of this object.

Specified by:

inverse in interface org.jscience.mathematics.structure.GroupMultiplicative<ApfloatField>

Specified by:

inverse in class AbstractField<ApfloatField,org.apfloat.Apfloat>

Returns:

1 / this

Throws:

ArithmeticException - If the divisor is zero.

copy

public ApfloatField copy()

Description copied from class: AbstractField

Returns a copy of this object.

Specified by:

copy in interface javolution.lang.ValueType

Specified by:

copy in class AbstractField<ApfloatField,org.apfloat.Apfloat>

Returns:

A copy of this object.