org.ojalgo.scalar

Class RationalNumber

java.lang.Object

java.lang.Number

org.ojalgo.scalar.RationalNumber

All Implemented Interfaces:

Serializable, Comparable<RationalNumber>, Field<Scalar<RationalNumber>>, Group, Group.Additive<Scalar<RationalNumber>>, Group.Multiplicative<Scalar<RationalNumber>>, NormedVectorSpace<Scalar<RationalNumber>,RationalNumber>, Operation, Operation.Addition<Scalar<RationalNumber>>, Operation.Division<Scalar<RationalNumber>>, Operation.Multiplication<Scalar<RationalNumber>>, Operation.Subtraction<Scalar<RationalNumber>>, Ring<Scalar<RationalNumber>>, ScalarOperation, ScalarOperation.Addition<Scalar<RationalNumber>,RationalNumber>, ScalarOperation.Division<Scalar<RationalNumber>,RationalNumber>, ScalarOperation.Multiplication<Scalar<RationalNumber>,RationalNumber>, ScalarOperation.Subtraction<Scalar<RationalNumber>,RationalNumber>, VectorSpace<Scalar<RationalNumber>,RationalNumber>, Scalar<RationalNumber>, AccessScalar<RationalNumber>, NumberContext.Enforceable<RationalNumber>

public final class RationalNumber
extends Number
implements Scalar<RationalNumber>, NumberContext.Enforceable<RationalNumber>

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<RationalNumber>	FACTORY
static RationalNumber	MAX_VALUE
static RationalNumber	MIN_VALUE
static RationalNumber	NaN
static RationalNumber	NEG
static RationalNumber	NEGATIVE_INFINITY
static RationalNumber	ONE
static RationalNumber	POSITIVE_INFINITY
static RationalNumber	TWO
static RationalNumber	ZERO

Constructor Summary

Constructors

Constructor and Description
RationalNumber()

Method Summary

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

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<RationalNumber> FACTORY

MAX_VALUE

public static final RationalNumber MAX_VALUE

MIN_VALUE

public static final RationalNumber MIN_VALUE

NaN

public static final RationalNumber NaN

NEG

public static final RationalNumber NEG

NEGATIVE_INFINITY

public static final RationalNumber NEGATIVE_INFINITY

ONE

public static final RationalNumber ONE

POSITIVE_INFINITY

public static final RationalNumber POSITIVE_INFINITY

TWO

public static final RationalNumber TWO

ZERO

public static final RationalNumber ZERO

Constructor Detail

RationalNumber

public RationalNumber()

Method Detail

isAbsolute

public static boolean isAbsolute(RationalNumber value)

isInfinite

public static boolean isInfinite(RationalNumber value)

isNaN

public static boolean isNaN(RationalNumber value)

isSmall

public static boolean isSmall(double comparedTo,
                              RationalNumber value)

of

public static RationalNumber of(long numerator,
                                long denominator)

rational

public static RationalNumber rational(double d)

valueOf

public static RationalNumber valueOf(double value)

valueOf

public static RationalNumber valueOf(long value)

valueOf

public static RationalNumber valueOf(Number number)

add

public RationalNumber add(double arg)

Specified by:

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

Returns:

this + scalarAddend.

add

public RationalNumber add(RationalNumber arg)

Specified by:

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

Returns:

this + scalarAddend.

compareTo

public int compareTo(RationalNumber reference)

Specified by:

compareTo in interface Comparable<RationalNumber>

conjugate

public RationalNumber 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<RationalNumber>,RationalNumber>

divide

public RationalNumber divide(double arg)

Specified by:

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

Returns:

this / scalarDivisor.

divide

public RationalNumber divide(RationalNumber arg)

Specified by:

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

Returns:

this / scalarDivisor.

doubleValue

public double doubleValue()

Specified by:

doubleValue in interface AccessScalar<RationalNumber>

Specified by:

doubleValue in class Number

See Also:

Number.doubleValue()

enforce

public RationalNumber enforce(NumberContext context)

Specified by:

enforce in interface NumberContext.Enforceable<RationalNumber>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

floatValue

public float floatValue()

Specified by:

floatValue in interface AccessScalar<RationalNumber>

Specified by:

floatValue in class Number

See Also:

Number.floatValue()

get

public RationalNumber get()

Specified by:

get in interface AccessScalar<RationalNumber>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

intValue

public int intValue()

Specified by:

intValue in interface AccessScalar<RationalNumber>

Specified by:

intValue in class Number

See Also:

Number.intValue()

invert

public RationalNumber invert()

Description copied from interface: Group.Multiplicative

The multiplicative inverse.

Specified by:

invert in interface Group.Multiplicative<Scalar<RationalNumber>>

Returns:

IDENTITY / this.

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface Scalar<RationalNumber>

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<RationalNumber>,RationalNumber>

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 interface AccessScalar<RationalNumber>

Specified by:

longValue in class Number

See Also:

Number.longValue()

multiply

public RationalNumber multiply(double arg)

Specified by:

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

Returns:

this * scalarMultiplicand.

multiply

public RationalNumber multiply(RationalNumber arg)

Specified by:

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

Returns:

this * multiplicand.

negate

public RationalNumber negate()

Description copied from interface: Group.Additive

The additive inverse of this.

Specified by:

negate in interface Group.Additive<Scalar<RationalNumber>>

Returns:

-this.

norm

public double norm()

Description copied from interface: NormedVectorSpace

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

Specified by:

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

Returns:

The norm

signum

public RationalNumber signum()

Description copied from interface: NormedVectorSpace

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

Specified by:

signum in interface NormedVectorSpace<Scalar<RationalNumber>,RationalNumber>

Returns:

A unit "vector"

subtract

public RationalNumber subtract(double arg)

Specified by:

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

Returns:

this - scalarSubtrahend.

subtract

public RationalNumber subtract(RationalNumber arg)

Specified by:

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

Returns:

this - scalarSubtrahend.

toBigDecimal

public BigDecimal toBigDecimal()

Specified by:

toBigDecimal in interface Scalar<RationalNumber>

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(NumberContext context)

Specified by:

toString in interface Scalar<RationalNumber>