Class BigScalar

java.lang.Object

org.ojalgo.scalar.BigScalar

All Implemented Interfaces:

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

public final class BigScalar
extends Object
implements Scalar<BigDecimal>, NumberContext.Enforceable<BigScalar>

A BigDecimal based implementation of the Scalar interface. Most/all other implementations are based on primitive components. This implementation exists for historical reasons, and is now primarily used for tests.

Nested Class Summary

Nested classes/interfaces inherited from interface Group

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

Nested classes/interfaces inherited from interface Operation

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

Nested classes/interfaces inherited from interface Scalar

Scalar.Factory<N>

Nested classes/interfaces inherited from interface ScalarOperation

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

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final NumberContext	CONTEXT
static final Scalar.Factory<BigDecimal>	FACTORY
private final BigDecimal	myNumber
static final BigScalar	NEG
static final BigScalar	ONE
static final BigScalar	TWO
static final BigScalar	ZERO

Constructor Summary

Constructors

Modifier	Constructor	Description
	BigScalar()
private	BigScalar(BigDecimal number)

Method Summary

Modifier and Type	Method	Description
BigScalar	add(double arg)
BigScalar	add(float scalarAddend)
BigScalar	add(BigDecimal arg)
int	compareTo(BigDecimal reference)
BigScalar	conjugate()	This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...
BigScalar	divide(double arg)
BigScalar	divide(float scalarDivisor)
BigScalar	divide(BigDecimal arg)
double	doubleValue()
BigScalar	enforce(NumberContext context)
boolean	equals(Object obj)
float	floatValue()
BigDecimal	get()
int	hashCode()
int	intValue()
BigScalar	invert()	The multiplicative inverse.
boolean	isAbsolute()
static boolean	isAbsolute(BigDecimal value)
boolean	isSmall(double comparedTo)
static boolean	isSmall(double comparedTo, BigDecimal value)
boolean	isZero()	Tests if this scalar value is exactly zero.
long	longValue()
BigScalar	multiply(double arg)
BigScalar	multiply(float scalarMultiplicand)
BigScalar	multiply(BigDecimal arg)
BigScalar	negate()	The additive inverse of this.
double	norm()	this == this.signum().multiply(this.norm())
static BigScalar	of(BigDecimal value)
BigScalar	power(int power)	Multiply by itself power times.
BigScalar	signum()	this == this.signum().multiply(this.norm())
BigScalar	subtract(double arg)
BigScalar	subtract(float scalarSubtrahend)
BigScalar	subtract(BigDecimal arg)
BigDecimal	toBigDecimal()
String	toString()
String	toString(NumberContext context)
static BigScalar	valueOf(double value)
static BigScalar	valueOf(Comparable<?> number)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NumberDefinition

booleanValue, byteValue, shortValue

Methods inherited from interface Scalar

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

Methods inherited from interface Tensor

components, isSameShape

Field Details

FACTORY

public static final Scalar.Factory<BigDecimal> FACTORY

NEG

public static final BigScalar NEG

ONE

public static final BigScalar ONE

TWO

public static final BigScalar TWO

ZERO

public static final BigScalar ZERO

CONTEXT

static final NumberContext CONTEXT

myNumber

private final BigDecimal myNumber

Constructor Details

BigScalar

public BigScalar()

BigScalar

private BigScalar(BigDecimal number)

Method Details

isAbsolute

public static boolean isAbsolute(BigDecimal value)

isSmall

public static boolean isSmall(double comparedTo,
 BigDecimal value)

of

public static BigScalar of(BigDecimal value)

valueOf

public static BigScalar valueOf(Comparable<?> number)

valueOf

public static BigScalar valueOf(double value)

add

public BigScalar add(BigDecimal arg)

Specified by:

add in interface ScalarOperation.Addition<Scalar<BigDecimal>, BigDecimal>

Returns:

this + scalarAddend.

add

public BigScalar add(double arg)

Specified by:

add in interface ScalarOperation.Addition<Scalar<BigDecimal>, BigDecimal>

Returns:

this + scalarAddend.

add

public BigScalar add(float scalarAddend)

Specified by:

add in interface ScalarOperation.Addition<Scalar<BigDecimal>, BigDecimal>

Returns:

this + scalarAddend.

compareTo

public int compareTo(BigDecimal reference)

Specified by:

compareTo in interface Comparable<BigDecimal>

conjugate

public BigScalar conjugate()

Description copied from interface: VectorSpace

This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...

The conjugate transpose of a matrix and/or the conjugate of a scalar/field like ComplexNumber or Quaternion.

The conjugate transpose of a real matrix is simply its transpose.

Specified by:

