Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyRational

All Superinterfaces:

Comparable<PsyRealNumeric>, PsyAdditive<PsyNumeric>, PsyArithmetic<PsyNumeric>, PsyConvertableToInteger, PsyConvertableToIntegral, PsyConvertableToRational, PsyConvertableToReal, PsyMultiplicative<PsyNumeric>, PsyNumeric, PsyObject, PsyRealNumeric, PsyScalar<PsyRealNumeric>, PsyValue

All Known Subinterfaces:

PsyIntegral

All Known Implementing Classes:

PsyBigFraction, PsyBigInteger, PsyFraction, PsyInteger

@Type("rational")
public sealed interface PsyRational
extends PsyRealNumeric
permits PsyIntegral, PsyFraction, PsyBigFraction

The representation of rational.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_DENOMINATOR	Context action of the denominator operator.
static final ContextAction	PSY_GCD	Context action of the gcd operator.
static final ContextAction	PSY_IDIV	Context action of the idiv operator.
static final ContextAction	PSY_LCM	Context action of the lcm operator.
static final ContextAction	PSY_MOD	Context action of the mod operator.
static final ContextAction	PSY_NUMERATOR	Context action of the numerator operator.

Fields inherited from interface coneforest.psylla.core.PsyAdditive

PSY_ADD, PSY_ISZERO, PSY_NEG, PSY_NONZERO, PSY_SUB

Fields inherited from interface coneforest.psylla.core.PsyConvertableToInteger

PSY_TOINTEGER

Fields inherited from interface coneforest.psylla.core.PsyConvertableToIntegral

PSY_TOINTEGRAL

Fields inherited from interface coneforest.psylla.core.PsyConvertableToRational

PSY_TORATIONAL

Fields inherited from interface coneforest.psylla.core.PsyConvertableToReal

PSY_TOREAL

Fields inherited from interface coneforest.psylla.core.PsyMultiplicative

PSY_DIV, PSY_MUL, PSY_RECIPROCAL

Fields inherited from interface coneforest.psylla.core.PsyNumeric

PSY_ABS, PSY_ACOS, PSY_ASIN, PSY_ATAN, PSY_CBRT, PSY_COS, PSY_COSH, PSY_EXP, PSY_LOG, PSY_POW, PSY_SIGNUM, PSY_SIN, PSY_SINH, PSY_SQRT, PSY_TAN, PSY_TANH

Fields inherited from interface coneforest.psylla.core.PsyObject

PSY_CLONE, PSY_EQ, PSY_HASHCODE, PSY_INSTANCEOF, PSY_NE, PSY_TOSTRING, PSY_TOSTRINGBUFFER, PSY_TYPE

Fields inherited from interface coneforest.psylla.core.PsyRealNumeric

PSY_CEILING, PSY_FLOOR, PSY_HYPOT, PSY_ROUND

Fields inherited from interface coneforest.psylla.core.PsyScalar

PSY_CMP, PSY_GE, PSY_GT, PSY_LE, PSY_LT, PSY_MAX, PSY_MIN

Method Summary

Modifier and Type	Method	Description
BigInteger	bigIntegerValue()
default int	compareTo(PsyRealNumeric oNumeric)	Compares this scalar with the specified scalar for order.
static PsyRational	of(PsyIntegral oNumerator, PsyIntegral oDenominator)
static PsyRational	parseLiteral(String image)
default PsyRational	psyAbs()	Returns the numeric absolute value of this object.
default PsyRealNumeric	psyAdd(PsyRealNumeric oRealNumeric)
PsyIntegral	psyCeiling()
PsyIntegral	psyDenominator()	Returns an integral denominator of this fraction.
default PsyRealNumeric	psyDiv(PsyRealNumeric oRealNumeric)
PsyIntegral	psyFloor()
default PsyRational	psyGCD(PsyRational oRational)	Returns a rational representing the greatest common divisor of this object and given object.
default PsyIntegral	psyIdiv(PsyRational oRational)	Returns the quotient of the integer division of this rational by the rational divisor.
default PsyRational	psyLCM(PsyRational oRational)	Returns a rational representing the least common multiplier of this object and given object.
default PsyRational	psyMod(PsyRational oRational)	Returns an integral representing this object modulo given modulus.
default PsyRealNumeric	psyMul(PsyRealNumeric oRealNumeric)
default PsyRational	psyNeg()	Returns the additive result of arithmetic negation of this object.
PsyIntegral	psyNumerator()	Returns an integral numerator of this fraction.
default PsyRational	psyReciprocal()	Returns the multiplicative inverse of this object.
default PsyIntegral	psyRound()
default PsyRealNumeric	psySub(PsyRealNumeric oRealNumeric)
default PsyIntegral	psyToIntegral()
default PsyRational	psyToRational()
default PsyRational	rationalValue()

Methods inherited from interface coneforest.psylla.core.PsyAdditive

isZero, psyIsZero, psyNonZero

Methods inherited from interface coneforest.psylla.core.PsyNumeric

psySignum

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToString, psyToStringBuffer, psyType, toSyntaxString, typeName

Methods inherited from interface coneforest.psylla.core.PsyRealNumeric

doubleValue, imagValue, intValue, longValue, psyAcos, psyAdd, psyAsin, psyAtan, psyCbrt, psyCos, psyCosh, psyDiv, psyEq, psyExp, psyHypot, psyLog, psyMul, psyPow, psyPow, psySin, psySinh, psySqrt, psySub, psyTan, psyTanh, psyToInteger, psyToReal, realValue

Methods inherited from interface coneforest.psylla.core.PsyScalar

