Module ojalgo

Package org.ojalgo.scalar

Class Money

java.lang.Object

org.ojalgo.scalar.ExactDecimal<Money>

org.ojalgo.scalar.Money

All Implemented Interfaces:

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

public final class Money
extends ExactDecimal<Money>

An example ExactDecimal implementation corresponding to the SQL data type MONEY or DECIMAL(19,4).

Author:

apete

Nested Class Summary

Nested classes/interfaces inherited from class org.ojalgo.scalar.ExactDecimal

ExactDecimal.Descriptor, ExactDecimal.Factory<S extends ExactDecimal<S>>

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

Group.Additive<T>, Group.Multiplicative<T>

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

Operation.Addition<T>, Operation.Division<T>, Operation.Multiplication<T>, Operation.Subtraction<T>

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ExactDecimal.Descriptor	DESCRIPTOR
static final Scalar.Factory<Money>	FACTORY
static final Money	NEG
static final Money	ONE
static final Money	TWO
static final Money	ZERO

Constructor Summary

Constructors

Constructor	Description
Money()

Method Summary

Modifier and Type	Method	Description
default Money	add(float scalarAddend)
protected ExactDecimal.Descriptor	descriptor()
default Money	divide(float scalarDivisor)
static boolean	isAbsolute(Money value)
static boolean	isInfinite(Money value)
static boolean	isNaN(Money value)
static boolean	isSmall(double comparedTo, Money value)
default Money	multiply(float scalarMultiplicand)
default Money	subtract(float scalarSubtrahend)
static Money	valueOf(double value)
static Money	valueOf(Comparable<?> number)
protected Money	wrap(long numerator)

Methods inherited from class org.ojalgo.scalar.ExactDecimal

add, add, compareTo, conjugate, divide, divide, doubleValue, enforce, extractUnscaledValue, floatValue, get, intValue, invert, isAbsolute, isSmall, isZero, longValue, multiply, multiply, negate, norm, power, signum, subtract, subtract, toBigDecimal, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.type.NumberDefinition

booleanValue, byteValue, shortValue

Methods inherited from interface org.ojalgo.scalar.Scalar

add, dimensions, divide, multiply, rank, subtract, toPlainString

Methods inherited from interface org.ojalgo.tensor.Tensor

components, isSameShape

Field Details

DESCRIPTOR

public static final ExactDecimal.Descriptor DESCRIPTOR

FACTORY

public static final Scalar.Factory<Money> FACTORY

NEG

public static final Money NEG

ONE

public static final Money ONE

TWO

public static final Money TWO

ZERO

public static final Money ZERO

Constructor Details

Money

public Money()

Method Details

isAbsolute

public static boolean isAbsolute(Money value)

isInfinite

public static boolean isInfinite(Money value)

isNaN

public static boolean isNaN(Money value)

isSmall

public static boolean isSmall(double comparedTo,
 Money value)

valueOf

public static Money valueOf(Comparable<?> number)

valueOf

public static Money valueOf(double value)

descriptor

protected ExactDecimal.Descriptor descriptor()

Specified by:

descriptor in class ExactDecimal<Money>

wrap

protected Money wrap(long numerator)

Specified by:

wrap in class ExactDecimal<Money>

add

default Money add(float scalarAddend)

Specified by:

add in interface ScalarOperation.Addition<Scalar<S extends org.ojalgo.scalar.SelfDeclaringScalar<S>>,S extends org.ojalgo.scalar.SelfDeclaringScalar<S>>

Returns:

this + scalarAddend.

divide

default Money divide(float scalarDivisor)

Specified by:

divide in interface ScalarOperation.Division<Scalar<S extends org.ojalgo.scalar.SelfDeclaringScalar<S>>,S extends org.ojalgo.scalar.SelfDeclaringScalar<S>>

Returns:

this / scalarDivisor.

multiply

default Money multiply(float scalarMultiplicand)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<S extends org.ojalgo.scalar.SelfDeclaringScalar<S>>,S extends org.ojalgo.scalar.SelfDeclaringScalar<S>>

Returns:

this * scalarMultiplicand.

subtract

default Money subtract(float scalarSubtrahend)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<S extends org.ojalgo.scalar.SelfDeclaringScalar<S>>,S extends org.ojalgo.scalar.SelfDeclaringScalar<S>>

Returns:

this - scalarSubtrahend.