Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyRealNumeric

All Superinterfaces:

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

All Known Subinterfaces:

PsyIntegral, PsyRational

All Known Implementing Classes:

PsyBigFraction, PsyBigInteger, PsyFraction, PsyInteger, PsyReal

@Type("realnumeric")
public sealed interface PsyRealNumeric
extends PsyNumeric, PsyConvertableToInteger, PsyConvertableToIntegral, PsyConvertableToRational, PsyConvertableToReal, PsyScalar<PsyRealNumeric>
permits PsyRational, PsyReal

The representation of realnumeric, an abstraction of real number.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_CEILING	Context action of the ceiling operator.
static final ContextAction	PSY_FLOOR	Context action of the floor operator.
static final ContextAction	PSY_HYPOT	Context action of the hypot operator.
static final ContextAction	PSY_ROUND	Context action of the round 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.PsyScalar

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

Method Summary

Modifier and Type	Method	Description
int	compareTo(PsyRealNumeric oRealNumeric)	Compares this scalar with the specified scalar for order.
double	doubleValue()
default double	imagValue()	Returns the imaginary part of this object.
int	intValue()
long	longValue()
PsyRealNumeric	psyAbs()	Returns the numeric absolute value of this object.
default PsyReal	psyAcos()	Returns the numeric arc cosine of this object.
default PsyNumeric	psyAdd(PsyNumeric oNumeric)	Returns the additive result of arithmetic addition of specified object to this object.
PsyRealNumeric	psyAdd(PsyRealNumeric oRealNumeric)
default PsyReal	psyAsin()	Returns the numeric arc sine of this object.
default PsyReal	psyAtan()	Returns the numeric arc tangent of this object.
default PsyReal	psyCbrt()	Returns the numeric cubic root of this object.
PsyRealNumeric	psyCeiling()
default PsyReal	psyCos()	Returns the numeric cosine of this object.
default PsyReal	psyCosh()	Returns the numeric hyperbolic cosine of this object.
default PsyNumeric	psyDiv(PsyNumeric oNumeric)	Returns a result of arithmetic division of this object by given object.
PsyRealNumeric	psyDiv(PsyRealNumeric oRealNumeric)
default PsyBoolean	psyEq(PsyObject o)	Returns a boolean result of equality test of this object and given object.
default PsyReal	psyExp()	Returns the numeric exponent of this object.
PsyRealNumeric	psyFloor()
default PsyReal	psyHypot(PsyRealNumeric oRealNumeric)
default PsyReal	psyLog()	Returns the numeric natural logarithm of this object.
default PsyNumeric	psyMul(PsyNumeric oNumeric)	Returns a result of arithmetic multiplication of this number by given object.
PsyRealNumeric	psyMul(PsyRealNumeric oRealNumeric)
PsyRealNumeric	psyNeg()	Returns the additive result of arithmetic negation of this object.
default PsyNumeric	psyPow(PsyNumeric oNumeric)
default PsyReal	psyPow(PsyRealNumeric oNumber)
PsyRealNumeric	psyRound()
default PsyReal	psySin()	Returns the numeric sine of this object.
default PsyReal	psySinh()	Returns the numeric hyperbolic sine of this object.
default PsyReal	psySqrt()	Returns the numeric square root of this object.
default PsyNumeric	psySub(PsyNumeric oNumeric)	Returns the additive result of arithmetic subtraction of specified object from this object.
PsyRealNumeric	psySub(PsyRealNumeric oRealNumeric)
default PsyReal	psyTan()	Returns the numeric tangent of this object.
default PsyReal	psyTanh()	Returns the numeric hyperbolic tangent of this object.
default PsyInteger	psyToInteger()
default PsyRational	psyToRational()
default PsyReal	psyToReal()
PsyRational	rationalValue()
default double	realValue()	Returns the real part of this object.

Methods inherited from interface coneforest.psylla.core.PsyAdditive

isZero, psyIsZero, psyNonZero

Methods inherited from interface coneforest.psylla.core.PsyConvertableToIntegral

psyToIntegral

Methods inherited from interface coneforest.psylla.core.PsyMultiplicative