conjugate in interface VectorSpace<Scalar<BigDecimal>, BigDecimal>

divide

public BigScalar divide(BigDecimal arg)

Specified by:

divide in interface ScalarOperation.Division<Scalar<BigDecimal>, BigDecimal>

Returns:

this / scalarDivisor.

divide

public BigScalar divide(double arg)

Specified by:

divide in interface ScalarOperation.Division<Scalar<BigDecimal>, BigDecimal>

Returns:

this / scalarDivisor.

divide

public BigScalar divide(float scalarDivisor)

Specified by:

divide in interface ScalarOperation.Division<Scalar<BigDecimal>, BigDecimal>

Returns:

this / scalarDivisor.

doubleValue

public double doubleValue()

Specified by:

doubleValue in interface NumberDefinition

enforce

public BigScalar enforce(NumberContext context)

Specified by:

enforce in interface NumberContext.Enforceable<BigScalar>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

floatValue

public float floatValue()

Specified by:

floatValue in interface NumberDefinition

get

public BigDecimal get()

Specified by:

get in interface AccessScalar<BigDecimal>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

intValue

public int intValue()

Specified by:

intValue in interface NumberDefinition

invert

public BigScalar invert()

Description copied from interface: Group.Multiplicative

The multiplicative inverse.

Specified by:

invert in interface Group.Multiplicative<Scalar<BigDecimal>>

Returns:

IDENTITY / this.

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface Scalar<BigDecimal>

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:

• Scalar.isAbsolute()

isSmall

public boolean isSmall(double comparedTo)

Specified by:

isSmall in interface NormedVectorSpace<Scalar<BigDecimal>, BigDecimal>

Parameters:

comparedTo - What to compare with

Returns:

true if this is small compared to the magnitude of the input reference value.

isZero

public boolean isZero()

Description copied from interface: Scalar

Tests if this scalar value is exactly zero.

Each implementation should test for zero as exactly as possible based on what's achievable with that specific scalar type. The purpose is NOT to have similar behavior between different implementations, but rather to leverage the full precision and capabilities of each type.

For example:

• Primitive types (like double) should use exact equality comparison
• High-precision types (like Quadruple) should check both base and remainder components
• Arbitrary-precision types (like BigDecimal) should use their built-in zero detection
• Complex types should check both real and imaginary parts

This method should NOT use tolerance-based comparisons or approximate zero detection, as those are better handled by context-aware methods like NormedVectorSpace.isSmall(double).

Specified by:

isZero in interface Scalar<BigDecimal>

Returns:

true if this scalar represents exactly zero, false otherwise

See Also:

• NormedVectorSpace.isSmall(double)

longValue

public long longValue()

Specified by:

longValue in interface NumberDefinition

multiply

public BigScalar multiply(BigDecimal arg)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<BigDecimal>, BigDecimal>

Returns:

this * multiplicand.

multiply

public BigScalar multiply(double arg)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<BigDecimal>, BigDecimal>

Returns:

this * scalarMultiplicand.

multiply

public BigScalar multiply(float scalarMultiplicand)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<BigDecimal>, BigDecimal>

Returns:

this * scalarMultiplicand.

negate

public BigScalar negate()

Description copied from interface: Group.Additive

The additive inverse of this.

Specified by:

negate in interface Group.Additive<Scalar<BigDecimal>>

Returns:

-this.

norm

public double norm()

Description copied from interface: NormedVectorSpace

this == this.signum().multiply(this.norm())

Specified by:

norm in interface NormedVectorSpace<Scalar<BigDecimal>, BigDecimal>

Returns:

The norm

power

public BigScalar power(int power)

Description copied from interface: Operation.Multiplication

Multiply by itself power times.

Specified by:

power in interface Operation.Multiplication<Scalar<BigDecimal>>

signum

public BigScalar signum()

Description copied from interface: NormedVectorSpace

this == this.signum().multiply(this.norm())

Specified by:

signum in interface NormedVectorSpace<Scalar<BigDecimal>, BigDecimal>

Returns:

A unit "vector"

subtract

public BigScalar subtract(BigDecimal arg)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<BigDecimal>, BigDecimal>

Returns:

this - scalarSubtrahend.

subtract

public BigScalar subtract(double arg)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<BigDecimal>, BigDecimal>

Returns:

this - scalarSubtrahend.

subtract

public BigScalar subtract(float scalarSubtrahend)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<BigDecimal>, BigDecimal>

Returns:

this - scalarSubtrahend.

toBigDecimal

public BigDecimal toBigDecimal()

Specified by:

toBigDecimal in interface Scalar<BigDecimal>

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(NumberContext context)

Specified by:

toString in interface Scalar<BigDecimal>