Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyIntegral

All Superinterfaces:

Comparable<PsyRealNumeric>, PsyAdditive<PsyNumeric>, PsyArithmetic<PsyNumeric>, PsyAtomic, PsyBitwise<PsyIntegral>, PsyConvertableToInteger, PsyConvertableToIntegral, PsyConvertableToRational, PsyConvertableToReal, PsyLogical<PsyIntegral>, PsyMultiplicative<PsyNumeric>, PsyNumeric, PsyObject, PsyRational, PsyRealNumeric, PsyScalar<PsyRealNumeric>

All Known Implementing Classes:

PsyBigInteger, PsyInteger

@Type("integral")
public sealed interface PsyIntegral
extends PsyBitwise<PsyIntegral>, PsyRational
permits PsyBigInteger, PsyInteger

The representation of integral.

Field Summary

Fields

Modifier and Type	Field	Description
static final PsyInteger	MINUS_ONE
static final PsyInteger	ONE
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 PsyInteger	TWO
static final PsyInteger	ZERO

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.PsyBitwise

PSY_BITSHIFT, PSY_CLEARBIT, PSY_FLIPBIT, PSY_SETBIT, PSY_TESTBIT

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.PsyLogical

PSY_AND, PSY_NOT, PSY_OR, PSY_XOR

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_TONAME, PSY_TOSTRING, PSY_TYPE

Fields inherited from interface coneforest.psylla.core.PsyRational

PSY_DENOMINATOR, PSY_NUMERATOR

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
static PsyInteger	of(long longValue)
static PsyIntegral	of(BigInteger bigIntegerValue)
static PsyIntegral	parseLiteral(String image)
PsyIntegral	psyAbs()	Returns the numeric absolute value of this object.
default PsyIntegral	psyCeiling()
default PsyIntegral	psyDenominator()	Returns an integral denominator of this fraction.
default PsyIntegral	psyFloor()
default PsyIntegral	psyGCD(PsyIntegral oIntegral)	Returns an integral representing the greatest common divisor of this object and given object.
PsyIntegral	psyIdiv(PsyIntegral oIntegral)
default PsyIntegral	psyLCM(PsyIntegral oIntegral)	Returns an integral representing the least common multiple of this object and given object.
PsyIntegral	psyMod(PsyIntegral oIntegral)	Returns an integral representing this object modulo given modulus.
PsyIntegral	psyNeg()	Returns the additive result of arithmetic negation of this object.
default PsyIntegral	psyNumerator()	Returns an integral numerator of this fraction.
default PsyIntegral	psyRound()
default PsyIntegral	psyToIntegral()

Methods inherited from interface coneforest.psylla.core.PsyAdditive

psyIsZero, psyNonZero

Methods inherited from interface coneforest.psylla.core.PsyBitwise

psyBitShift, psyClearBit, psyFlipBit, psySetBit, psyTestBit

Methods inherited from interface coneforest.psylla.core.PsyLogical

psyAnd, psyNot, psyOr, psyXor

Methods inherited from interface coneforest.psylla.core.PsyNumeric

psySignum

Methods inherited from interface coneforest.psylla.core.PsyObject

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

Methods inherited from interface coneforest.psylla.core.PsyRational

bigIntegerValue, compareTo, psyAdd, psyDiv, psyMul, psyReciprocal, psySub, psyToRational, rationalValue

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

Field Details

ZERO

static final PsyInteger ZERO

ONE

static final PsyInteger ONE

TWO

static final PsyInteger TWO

MINUS_ONE

static final PsyInteger MINUS_ONE

PSY_IDIV

@OperatorType("idiv")
static final ContextAction PSY_IDIV

Context action of the idiv operator.

PSY_MOD

@OperatorType("mod")
static final ContextAction PSY_MOD

Context action of the mod operator.

PSY_GCD

@OperatorType("gcd")
static final ContextAction PSY_GCD

Context action of the gcd operator.

PSY_LCM

@OperatorType("lcm")
static final ContextAction PSY_LCM

Context action of the lcm operator.

Method Details

psyNumerator

default PsyIntegral psyNumerator()

Description copied from interface: PsyRational

Returns an integral numerator of this fraction.

Specified by:

psyNumerator in interface PsyRational

Returns:

the numerator.

psyDenominator

default PsyIntegral psyDenominator()

Description copied from interface: PsyRational

Returns an integral denominator of this fraction.

Specified by:

psyDenominator in interface PsyRational

Returns:

the denominator.

psyAbs

PsyIntegral 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 PsyRational

Specified by:

psyAbs in interface PsyRealNumeric

Returns:

the numeric absolute value.

psyNeg

PsyIntegral 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 PsyRational

Specified by:

psyNeg in interface PsyRealNumeric

Returns:

the additive result of arithmetic negation.

psyFloor

default PsyIntegral psyFloor()

Specified by:

psyFloor in interface PsyRational

Specified by:

psyFloor in interface PsyRealNumeric

psyCeiling

default PsyIntegral psyCeiling()

Specified by:

psyCeiling in interface PsyRational

Specified by:

psyCeiling in interface PsyRealNumeric

psyRound

default PsyIntegral psyRound()

Specified by:

psyRound in interface PsyRealNumeric

psyIdiv

PsyIntegral psyIdiv(PsyIntegral oIntegral)
             throws PsyUndefinedResultException

Throws:

PsyUndefinedResultException

psyMod

PsyIntegral psyMod(PsyIntegral oIntegral)
            throws PsyRangeCheckException,
PsyUndefinedResultException

Returns an integral representing this object modulo given modulus.

Parameters:

oIntegral - the given modulus.

Throws:

PsyRangeCheckException - when the modulus is negative.

PsyUndefinedResultException - when the modulus is zero.

psyGCD

default PsyIntegral psyGCD(PsyIntegral oIntegral)

Returns an integral representing the greatest common divisor of this object and given object.

Parameters:

oIntegral - the given object.

Returns:

the greatest common divisor.

psyLCM

default PsyIntegral psyLCM(PsyIntegral oIntegral)
                    throws PsyUndefinedResultException

Returns an integral representing the least common multiple of this object and given object.

Parameters:

oIntegral - given object.

Returns:

the least common multiple.

Throws:

PsyUndefinedResultException

psyToIntegral

default PsyIntegral psyToIntegral()

Specified by:

psyToIntegral in interface PsyConvertableToIntegral

of

static PsyInteger of(long longValue)

of

static PsyIntegral of(BigInteger bigIntegerValue)

parseLiteral

static PsyIntegral parseLiteral(String image)
                         throws PsySyntaxErrorException

Throws:

PsySyntaxErrorException