Module ojalgo

Package org.ojalgo.scalar

Class Quantity

java.lang.Object

org.ojalgo.scalar.ExactDecimal<Quantity>

org.ojalgo.scalar.Quantity

All Implemented Interfaces:

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

public final class Quantity
extends ExactDecimal<Quantity>

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

Constructor Summary

Constructors

Constructor	Description
Quantity()

Method Summary

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

NEG

public static final Quantity NEG

ONE

public static final Quantity ONE

TWO

public static final Quantity TWO

ZERO

public static final Quantity ZERO

Constructor Details

Quantity

public Quantity()

Method Details

valueOf

public static Quantity valueOf(Comparable<?> number)

valueOf

public static Quantity valueOf(double value)

multiply

public Amount multiply(Price price)

descriptor

protected ExactDecimal.Descriptor descriptor()

Specified by:

descriptor in class ExactDecimal<Quantity>

wrap

protected Quantity wrap(long numerator)

Specified by:

wrap in class ExactDecimal<Quantity>

add

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