psyReciprocal

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

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

Methods inherited from interface coneforest.psylla.core.PsyValue

psyClone

Field Details

PSY_CEILING

@OperatorType("ceiling")
static final ContextAction PSY_CEILING

Context action of the ceiling operator.

PSY_FLOOR

@OperatorType("floor")
static final ContextAction PSY_FLOOR

Context action of the floor operator.

PSY_HYPOT

@OperatorType("hypot")
static final ContextAction PSY_HYPOT

Context action of the hypot operator.

PSY_ROUND

@OperatorType("round")
static final ContextAction PSY_ROUND

Context action of the round operator.

Method Details

intValue

int intValue()

longValue

long longValue()

doubleValue

double doubleValue()

rationalValue

PsyRational rationalValue()
                   throws PsyUndefinedResultException

Throws:

PsyUndefinedResultException

psyToRational

default PsyRational psyToRational()
                           throws PsyUndefinedResultException

Specified by:

psyToRational in interface PsyConvertableToRational

Throws:

PsyUndefinedResultException

realValue

default double realValue()

Description copied from interface: PsyNumeric

Returns the real part of this object.

Specified by:

realValue in interface PsyNumeric

Returns:

the real part of this object

imagValue

default double imagValue()

Description copied from interface: PsyNumeric

Returns the imaginary part of this object.

Specified by:

imagValue in interface PsyNumeric

Returns:

the imaginary part of this object

psyToInteger

default PsyInteger psyToInteger()
                         throws PsyRangeCheckException

Specified by:

psyToInteger in interface PsyConvertableToInteger

Throws:

PsyRangeCheckException

psyToReal

default PsyReal psyToReal()

Specified by:

psyToReal in interface PsyConvertableToReal

psyNeg

PsyRealNumeric psyNeg()

Description copied from interface: PsyAdditive

Returns the additive result of arithmetic negation of this object.

Specified by:

psyNeg in interface PsyAdditive<PsyNumeric>

Returns:

the additive result of arithmetic negation of this object

psyAdd

PsyRealNumeric psyAdd(PsyRealNumeric oRealNumeric)

psyAdd

default PsyNumeric psyAdd(PsyNumeric oNumeric)

Description copied from interface: PsyAdditive

Returns the additive result of arithmetic addition of specified object to this object.

Specified by:

psyAdd in interface PsyAdditive<PsyNumeric>

Parameters:

oNumeric - the specified object.

Returns:

the additive result of arithmetic addition of specified object to this object

psySub

PsyRealNumeric psySub(PsyRealNumeric oRealNumeric)

psySub

default PsyNumeric psySub(PsyNumeric oNumeric)

Description copied from interface: PsyAdditive

Returns the additive result of arithmetic subtraction of specified object from this object.

Specified by:

psySub in interface PsyAdditive<PsyNumeric>

Parameters:

oNumeric - the specified object.

Returns:

the additive result of arithmetic subtraction of specified object from this object

psyMul

PsyRealNumeric psyMul(PsyRealNumeric oRealNumeric)

psyMul

default PsyNumeric psyMul(PsyNumeric oNumeric)

Description copied from interface: PsyMultiplicative

Returns a result of arithmetic multiplication of this number by given object.

Specified by:

psyMul in interface PsyMultiplicative<PsyNumeric>

Parameters:

oNumeric - a given number.

Returns:

a result of arithmetic multiplication of this number by given object

psyDiv

PsyRealNumeric psyDiv(PsyRealNumeric oRealNumeric)
               throws PsyUndefinedResultException

Throws:

PsyUndefinedResultException

psyDiv

default PsyNumeric psyDiv(PsyNumeric oNumeric)
                   throws PsyUndefinedResultException

Description copied from interface: PsyMultiplicative

Returns a result of arithmetic division of this object by given object.

Specified by:

psyDiv in interface PsyMultiplicative<PsyNumeric>

Parameters:

oNumeric - a given object.

Returns:

a result of arithmetic division of this object by given object

Throws:

PsyUndefinedResultException - when the result of division is not defined.

psyPow

