Module ojalgo

Package org.ojalgo.scalar

Class PrimitiveScalar

java.lang.Object

org.ojalgo.scalar.PrimitiveScalar

All Implemented Interfaces:

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

public final class PrimitiveScalar
extends java.lang.Object
implements Scalar<java.lang.Double>, NumberContext.Enforceable<PrimitiveScalar>

Nested Class Summary

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.scalar.Scalar

Scalar.Factory<N extends java.lang.Comparable<N>>

Nested classes/interfaces inherited from interface org.ojalgo.algebra.ScalarOperation

ScalarOperation.Addition<T,N extends java.lang.Comparable<N>>, ScalarOperation.Division<T,N extends java.lang.Comparable<N>>, ScalarOperation.Multiplication<T,N extends java.lang.Comparable<N>>, ScalarOperation.Subtraction<T,N extends java.lang.Comparable<N>>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static NumberContext	CONTEXT
static Scalar.Factory<java.lang.Double>	FACTORY
private double	myValue
static PrimitiveScalar	NaN
static PrimitiveScalar	NEG
static PrimitiveScalar	NEGATIVE_INFINITY
static PrimitiveScalar	ONE
static PrimitiveScalar	POSITIVE_INFINITY
static PrimitiveScalar	TWO
static PrimitiveScalar	ZERO

Constructor Summary

Constructors

Modifier	Constructor	Description
	PrimitiveScalar()
private	PrimitiveScalar(double value)

Method Summary

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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 Detail

FACTORY

public static final Scalar.Factory<java.lang.Double> FACTORY

NaN

public static final PrimitiveScalar NaN

NEG

public static final PrimitiveScalar NEG

NEGATIVE_INFINITY

public static final PrimitiveScalar NEGATIVE_INFINITY

ONE

public static final PrimitiveScalar ONE

POSITIVE_INFINITY

public static final PrimitiveScalar POSITIVE_INFINITY

TWO

public static final PrimitiveScalar TWO

ZERO

public static final PrimitiveScalar ZERO

CONTEXT

static final NumberContext CONTEXT

myValue

private final double myValue

Constructor Detail

PrimitiveScalar

public PrimitiveScalar()

PrimitiveScalar

private PrimitiveScalar(double value)

Method Detail

isAbsolute

public static boolean isAbsolute(double value)

isInfinite

public static boolean isInfinite(double value)

isNaN

public static boolean isNaN(double value)

isSmall

public static boolean isSmall(double comparedTo,
                              double value)

of

public static PrimitiveScalar of(double value)

valueOf

public static PrimitiveScalar valueOf(java.lang.Comparable<?> number)

valueOf

public static PrimitiveScalar valueOf(double value)

add

public PrimitiveScalar add(double arg)

Specified by:

add in interface ScalarOperation.Addition<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this + scalarAddend.

add

public PrimitiveScalar add(java.lang.Double arg)

Specified by:

add in interface ScalarOperation.Addition<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this + scalarAddend.

add

public PrimitiveScalar add(float scalarAddend)

Specified by:

add in interface ScalarOperation.Addition<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this + scalarAddend.

compareTo

public int compareTo(java.lang.Double reference)

Specified by:

compareTo in interface java.lang.Comparable<java.lang.Double>

conjugate

public PrimitiveScalar 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<java.lang.Double>,java.lang.Double>

divide

public PrimitiveScalar divide(double arg)

Specified by:

divide in interface ScalarOperation.Division<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this / scalarDivisor.

divide

public PrimitiveScalar divide(java.lang.Double arg)

Specified by:

divide in interface ScalarOperation.Division<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this / scalarDivisor.

divide

public PrimitiveScalar divide(float scalarDivisor)

Specified by:

divide in interface ScalarOperation.Division<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this / scalarDivisor.

doubleValue

public double doubleValue()

Specified by:

doubleValue in interface NumberDefinition

enforce

public PrimitiveScalar enforce(NumberContext context)

Specified by:

enforce in interface NumberContext.Enforceable<PrimitiveScalar>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

floatValue

public float floatValue()

Specified by:

floatValue in interface NumberDefinition

get

public java.lang.Double get()

Specified by:

get in interface AccessScalar<java.lang.Double>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

intValue

public int intValue()

Specified by:

intValue in interface NumberDefinition

invert

public PrimitiveScalar invert()

Description copied from interface: Group.Multiplicative

The multiplicative inverse.

Specified by:

invert in interface Group.Multiplicative<Scalar<java.lang.Double>>

Returns:

IDENTITY / this.

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface Scalar<java.lang.Double>

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<java.lang.Double>,java.lang.Double>

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<java.lang.Double>

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 PrimitiveScalar multiply(double arg)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this * scalarMultiplicand.

multiply

public PrimitiveScalar multiply(java.lang.Double arg)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this * multiplicand.

multiply

public PrimitiveScalar multiply(float scalarMultiplicand)

Specified by:

multiply in interface ScalarOperation.Multiplication<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this * scalarMultiplicand.

negate

public PrimitiveScalar negate()

Description copied from interface: Group.Additive

The additive inverse of this.

Specified by:

negate in interface Group.Additive<Scalar<java.lang.Double>>

Returns:

-this.

norm

public double norm()

Description copied from interface: NormedVectorSpace

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

Specified by:

norm in interface NormedVectorSpace<Scalar<java.lang.Double>,java.lang.Double>

Returns:

The norm

power

public PrimitiveScalar power(int power)

Description copied from interface: Operation.Multiplication

Multiply by itself power times.

Specified by:

power in interface Operation.Multiplication<Scalar<java.lang.Double>>

signum

public PrimitiveScalar signum()

Description copied from interface: NormedVectorSpace

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

Specified by:

signum in interface NormedVectorSpace<Scalar<java.lang.Double>,java.lang.Double>

Returns:

A unit "vector"

subtract

public PrimitiveScalar subtract(double arg)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this - scalarSubtrahend.

subtract

public PrimitiveScalar subtract(java.lang.Double arg)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this - scalarSubtrahend.

subtract

public PrimitiveScalar subtract(float scalarSubtrahend)

Specified by:

subtract in interface ScalarOperation.Subtraction<Scalar<java.lang.Double>,java.lang.Double>

Returns:

this - scalarSubtrahend.

toBigDecimal

public java.math.BigDecimal toBigDecimal()

Specified by:

toBigDecimal in interface Scalar<java.lang.Double>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(NumberContext context)

Specified by:

toString in interface Scalar<java.lang.Double>