Module ojalgo

Package org.ojalgo.scalar

Class Amount

java.lang.Object

org.ojalgo.scalar.ExactDecimal<Amount>

org.ojalgo.scalar.Amount

All Implemented Interfaces:

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

public final class Amount
extends ExactDecimal<Amount>

(currency) amount as in "amount = price * quatity"

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<Amount>	FACTORY
static final Amount	NEG
static final Amount	ONE
static final Amount	TWO
static final Amount	ZERO

Constructor Summary

Constructors

Constructor	Description
Amount()

Method Summary

Modifier and Type	Method	Description
default Amount	add(float scalarAddend)
protected ExactDecimal.Descriptor	descriptor()
default Amount	divide(float scalarDivisor)
Quantity	divide(Price price)
Price	divide(Quantity quanntity)
default Amount	multiply(float scalarMultiplicand)
Amount	multiply(Price rate)
default Amount	subtract(float scalarSubtrahend)
static Amount	valueOf(double value)
static Amount	valueOf(Comparable<?> number)
protected Amount	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<Amount> FACTORY

NEG

public static final Amount NEG

ONE

public static final Amount ONE

TWO

public static final Amount TWO

ZERO

public static final Amount ZERO

Constructor Details

Amount

public Amount()

Method Details

valueOf

public static Amount valueOf(Comparable<?> number)

valueOf

public static Amount valueOf(double value)

divide

public Quantity divide(Price price)

divide

public Price divide(Quantity quanntity)

multiply

public Amount multiply(Price rate)

descriptor

protected ExactDecimal.Descriptor descriptor()

Specified by:

descriptor in class ExactDecimal<Amount>

wrap

protected Amount wrap(long numerator)

Specified by:

wrap in class ExactDecimal<Amount>

add

default Amount 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 Amount 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 Amount 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 Amount 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.