org.ojalgo.scalar

Class ExactDecimal<S extends ExactDecimal<S>>

java.lang.Object

java.lang.Number

org.ojalgo.scalar.ExactDecimal<S>

All Implemented Interfaces:

Serializable, Comparable<S>, Field<Scalar<S>>, Group, Group.Additive<Scalar<S>>, Group.Multiplicative<Scalar<S>>, NormedVectorSpace<Scalar<S>,S>, Operation, Operation.Addition<Scalar<S>>, Operation.Division<Scalar<S>>, Operation.Multiplication<Scalar<S>>, Operation.Subtraction<Scalar<S>>, Ring<Scalar<S>>, ScalarOperation, ScalarOperation.Addition<Scalar<S>,S>, ScalarOperation.Division<Scalar<S>,S>, ScalarOperation.Multiplication<Scalar<S>,S>, ScalarOperation.Subtraction<Scalar<S>,S>, VectorSpace<Scalar<S>,S>, Scalar<S>, AccessScalar<S>, NumberContext.Enforceable<S>

Direct Known Subclasses:

Money

public abstract class ExactDecimal<S extends ExactDecimal<S>>
extends Number
implements Scalar<S>, NumberContext.Enforceable<S>

To help implement exact decimal numbers with a fixed number of decimal places (fixed scale).

Author:

apete

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExactDecimal.Descriptor

Nested classes/interfaces inherited from interface org.ojalgo.scalar.Scalar

Scalar.Factory<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.algebra.ScalarOperation

ScalarOperation.Addition<T,N extends Number>, ScalarOperation.Division<T,N extends Number>, ScalarOperation.Multiplication<T,N extends Number>, ScalarOperation.Subtraction<T,N extends Number>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExactDecimal(long numerator)

Method Summary

Modifier and Type	Method and Description
S	add(double scalarAddend)
S	add(S scalarAddend)
int	compareTo(S reference)
S	conjugate() This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...
protected abstract ExactDecimal.Descriptor	descriptor()
S	divide(double scalarDivisor)
S	divide(S scalarDivisor)
double	doubleValue()
S	enforce(NumberContext context)
protected static long	extractUnscaledValue(BigDecimal decimal, NumberContext cntxt)
float	floatValue()
S	get()
int	intValue()
S	invert() The multiplicative inverse.
boolean	isAbsolute()
boolean	isSmall(double comparedTo)
long	longValue()
S	multiply(double scalarMultiplicand)
S	multiply(S scalarMultiplicand)
S	negate() The additive inverse of this.
double	norm() this == this.signum().multiply(this.norm())
S	signum() this == this.signum().multiply(this.norm())
S	subtract(double scalarSubtrahend)
S	subtract(S scalarSubtrahend)
BigDecimal	toBigDecimal()
String	toString()
String	toString(NumberContext context)
protected abstract S	wrap(long numerator)

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.scalar.Scalar

add, divide, multiply, subtract, toPlainString

Methods inherited from interface org.ojalgo.structure.AccessScalar

byteValue, shortValue

Constructor Detail

ExactDecimal

protected ExactDecimal(long numerator)

Method Detail

extractUnscaledValue

protected static long extractUnscaledValue(BigDecimal decimal,
                                           NumberContext cntxt)

add

public final S add(double scalarAddend)

Specified by:

add in interface ScalarOperation.Addition<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

this + scalarAddend.

add

public final S add(S scalarAddend)

Specified by:

add in interface ScalarOperation.Addition<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

this + scalarAddend.

compareTo

public final int compareTo(S reference)

Specified by:

compareTo in interface Comparable<S extends ExactDecimal<S>>

conjugate

public final S conjugate()

Description copied from interface: VectorSpace

This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...

The conjugate transpose of a matrix and/or the conjugate of a scalar/field like ComplexNumber or Quaternion.

The conjugate transpose of a real matrix is simply its transpose.

Specified by:

conjugate in interface VectorSpace<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

divide

public final S divide(double scalarDivisor)

Specified by:

divide in interface ScalarOperation.Division<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

this / scalarDivisor.

divide

public final S divide(S scalarDivisor)

Specified by:

divide in interface ScalarOperation.Division<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

this / scalarDivisor.

doubleValue

public final double doubleValue()

Specified by:

doubleValue in interface AccessScalar<S extends ExactDecimal<S>>

Specified by:

doubleValue in class Number

See Also:

Number.doubleValue()

enforce

public final S enforce(NumberContext context)

Specified by:

enforce in interface NumberContext.Enforceable<S extends ExactDecimal<S>>

floatValue

public final float floatValue()

Specified by:

floatValue in interface AccessScalar<S extends ExactDecimal<S>>

Specified by:

floatValue in class Number

See Also:

Number.floatValue()

get

public final S get()

Specified by:

get in interface AccessScalar<S extends ExactDecimal<S>>

intValue

public final int intValue()

Specified by:

intValue in interface AccessScalar<S extends ExactDecimal<S>>

Specified by:

intValue in class Number

See Also:

Number.intValue()

invert

public final S invert()

Description copied from interface: Group.Multiplicative

The multiplicative inverse.

Specified by:

invert in interface Group.Multiplicative<Scalar<S extends ExactDecimal<S>>>

Returns:

IDENTITY / this.

isAbsolute

public final boolean isAbsolute()

Specified by:

isAbsolute in interface Scalar<S extends ExactDecimal<S>>

Returns:

true if this is equal to its own norm, modulus or absolute value (non-negative real part and no imaginary part); otherwise false.

See Also:

Scalar.isAbsolute()

isSmall

public final boolean isSmall(double comparedTo)

Specified by:

isSmall in interface NormedVectorSpace<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Parameters:

comparedTo - What to compare with

Returns:

true if this is small compared to the magnitude of the input reference value.

longValue

public final long longValue()

Specified by:

longValue in interface AccessScalar<S extends ExactDecimal<S>>

Specified by:

longValue in class Number

See Also:

Number.longValue()

multiply

public final S multiply(double scalarMultiplicand)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

this * scalarMultiplicand.

multiply

public final S multiply(S scalarMultiplicand)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

this * multiplicand.

negate

public final S negate()

Description copied from interface: Group.Additive

The additive inverse of this.

Specified by:

negate in interface Group.Additive<Scalar<S extends ExactDecimal<S>>>

Returns:

-this.

norm

public final double norm()

Description copied from interface: NormedVectorSpace

this == this.signum().multiply(this.norm())

Specified by:

norm in interface NormedVectorSpace<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

The norm

signum

public final S signum()

Description copied from interface: NormedVectorSpace

this == this.signum().multiply(this.norm())

Specified by:

signum in interface NormedVectorSpace<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

A unit "vector"

subtract

public final S subtract(double scalarSubtrahend)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

this - scalarSubtrahend.

subtract

public final S subtract(S scalarSubtrahend)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<S extends ExactDecimal<S>>,S extends ExactDecimal<S>>

Returns:

this - scalarSubtrahend.

toBigDecimal

public final BigDecimal toBigDecimal()

Specified by:

toBigDecimal in interface Scalar<S extends ExactDecimal<S>>

toString

public final String toString()

Overrides:

toString in class Object

toString

public final String toString(NumberContext context)

Specified by:

toString in interface Scalar<S extends ExactDecimal<S>>

descriptor

protected abstract ExactDecimal.Descriptor descriptor()

wrap

protected abstract S wrap(long numerator)