Module ojalgo

Package org.ojalgo.scalar

Class Price

java.lang.Object

org.ojalgo.scalar.ExactDecimal<Price>

org.ojalgo.scalar.Price

All Implemented Interfaces:

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

public final class Price
extends ExactDecimal<Price>

price or exchange rate as in "amount = price * quatity" or "amount = rate * amount"

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

Constructor Summary

Constructors

Constructor	Description
Price()

Method Summary

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

NEG

public static final Price NEG

ONE

public static final Price ONE

TWO

public static final Price TWO

ZERO

public static final Price ZERO

Constructor Details

Price

public Price()

Method Details

valueOf

public static Price valueOf(Comparable<?> number)

valueOf

public static Price valueOf(double value)

multiply

public Amount multiply(Quantity quanntity)

descriptor

protected ExactDecimal.Descriptor descriptor()

Specified by:

descriptor in class ExactDecimal<Price>

wrap

protected Price wrap(long numerator)

Specified by:

wrap in class ExactDecimal<Price>

add

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