org.ojalgo.scalar

Interface Scalar<N extends Number>

All Superinterfaces:

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

All Known Implementing Classes:

BigScalar, ComplexNumber, ComplexNumber.Normalised, ExactDecimal, Money, PrimitiveScalar, Quaternion, Quaternion.Versor, RationalNumber

public interface Scalar<N extends Number>
extends AccessScalar<N>, Field<Scalar<N>>, NormedVectorSpace<Scalar<N>,N>, ScalarOperation.Addition<Scalar<N>,N>, ScalarOperation.Division<Scalar<N>,N>, ScalarOperation.Subtraction<Scalar<N>,N>, Comparable<N>

A Scalar is:

1. An abstraction of a vector/matrix element.
2. A Number decorator, increasing the number of things you can do with them.

Theoretically it is a Field or at least a Division ring.

The intention is that implementors should be final immutable subclasses of Number and that they should be inline with the requirements for ValueBased classes.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	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>

Method Summary

Modifier and Type	Method and Description
default Scalar<N>	add(Scalar<N> addend)
default Scalar<N>	divide(Scalar<N> divisor)
boolean	isAbsolute()
default Scalar<N>	multiply(Scalar<N> multiplicand)
default Scalar<N>	subtract(Scalar<N> subtrahend)
BigDecimal	toBigDecimal()
default String	toPlainString(NumberContext context)
String	toString(NumberContext context)

Methods inherited from interface org.ojalgo.structure.AccessScalar

byteValue, doubleValue, floatValue, get, intValue, longValue, shortValue

Methods inherited from interface org.ojalgo.algebra.Group.Multiplicative

invert

Methods inherited from interface org.ojalgo.algebra.NormedVectorSpace

isSmall, norm, signum

Methods inherited from interface org.ojalgo.algebra.VectorSpace

conjugate

Methods inherited from interface org.ojalgo.algebra.Group.Additive

negate

Methods inherited from interface org.ojalgo.algebra.ScalarOperation.Multiplication

multiply, multiply

Methods inherited from interface org.ojalgo.algebra.ScalarOperation.Addition

add, add

Methods inherited from interface org.ojalgo.algebra.ScalarOperation.Division

divide, divide

Methods inherited from interface org.ojalgo.algebra.ScalarOperation.Subtraction

subtract, subtract

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

add

default Scalar<N> add(Scalar<N> addend)

Specified by:

add in interface Operation.Addition<Scalar<N extends Number>>

Parameters:

addend - What to add

Returns:

this + addend

divide

default Scalar<N> divide(Scalar<N> divisor)

Specified by:

divide in interface Operation.Division<Scalar<N extends Number>>

Parameters:

divisor - The divisor

Returns:

this / divisor.

isAbsolute

boolean isAbsolute()

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:

isAbsolute()

multiply

default Scalar<N> multiply(Scalar<N> multiplicand)

Specified by:

multiply in interface Operation.Multiplication<Scalar<N extends Number>>

Parameters:

multiplicand - The multiplicand

Returns:

this * multiplicand.

subtract

default Scalar<N> subtract(Scalar<N> subtrahend)

Specified by:

subtract in interface Operation.Subtraction<Scalar<N extends Number>>

Parameters:

subtrahend - The subtrahend

Returns:

this - subtrahend.

toBigDecimal

BigDecimal toBigDecimal()

toPlainString

default String toPlainString(NumberContext context)

toString

String toString(NumberContext context)