org.ojalgo.scalar
Class BigScalar

java.lang.Object
  java.lang.Number
      org.ojalgo.scalar.BigScalar

All Implemented Interfaces:

Serializable, Comparable<BigDecimal>, Scalar<BigDecimal>

public final class BigScalar
extends Number

See Also:

Serialized Form

Field Summary

static BigScalar	ONE
static BigScalar	ZERO

Constructor Summary

BigScalar(BigDecimal aNmbr)

BigScalar(Number aNmbr)

Method Summary

BigScalar	add(BigDecimal aNmbr)
BigScalar	add(double aNmbr)
int	compareTo(BigDecimal aNmbr)
BigScalar	conjugate()
BigScalar	divide(BigDecimal aNmbr)
Scalar<BigDecimal>	divide(double aNmbr)
double	doubleValue()
BigScalar	enforce(NumberContext aCntxt)
boolean	equals(Object someObj)
boolean	equals(Scalar<?> aSclr)
float	floatValue()
double	getArgument()
double	getImaginary()
double	getModulus()
BigDecimal	getNumber()
double	getReal()
int	hashCode()
int	intValue()
BigScalar	invert()
boolean	isAbsolute()
boolean	isInfinite()
boolean	isNaN()
boolean	isPositive() Strictly Positive, and definately real.
boolean	isReal()
boolean	isZero() Intends to capture if a scalar is numerically/practically zero, and in a way that is concistent between different implementations.
long	longValue()
BigScalar	multiply(BigDecimal aNmbr)
Scalar<BigDecimal>	multiply(double aNmbr)
BigScalar	negate()
BigScalar	power(int anExp)
BigScalar	root(int anExp)
Scalar<BigDecimal>	round(NumberContext aCntxt)
BigScalar	signum()
BigScalar	subtract(BigDecimal aNmbr)
Scalar<BigDecimal>	subtract(double aNmbr)
BigDecimal	toBigDecimal()
ComplexNumber	toComplexNumber()
RationalNumber	toRationalNumber()
String	toString()

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ONE

public static final BigScalar ONE

ZERO

public static final BigScalar ZERO

Constructor Detail

BigScalar

public BigScalar(BigDecimal aNmbr)

BigScalar

public BigScalar(Number aNmbr)

Method Detail

add

public BigScalar add(BigDecimal aNmbr)

See Also:

Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

add

public BigScalar add(double aNmbr)

See Also:

Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

compareTo

public int compareTo(BigDecimal aNmbr)

conjugate

public BigScalar conjugate()

See Also:

Scalar.conjugate(), Scalar.invert(), Scalar.negate()

divide

public BigScalar divide(BigDecimal aNmbr)

See Also:

Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

divide

public Scalar<BigDecimal> divide(double aNmbr)

See Also:

Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

enforce

public BigScalar enforce(NumberContext aCntxt)

equals

public boolean equals(Scalar<?> aSclr)

floatValue

public float floatValue()

Specified by:

floatValue in class Number

getArgument

public double getArgument()

See Also:

Scalar.getArgument(), Scalar.getImaginary(), Scalar.getModulus(), Scalar.getReal()

getImaginary

public double getImaginary()

See Also:

Scalar.getArgument(), Scalar.getImaginary(), Scalar.getModulus(), Scalar.getReal()

getModulus

public double getModulus()

See Also:

Scalar.getArgument(), Scalar.getImaginary(), Scalar.getModulus(), Scalar.getReal()

getNumber

public BigDecimal getNumber()

getReal

public double getReal()

See Also:

Scalar.getArgument(), Scalar.getImaginary(), Scalar.getModulus(), Scalar.getReal()

intValue

public int intValue()

Specified by:

intValue in class Number

invert

public BigScalar invert()

See Also:

Scalar.conjugate(), Scalar.invert(), Scalar.negate()

isAbsolute

public boolean isAbsolute()

Returns:

true if this is equal to its own modulus (non-negative real part and no imaginary part); otherwise false.

See Also:

Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isPositive(), Scalar.isZero()

isInfinite

public boolean isInfinite()

See Also:

Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isPositive(), Scalar.isZero()

isNaN

public boolean isNaN()

See Also:

Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isPositive(), Scalar.isZero()

isReal

public boolean isReal()

Returns:

true if there is the imaginary part is negligible; otherwise false.

See Also:

Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isPositive(), Scalar.isZero()

isPositive

public boolean isPositive()

Description copied from interface: Scalar

Strictly Positive, and definately real. Real, as defined by Scalar.isReal(), not zero, as defined by Scalar.isZero(), and > 0.0.

Returns:

true if the real part is strictly positive (not zero) and the imaginary part negligible; otherwise false.

See Also:

Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isPositive(), Scalar.isZero()

isZero

public boolean isZero()

Description copied from interface: Scalar

Intends to capture if a scalar is numerically/practically zero, and in a way that is concistent between different implementations. The potential exactness of BigScalar and RationalNumber should not be reflected here.

Returns:

true if the modulus is (practically) zero; otherwise false.

See Also:

Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isPositive(), Scalar.isZero()

longValue

public long longValue()

Specified by:

longValue in class Number

multiply

public BigScalar multiply(BigDecimal aNmbr)

See Also:

Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

multiply

public Scalar<BigDecimal> multiply(double aNmbr)

See Also:

Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

negate

public BigScalar negate()

See Also:

Scalar.conjugate(), Scalar.invert(), Scalar.negate()

power

public BigScalar power(int anExp)

See Also:

Scalar.power(int), Scalar.root(int)

root

public BigScalar root(int anExp)

See Also:

Scalar.power(int), Scalar.root(int)

round

public Scalar<BigDecimal> round(NumberContext aCntxt)

signum

public BigScalar signum()

subtract

public BigScalar subtract(BigDecimal aNmbr)

See Also:

Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

subtract

public Scalar<BigDecimal> subtract(double aNmbr)

See Also:

Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

toBigDecimal

public BigDecimal toBigDecimal()

toComplexNumber

public ComplexNumber toComplexNumber()

toRationalNumber

public RationalNumber toRationalNumber()

toString

public String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object someObj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object