org.ojalgo.scalar
Class RationalScalar

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

All Implemented Interfaces:

Serializable, Comparable<RationalScalar>, Scalar<RationalScalar>

public final class RationalScalar
extends Number
implements Scalar<RationalScalar>

See Also:

Serialized Form

Field Summary

static RationalScalar	INFINITY
static RationalScalar	NaN
static RationalScalar	ONE
static RationalScalar	ZERO

Constructor Summary

RationalScalar()

RationalScalar(BigDecimal aNmbr)

RationalScalar(BigInteger aNumerator, BigInteger aDenominator)

RationalScalar(double aNmbr)

RationalScalar(long aNumerator, long aDenominator)

RationalScalar(Number aNmbr)

RationalScalar(String aNmbrStr)

Method Summary

RationalScalar	add(RationalScalar aNmbr)
RationalScalar	add(Scalar<RationalScalar> aSclr)
int	compareTo(RationalScalar aNmbr)
RationalScalar	conjugate()
RationalScalar	divide(RationalScalar aNmbr)
RationalScalar	divide(Scalar<RationalScalar> aSclr)
RationalScalar	dot(Scalar<RationalScalar> aSclr1, Scalar<RationalScalar> aSclr2)
double	doubleValue()
RationalScalar	enforce(NumberContext aCntxt)
boolean	equals(Object anObject)
float	floatValue()
double	getArgument()
double	getImaginary()
double	getModulus()
RationalScalar	getNumber()
double	getReal()
int	hashCode()
int	intValue()
RationalScalar	invert()
boolean	isReal()
boolean	isZero()
long	longValue()
RationalScalar	multiply(RationalScalar aNmbr)
RationalScalar	multiply(Scalar<RationalScalar> aSclr)
RationalScalar	negate()
RationalScalar	power(int anExp)
RationalScalar	root(int anExp)
RationalScalar	subtract(RationalScalar aNmbr)
RationalScalar	subtract(Scalar<RationalScalar> aSclr)
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

INFINITY

public static final RationalScalar INFINITY

NaN

public static final RationalScalar NaN

ONE

public static final RationalScalar ONE

ZERO

public static final RationalScalar ZERO

Constructor Detail

RationalScalar

public RationalScalar()

RationalScalar

public RationalScalar(BigDecimal aNmbr)

RationalScalar

public RationalScalar(BigInteger aNumerator,
                      BigInteger aDenominator)

RationalScalar

public RationalScalar(double aNmbr)

RationalScalar

public RationalScalar(long aNumerator,
                      long aDenominator)

RationalScalar

public RationalScalar(Number aNmbr)

RationalScalar

public RationalScalar(String aNmbrStr)

Method Detail

add

public RationalScalar add(RationalScalar aNmbr)

Specified by:

add in interface Scalar<RationalScalar>

See Also:

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

add

public RationalScalar add(Scalar<RationalScalar> aSclr)

Specified by:

add in interface Scalar<RationalScalar>

See Also:

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

compareTo

public int compareTo(RationalScalar aNmbr)

Specified by:

compareTo in interface Comparable<RationalScalar>

conjugate

public RationalScalar conjugate()

Specified by:

conjugate in interface Scalar<RationalScalar>

See Also:

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

divide

public RationalScalar divide(RationalScalar aNmbr)

Specified by:

divide in interface Scalar<RationalScalar>

See Also:

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

divide

public RationalScalar divide(Scalar<RationalScalar> aSclr)

Specified by:

divide in interface Scalar<RationalScalar>

See Also:

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

dot

public RationalScalar dot(Scalar<RationalScalar> aSclr1,
                          Scalar<RationalScalar> aSclr2)

Specified by:

dot in interface Scalar<RationalScalar>

Returns:

this + (aSclr1 * aSclr2)

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

enforce

public RationalScalar enforce(NumberContext aCntxt)

Specified by:

enforce in interface Scalar<RationalScalar>

equals

public boolean equals(Object anObject)

Overrides:

equals in class Object

floatValue

public float floatValue()

Specified by:

floatValue in class Number

getArgument

public double getArgument()

Specified by:

getArgument in interface Scalar<RationalScalar>

See Also:

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

getImaginary

public double getImaginary()

Specified by:

getImaginary in interface Scalar<RationalScalar>

See Also:

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

getModulus

public double getModulus()

Specified by:

getModulus in interface Scalar<RationalScalar>

See Also:

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

getNumber

public RationalScalar getNumber()

Specified by:

getNumber in interface Scalar<RationalScalar>

getReal

public double getReal()

Specified by:

getReal in interface Scalar<RationalScalar>

See Also:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

intValue

public int intValue()

Specified by:

intValue in class Number

invert

public RationalScalar invert()

Specified by:

invert in interface Scalar<RationalScalar>

See Also:

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

isReal

public boolean isReal()

Specified by:

isReal in interface Scalar<RationalScalar>

Returns:

true if the imaginary part is less than or equal to PrimitiveMath.IS_ZERO; otherwise false.

isZero

public boolean isZero()

Specified by:

isZero in interface Scalar<RationalScalar>

Returns:

true if the modulus is less than or equal to PrimitiveMath.IS_ZERO; otherwise false.

longValue

public long longValue()

Specified by:

longValue in class Number

multiply

public RationalScalar multiply(RationalScalar aNmbr)

Specified by:

multiply in interface Scalar<RationalScalar>

See Also:

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

multiply

public RationalScalar multiply(Scalar<RationalScalar> aSclr)

Specified by:

multiply in interface Scalar<RationalScalar>

See Also:

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

negate

public RationalScalar negate()

Specified by:

negate in interface Scalar<RationalScalar>

See Also:

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

power

public RationalScalar power(int anExp)

Specified by:

power in interface Scalar<RationalScalar>

See Also:

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

root

public RationalScalar root(int anExp)

Specified by:

root in interface Scalar<RationalScalar>

See Also:

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

subtract

public RationalScalar subtract(RationalScalar aNmbr)

Specified by:

subtract in interface Scalar<RationalScalar>

See Also:

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

subtract

public RationalScalar subtract(Scalar<RationalScalar> aSclr)

Specified by:

subtract in interface Scalar<RationalScalar>

See Also:

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

toString

public String toString()

Overrides:

toString in class Object