org.ojalgo.scalar

Class BigScalar

java.lang.Object

java.lang.Number

org.ojalgo.scalar.BigScalar

All Implemented Interfaces:

Serializable, 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>, NumberContext.Enforceable<BigScalar>

Deprecated.

v44 In the future there will only be primitives based implementations of the Scalar interface

@Deprecated
public final class BigScalar
extends Number
implements Scalar<BigDecimal>, NumberContext.Enforceable<BigScalar>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.scalar.Scalar

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>

Field Summary

Fields

Modifier and Type	Field and Description
static Scalar.Factory<BigDecimal>	FACTORY Deprecated.
static BigScalar	NEG Deprecated.
static BigScalar	ONE Deprecated.
static BigScalar	TWO Deprecated.
static BigScalar	ZERO Deprecated.

Constructor Summary

Constructors

Constructor and Description
BigScalar() Deprecated.

Method Summary

Modifier and Type	Method and Description
BigScalar	add(BigDecimal arg) Deprecated.
BigScalar	add(double arg) Deprecated.
int	compareTo(BigDecimal reference) Deprecated.
BigScalar	conjugate() Deprecated. This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...
BigScalar	divide(BigDecimal arg) Deprecated.
BigScalar	divide(double arg) Deprecated.
double	doubleValue() Deprecated.
BigScalar	enforce(NumberContext context) Deprecated.
boolean	equals(Object obj) Deprecated.
float	floatValue() Deprecated.
BigDecimal	get() Deprecated.
int	hashCode() Deprecated.
int	intValue() Deprecated.
BigScalar	invert() Deprecated. The multiplicative inverse.
boolean	isAbsolute() Deprecated.
static boolean	isAbsolute(BigDecimal value) Deprecated.
boolean	isSmall(double comparedTo) Deprecated.
static boolean	isSmall(double comparedTo, BigDecimal value) Deprecated.
long	longValue() Deprecated.
BigScalar	multiply(BigDecimal arg) Deprecated.
BigScalar	multiply(double arg) Deprecated.
BigScalar	negate() Deprecated. The additive inverse of this.
double	norm() Deprecated. this == this.signum().multiply(this.norm())
static BigScalar	of(BigDecimal value) Deprecated.
BigScalar	signum() Deprecated. this == this.signum().multiply(this.norm())
BigScalar	subtract(BigDecimal arg) Deprecated.
BigScalar	subtract(double arg) Deprecated.
BigDecimal	toBigDecimal() Deprecated.
String	toString() Deprecated.
String	toString(NumberContext context) Deprecated.
static BigScalar	valueOf(double value) Deprecated.
static BigScalar	valueOf(Number number) Deprecated.

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.scalar.Scalar

add, divide, multiply, subtract, toPlainString

Methods inherited from interface org.ojalgo.structure.AccessScalar

byteValue, shortValue

Field Detail

FACTORY

public static final Scalar.Factory<BigDecimal> FACTORY

Deprecated.

NEG

public static final BigScalar NEG

Deprecated.

ONE

public static final BigScalar ONE

Deprecated.

TWO

public static final BigScalar TWO

Deprecated.

ZERO

public static final BigScalar ZERO

Deprecated.

Constructor Detail

BigScalar

public BigScalar()

Deprecated.

Method Detail

isAbsolute

public static boolean isAbsolute(BigDecimal value)

Deprecated.

isSmall

public static boolean isSmall(double comparedTo,
                              BigDecimal value)

Deprecated.

of

public static BigScalar of(BigDecimal value)

Deprecated.

valueOf

public static BigScalar valueOf(double value)

Deprecated.

valueOf

public static BigScalar valueOf(Number number)

Deprecated.

add

public BigScalar add(BigDecimal arg)

Deprecated.

Specified by:

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

Returns:

this + scalarAddend.

add

public BigScalar add(double arg)

Deprecated.

Specified by:

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

Returns:

this + scalarAddend.

compareTo

public int compareTo(BigDecimal reference)

Deprecated.

Specified by:

compareTo in interface Comparable<BigDecimal>

conjugate

public BigScalar conjugate()

Deprecated.

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)

Deprecated.

Specified by:

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

Returns:

this / scalarDivisor.

divide

public BigScalar divide(double arg)

Deprecated.

Specified by:

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

Returns:

this / scalarDivisor.

doubleValue

public double doubleValue()

Deprecated.

Specified by:

doubleValue in interface AccessScalar<BigDecimal>

Specified by:

doubleValue in class Number

See Also:

Number.doubleValue()

enforce

public BigScalar enforce(NumberContext context)

Deprecated.

Specified by:

enforce in interface NumberContext.Enforceable<BigScalar>

equals

public boolean equals(Object obj)

Deprecated.

Overrides:

equals in class Object

floatValue

public float floatValue()

Deprecated.

Specified by:

floatValue in interface AccessScalar<BigDecimal>

Specified by:

floatValue in class Number

See Also:

Number.floatValue()

get

public BigDecimal get()

Deprecated.

Specified by:

get in interface AccessScalar<BigDecimal>

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

intValue

public int intValue()

Deprecated.

Specified by:

intValue in interface AccessScalar<BigDecimal>

Specified by:

intValue in class Number

See Also:

Number.intValue()

invert

public BigScalar invert()

Deprecated.

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()

Deprecated.

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)

Deprecated.

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.

longValue

public long longValue()

Deprecated.

Specified by:

longValue in interface AccessScalar<BigDecimal>

Specified by:

longValue in class Number

See Also:

Number.longValue()

multiply

public BigScalar multiply(BigDecimal arg)

Deprecated.

Specified by:

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

Returns:

this * multiplicand.

multiply

public BigScalar multiply(double arg)

Deprecated.

Specified by:

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

Returns:

this * scalarMultiplicand.

negate

public BigScalar negate()

Deprecated.

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()

Deprecated.

Description copied from interface: NormedVectorSpace

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

Specified by:

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

Returns:

The norm

signum

public BigScalar signum()

Deprecated.

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)

Deprecated.

Specified by:

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

Returns:

this - scalarSubtrahend.

subtract

public BigScalar subtract(double arg)

Deprecated.

Specified by:

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

Returns:

this - scalarSubtrahend.

toBigDecimal

public BigDecimal toBigDecimal()

Deprecated.

Specified by:

toBigDecimal in interface Scalar<BigDecimal>

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

toString

public String toString(NumberContext context)

Deprecated.

Specified by:

toString in interface Scalar<BigDecimal>