psyCmp, psyGe, psyGt, psyLe, psyLt, psyMax, psyMin

Methods inherited from interface coneforest.psylla.core.PsyValue

psyClone

Field Details

PSY_DENOMINATOR

@OperatorType("denominator")
static final ContextAction PSY_DENOMINATOR

Context action of the denominator operator.

PSY_GCD

@OperatorType("gcd")
static final ContextAction PSY_GCD

Context action of the gcd operator.

PSY_IDIV

@OperatorType("idiv")
static final ContextAction PSY_IDIV

Context action of the idiv operator.

PSY_LCM

@OperatorType("lcm")
static final ContextAction PSY_LCM

Context action of the lcm operator.

PSY_MOD

@OperatorType("mod")
static final ContextAction PSY_MOD

Context action of the mod operator.

PSY_NUMERATOR

@OperatorType("numerator")
static final ContextAction PSY_NUMERATOR

Context action of the numerator operator.

Method Details

bigIntegerValue

BigInteger bigIntegerValue()

rationalValue

default PsyRational rationalValue()

Specified by:

rationalValue in interface PsyRealNumeric

psyNumerator

PsyIntegral psyNumerator()

Returns an integral numerator of this fraction.

Returns:

an integral numerator of this fraction

psyDenominator

PsyIntegral psyDenominator()

Returns an integral denominator of this fraction.

Returns:

an integral denominator of this fraction

psyToRational

default PsyRational psyToRational()

Specified by:

psyToRational in interface PsyConvertableToRational

Specified by:

psyToRational in interface PsyRealNumeric

psyRound

default PsyIntegral psyRound()

Specified by:

psyRound in interface PsyRealNumeric

psyToIntegral

default PsyIntegral psyToIntegral()

Specified by:

psyToIntegral in interface PsyConvertableToIntegral

psyNeg

default PsyRational psyNeg()

Description copied from interface: PsyAdditive

Returns the additive result of arithmetic negation of this object.

Specified by:

psyNeg in interface PsyAdditive<PsyNumeric>

Specified by:

psyNeg in interface PsyRealNumeric

Returns:

the additive result of arithmetic negation of this object

psyAdd

default PsyRealNumeric psyAdd(PsyRealNumeric oRealNumeric)

Specified by:

psyAdd in interface PsyRealNumeric

psySub

default PsyRealNumeric psySub(PsyRealNumeric oRealNumeric)

Specified by:

psySub in interface PsyRealNumeric

psyReciprocal

default PsyRational psyReciprocal()
                           throws PsyUndefinedResultException

Description copied from interface: PsyMultiplicative

Returns the multiplicative inverse of this object.

Specified by:

psyReciprocal in interface PsyMultiplicative<PsyNumeric>

Returns:

the multiplicative inverse of this object

Throws:

PsyUndefinedResultException - if this object is zero.

psyMul

default PsyRealNumeric psyMul(PsyRealNumeric oRealNumeric)

Specified by:

psyMul in interface PsyRealNumeric

psyDiv

default PsyRealNumeric psyDiv(PsyRealNumeric oRealNumeric)
                       throws PsyUndefinedResultException

Specified by:

psyDiv in interface PsyRealNumeric

Throws:

PsyUndefinedResultException

psyMod

default PsyRational psyMod(PsyRational oRational)
                    throws PsyRangeCheckException,
PsyUndefinedResultException

Returns an integral representing this object modulo given modulus.

Parameters:

oRational - the given modulus.

Returns:

an integral representing this object modulo given modulus

Throws:

PsyRangeCheckException - when the modulus is negative.

PsyUndefinedResultException - when the modulus is zero.

psyIdiv

default PsyIntegral psyIdiv(PsyRational oRational)
                     throws PsyUndefinedResultException

Returns the quotient of the integer division of this rational by the rational divisor.

Parameters:

oRational - the divisor.

Returns:

the quotient of the integer division of this rational by the rational divisor

Throws:

PsyUndefinedResultException - when the divisor is zero.

psyGCD

default PsyRational psyGCD(PsyRational oRational)

Returns a rational representing the greatest common divisor of this object and given object.

Parameters:

oRational - the given object.

Returns:

a rational representing the greatest common divisor of this object and given object

psyLCM

default PsyRational psyLCM(PsyRational oRational)

Returns a rational representing the least common multiplier of this object and given object.

Parameters:

oRational - the given object.

Returns:

a rational representing the least common multiplier of this object and given object

psyCeiling

PsyIntegral psyCeiling()

Specified by:

psyCeiling in interface PsyRealNumeric

psyAbs

default PsyRational psyAbs()

Description copied from interface: PsyNumeric

Returns the numeric absolute value of this object.

Specified by:

psyAbs in interface PsyNumeric

Specified by:

psyAbs in interface PsyRealNumeric

Returns:

the numeric absolute value of this object

psyFloor

PsyIntegral psyFloor()

Specified by:

psyFloor in interface PsyRealNumeric

of

static PsyRational of(PsyIntegral oNumerator,
 PsyIntegral oDenominator)

compareTo

default int compareTo(PsyRealNumeric oNumeric)

Description copied from interface: PsyScalar

Compares this scalar with the specified scalar for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified scalar.

Specified by:

compareTo in interface Comparable<PsyRealNumeric>

Specified by:

compareTo in interface PsyRealNumeric

Specified by:

compareTo in interface PsyScalar<PsyRealNumeric>

Parameters:

oNumeric - the scalar to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified.

parseLiteral

static PsyRational parseLiteral(String image)
                         throws PsySyntaxErrorException,
PsyUndefinedResultException

Throws:

PsySyntaxErrorException

PsyUndefinedResultException