default PsyReal psyPow(PsyRealNumeric oNumber)

psyPow

default PsyNumeric psyPow(PsyNumeric oNumeric)

Specified by:

psyPow in interface PsyNumeric

psyAbs

PsyRealNumeric psyAbs()

Description copied from interface: PsyNumeric

Returns the numeric absolute value of this object.

Specified by:

psyAbs in interface PsyNumeric

Returns:

the numeric absolute value of this object

psySqrt

default PsyReal psySqrt()

Description copied from interface: PsyNumeric

Returns the numeric square root of this object.

Specified by:

psySqrt in interface PsyNumeric

Returns:

the numeric square root of this object

psyCbrt

default PsyReal psyCbrt()

Description copied from interface: PsyNumeric

Returns the numeric cubic root of this object.

Specified by:

psyCbrt in interface PsyNumeric

Returns:

the numeric cubic root of this object

psyExp

default PsyReal psyExp()

Description copied from interface: PsyNumeric

Returns the numeric exponent of this object.

Specified by:

psyExp in interface PsyNumeric

Returns:

the numeric exponent of this object

psyLog

default PsyReal psyLog()

Description copied from interface: PsyNumeric

Returns the numeric natural logarithm of this object.

Specified by:

psyLog in interface PsyNumeric

Returns:

the numeric natural logarithm of this object

psyCos

default PsyReal psyCos()

Description copied from interface: PsyNumeric

Returns the numeric cosine of this object.

Specified by:

psyCos in interface PsyNumeric

Returns:

the numeric cosine of this object

psySin

default PsyReal psySin()

Description copied from interface: PsyNumeric

Returns the numeric sine of this object.

Specified by:

psySin in interface PsyNumeric

Returns:

the numeric sine of this object

psyTan

default PsyReal psyTan()

Description copied from interface: PsyNumeric

Returns the numeric tangent of this object.

Specified by:

psyTan in interface PsyNumeric

Returns:

the numeric tangent of this object

psyCosh

default PsyReal psyCosh()

Description copied from interface: PsyNumeric

Returns the numeric hyperbolic cosine of this object.

Specified by:

psyCosh in interface PsyNumeric

Returns:

the numeric hyperbolic cosine of this object

psySinh

default PsyReal psySinh()

Description copied from interface: PsyNumeric

Returns the numeric hyperbolic sine of this object.

Specified by:

psySinh in interface PsyNumeric

Returns:

the numeric hyperbolic sine of this object

psyTanh

default PsyReal psyTanh()

Description copied from interface: PsyNumeric

Returns the numeric hyperbolic tangent of this object.

Specified by:

psyTanh in interface PsyNumeric

Returns:

the numeric hyperbolic tangent of this object

psyAcos

default PsyReal psyAcos()

Description copied from interface: PsyNumeric

Returns the numeric arc cosine of this object.

Specified by:

psyAcos in interface PsyNumeric

Returns:

the numeric arc cosine of this object

psyAsin

default PsyReal psyAsin()

Description copied from interface: PsyNumeric

Returns the numeric arc sine of this object.

Specified by:

psyAsin in interface PsyNumeric

Returns:

the numeric arc sine of this object

psyAtan

default PsyReal psyAtan()

Description copied from interface: PsyNumeric

Returns the numeric arc tangent of this object.

Specified by:

psyAtan in interface PsyNumeric

Returns:

the numeric arc tangent of this object

psyHypot

default PsyReal psyHypot(PsyRealNumeric oRealNumeric)

psyFloor

PsyRealNumeric psyFloor()

psyCeiling

PsyRealNumeric psyCeiling()

psyRound

PsyRealNumeric psyRound()

psyEq

default PsyBoolean psyEq(PsyObject o)

Description copied from interface: PsyObject

Returns a boolean result of equality test of this object and given object.

Specified by:

psyEq in interface PsyObject

Parameters:

o - the object to be compared for equality.

Returns:

a boolean result of equality test of this object and given object

compareTo

int compareTo(PsyRealNumeric oRealNumeric)

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 PsyScalar<PsyRealNumeric>

Parameters:

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