Package org.ojalgo.scalar
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 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 Comparable<N>>
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
FieldsModifier and TypeFieldDescription(package private) static final NumberContext
static final Scalar.Factory
<BigDecimal> private final BigDecimal
static final BigScalar
static final BigScalar
static final BigScalar
static final BigScalar
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadd
(double arg) add
(float scalarAddend) add
(BigDecimal arg) int
compareTo
(BigDecimal reference) This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...divide
(double arg) divide
(float scalarDivisor) divide
(BigDecimal arg) double
enforce
(NumberContext context) boolean
float
get()
int
hashCode()
int
intValue()
invert()
The multiplicative inverse.boolean
static boolean
isAbsolute
(BigDecimal value) boolean
isSmall
(double comparedTo) static boolean
isSmall
(double comparedTo, BigDecimal value) long
multiply
(double arg) multiply
(float scalarMultiplicand) multiply
(BigDecimal arg) negate()
The additive inverse of this.double
norm()
this == this.signum().multiply(this.norm())
static BigScalar
of
(BigDecimal value) power
(int power) Multiply by itselfpower
times.signum()
this == this.signum().multiply(this.norm())
subtract
(double arg) subtract
(float scalarSubtrahend) subtract
(BigDecimal arg) toString()
toString
(NumberContext context) static BigScalar
valueOf
(double value) static BigScalar
valueOf
(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 Details
-
FACTORY
-
NEG
-
ONE
-
TWO
-
ZERO
-
CONTEXT
-
myNumber
-
-
Constructor Details
-
BigScalar
public BigScalar() -
BigScalar
-
-
Method Details
-
isAbsolute
-
isSmall
-
of
-
valueOf
-
valueOf
-
add
- Specified by:
add
in interfaceScalarOperation.Addition<Scalar<BigDecimal>,
BigDecimal> - Returns:
this + scalarAddend
.
-
add
- Specified by:
add
in interfaceScalarOperation.Addition<Scalar<BigDecimal>,
BigDecimal> - Returns:
this + scalarAddend
.
-
add
- Specified by:
add
in interfaceScalarOperation.Addition<Scalar<BigDecimal>,
BigDecimal> - Returns:
this + scalarAddend
.
-
compareTo
- Specified by:
compareTo
in interfaceComparable<BigDecimal>
-
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 interfaceVectorSpace<Scalar<BigDecimal>,
BigDecimal>
-
divide
- Specified by:
divide
in interfaceScalarOperation.Division<Scalar<BigDecimal>,
BigDecimal> - Returns:
this / scalarDivisor
.
-
divide
- Specified by:
divide
in interfaceScalarOperation.Division<Scalar<BigDecimal>,
BigDecimal> - Returns:
this / scalarDivisor
.
-
divide
- Specified by:
divide
in interfaceScalarOperation.Division<Scalar<BigDecimal>,
BigDecimal> - Returns:
this / scalarDivisor
.
-
doubleValue
public double doubleValue()- Specified by:
doubleValue
in interfaceNumberDefinition
-
enforce
- Specified by:
enforce
in interfaceNumberContext.Enforceable<BigScalar>
-
equals
-
floatValue
public float floatValue()- Specified by:
floatValue
in interfaceNumberDefinition
-
get
- Specified by:
get
in interfaceAccessScalar<BigDecimal>
-
hashCode
public int hashCode() -
intValue
public int intValue()- Specified by:
intValue
in interfaceNumberDefinition
-
invert
Description copied from interface:Group.Multiplicative
The multiplicative inverse.- Specified by:
invert
in interfaceGroup.Multiplicative<Scalar<BigDecimal>>
- Returns:
IDENTITY / this
.
-
isAbsolute
public boolean isAbsolute()- Specified by:
isAbsolute
in interfaceScalar<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:
-
isSmall
public boolean isSmall(double comparedTo) - Specified by:
isSmall
in interfaceNormedVectorSpace<Scalar<BigDecimal>,
BigDecimal> - Parameters:
comparedTo
- What to compare with- Returns:
- true if this is small compared to the magnitude of the input reference value.
-
longValue
public long longValue()- Specified by:
longValue
in interfaceNumberDefinition
-
multiply
- Specified by:
multiply
in interfaceScalarOperation.Multiplication<Scalar<BigDecimal>,
BigDecimal> - Returns:
this * multiplicand
.
-
multiply
- Specified by:
multiply
in interfaceScalarOperation.Multiplication<Scalar<BigDecimal>,
BigDecimal> - Returns:
this * scalarMultiplicand
.
-
multiply
- Specified by:
multiply
in interfaceScalarOperation.Multiplication<Scalar<BigDecimal>,
BigDecimal> - Returns:
this * scalarMultiplicand
.
-
negate
Description copied from interface:Group.Additive
The additive inverse of this.- Specified by:
negate
in interfaceGroup.Additive<Scalar<BigDecimal>>
- Returns:
-this
.
-
norm
public double norm()Description copied from interface:NormedVectorSpace
this == this.signum().multiply(this.norm())
- Specified by:
norm
in interfaceNormedVectorSpace<Scalar<BigDecimal>,
BigDecimal> - Returns:
- The norm
-
power
Description copied from interface:Operation.Multiplication
Multiply by itselfpower
times.- Specified by:
power
in interfaceOperation.Multiplication<Scalar<BigDecimal>>
-
signum
Description copied from interface:NormedVectorSpace
this == this.signum().multiply(this.norm())
- Specified by:
signum
in interfaceNormedVectorSpace<Scalar<BigDecimal>,
BigDecimal> - Returns:
- A unit "vector"
-
subtract
- Specified by:
subtract
in interfaceScalarOperation.Subtraction<Scalar<BigDecimal>,
BigDecimal> - Returns:
this - scalarSubtrahend
.
-
subtract
- Specified by:
subtract
in interfaceScalarOperation.Subtraction<Scalar<BigDecimal>,
BigDecimal> - Returns:
this - scalarSubtrahend
.
-
subtract
- Specified by:
subtract
in interfaceScalarOperation.Subtraction<Scalar<BigDecimal>,
BigDecimal> - Returns:
this - scalarSubtrahend
.
-
toBigDecimal
- Specified by:
toBigDecimal
in interfaceScalar<BigDecimal>
-
toString
-
toString
- Specified by:
toString
in interfaceScalar<BigDecimal>
-