Module coneforest.psylla

Package coneforest.psylla.core

Class PsyBigInteger

java.lang.Object

coneforest.psylla.core.PsyBigInteger

All Implemented Interfaces:

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

@Type("biginteger")
public final class PsyBigInteger
extends Object
implements PsyIntegral

The representation of biginteger, arbitrary precision integer.

Field Summary

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_TOSTRING, PSY_TOSTRINGBUFFER, PSY_TYPE

Fields inherited from interface coneforest.psylla.core.PsyRational

PSY_DENOMINATOR, PSY_GCD, PSY_IDIV, PSY_LCM, PSY_MOD, 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

Constructor Summary

Constructors

Constructor	Description
PsyBigInteger(BigInteger value)	Constructs a new biginteger for the given value.

Method Summary

Modifier and Type	Method	Description
BigInteger	bigIntegerValue()
int	compareTo(PsyRealNumeric oRealNumeric)	Compares this scalar with the specified scalar for order.
double	doubleValue()
boolean	equals(Object obj)
int	hashCode()
int	intValue()
boolean	isZero()
long	longValue()
PsyIntegral	psyAbs()	Returns the numeric absolute value of this object.
PsyRealNumeric	psyAdd(PsyRealNumeric oRealNumeric)
PsyIntegral	psyAnd(PsyIntegral oIntegral)	Returns a result of logical conjunction of this object and given object.
PsyBigInteger	psyBitShift(PsyInteger oShift)	Returns a bitwise whose value is equivalent to this value with bits shifted at the given distance.
PsyIntegral	psyClearBit(PsyInteger oBit)	Returns a bitwise whose value is equivalent to this value with the designated bit cleared.
PsyRealNumeric	psyDiv(PsyRealNumeric oRealNumeric)
PsyIntegral	psyFlipBit(PsyInteger oBit)	Returns a bitwise whose value is equivalent to this value with the designated bit flipped.
PsyRational	psyGCD(PsyRational oRational)	Returns a rational representing the greatest common divisor of this object and given object.
PsyIntegral	psyIdiv(PsyRational oRational)	Returns the quotient of the integer division of this rational by the rational divisor.
PsyIntegral	psyMod(PsyRational oRational)	Returns an integral representing this object modulo given modulus.
PsyRealNumeric	psyMul(PsyRealNumeric oRealNumeric)
PsyIntegral	psyNeg()	Returns the additive result of arithmetic negation of this object.
PsyBigInteger	psyNot()	Returns a result of logical negation of this object.
PsyIntegral	psyOr(PsyIntegral oIntegral)	Returns a result of logical disjunction of this object and given object.
PsyIntegral	psySetBit(PsyInteger oBit)	Returns a bitwise whose value is equivalent to this value with the designated bit set.
PsyInteger	psySignum()	Returns the numeric signum of this object.
PsyRealNumeric	psySub(PsyRealNumeric oRealNumeric)
PsyBoolean	psyTestBit(PsyInteger oBit)	Returns a boolean indicating if the designated bit is set.
PsyIntegral	psyXor(PsyIntegral oIntegral)	Returns a result of logical exclusive disjunction of this object and given object.
String	toSyntaxString()	Returns the syntactic representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface coneforest.psylla.core.PsyAdditive

psyIsZero, psyNonZero

Methods inherited from interface coneforest.psylla.core.PsyIntegral

psyCeiling, psyDenominator, psyFloor, psyLCM, psyNumerator, psyRound, psyToIntegral

Methods inherited from interface coneforest.psylla.core.PsyObject

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

Methods inherited from interface coneforest.psylla.core.PsyRational

psyLCM, psyReciprocal, psyToRational, rationalValue

Methods inherited from interface coneforest.psylla.core.PsyRealNumeric

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

Constructor Details

PsyBigInteger

public PsyBigInteger(BigInteger value)

Constructs a new biginteger for the given value.

Parameters:

value - the value.

Method Details

isZero

public boolean isZero()

Specified by:

isZero in interface PsyAdditive<PsyNumeric>

intValue

public int intValue()

Specified by:

intValue in interface PsyRealNumeric

longValue

public long longValue()

Specified by:

longValue in interface PsyRealNumeric

doubleValue

public double doubleValue()

Specified by:

doubleValue in interface PsyRealNumeric

bigIntegerValue

public BigInteger bigIntegerValue()

Specified by:

bigIntegerValue in interface PsyRational

psyBitShift

public PsyBigInteger psyBitShift(PsyInteger oShift)

Description copied from interface: PsyBitwise

Returns a bitwise whose value is equivalent to this value with bits shifted at the given distance. If the distance is negative, the left shift is preformed. If the distance is positive, the right shift is preformed. If the distance is zero, returns this.

Specified by:

psyBitShift in interface PsyBitwise<PsyIntegral>

Parameters:

oShift - the shift distance.

Returns:

a bitwise whose value is equivalent to this value with bits shifted at the given distance

psyTestBit

public PsyBoolean psyTestBit(PsyInteger oBit)

Description copied from interface: PsyBitwise

Returns a boolean indicating if the designated bit is set.

Specified by:

psyTestBit in interface PsyBitwise<PsyIntegral>

Parameters:

oBit - the index of bit to test.

Returns:

a boolean indicating if the designated bit is set

psySetBit

public PsyIntegral psySetBit(PsyInteger oBit)

Description copied from interface: PsyBitwise

Returns a bitwise whose value is equivalent to this value with the designated bit set.

Specified by:

psySetBit in interface PsyBitwise<PsyIntegral>

Parameters:

oBit - the index of bit to set.

Returns:

a bitwise whose value is equivalent to this value with the designated bit set

psyFlipBit

public PsyIntegral psyFlipBit(PsyInteger oBit)
                       throws PsyRangeCheckException

Description copied from interface: PsyBitwise

Returns a bitwise whose value is equivalent to this value with the designated bit flipped.

Specified by:

psyFlipBit in interface PsyBitwise<PsyIntegral>

Parameters:

oBit - the index of bit to flip.

Returns:

a bitwise whose value is equivalent to this value with the designated bit flipped

Throws:

PsyRangeCheckException - if the index is out of range.

psyClearBit

public PsyIntegral psyClearBit(PsyInteger oBit)

Description copied from interface: PsyBitwise

Returns a bitwise whose value is equivalent to this value with the designated bit cleared.

Specified by:

psyClearBit in interface PsyBitwise<PsyIntegral>

Parameters:

oBit - the index of bit to clear.

Returns:

a bitwise whose value is equivalent to this value with the designated bit cleared

psyOr

public PsyIntegral psyOr(PsyIntegral oIntegral)

Description copied from interface: PsyLogical

Returns a result of logical disjunction of this object and given object.

Specified by:

psyOr in interface PsyLogical<PsyIntegral>

Parameters:

oIntegral - given object.

Returns:

a result of logical disjunction of this object and given object

psyAnd

public PsyIntegral psyAnd(PsyIntegral oIntegral)

Description copied from interface: PsyLogical

Returns a result of logical conjunction of this object and given object.

Specified by:

psyAnd in interface PsyLogical<PsyIntegral>

Parameters:

oIntegral - given object.

Returns:

a result of logical conjunction of this object and given object

psyXor

public PsyIntegral psyXor(PsyIntegral oIntegral)

Description copied from interface: PsyLogical

Returns a result of logical exclusive disjunction of this object and given object.

Specified by:

psyXor in interface PsyLogical<PsyIntegral>

Parameters:

oIntegral - given object.

Returns:

a result of logical exclusive disjunction of this object and given object

psyNot

public PsyBigInteger psyNot()

Description copied from interface: PsyLogical

Returns a result of logical negation of this object.

Specified by:

psyNot in interface PsyLogical<PsyIntegral>

Returns:

a result of logical negation of this object

psyAbs

public PsyIntegral psyAbs()

Description copied from interface: PsyNumeric

Returns the numeric absolute value of this object.

Specified by:

psyAbs in interface PsyIntegral

Specified by:

psyAbs in interface PsyNumeric

Specified by:

psyAbs in interface PsyRational

Specified by:

psyAbs in interface PsyRealNumeric

Returns:

the numeric absolute value of this object

psyIdiv

public PsyIntegral psyIdiv(PsyRational oRational)
                    throws PsyUndefinedResultException

Description copied from interface: PsyRational

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

Specified by:

psyIdiv in interface PsyIntegral

Specified by:

psyIdiv in interface PsyRational

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.

psyMod

public PsyIntegral psyMod(PsyRational oRational)
                   throws PsyUndefinedResultException,
PsyRangeCheckException

Description copied from interface: PsyRational

Returns an integral representing this object modulo given modulus.

Specified by:

psyMod in interface PsyIntegral

Specified by:

psyMod in interface PsyRational

Parameters:

oRational - the given modulus.

Returns:

an integral representing this object modulo given modulus

Throws:

PsyUndefinedResultException - when the modulus is zero.

PsyRangeCheckException - when the modulus is negative.

psyGCD

public PsyRational psyGCD(PsyRational oRational)

Description copied from interface: PsyRational

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

Specified by:

psyGCD in interface PsyIntegral

Specified by:

psyGCD in interface PsyRational

Parameters:

oRational - the given object.

Returns:

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

psyMul

public PsyRealNumeric psyMul(PsyRealNumeric oRealNumeric)

Specified by:

psyMul in interface PsyRational

Specified by:

psyMul in interface PsyRealNumeric

psyDiv

public PsyRealNumeric psyDiv(PsyRealNumeric oRealNumeric)
                      throws PsyUndefinedResultException

Specified by:

psyDiv in interface PsyRational

Specified by:

psyDiv in interface PsyRealNumeric

Throws:

PsyUndefinedResultException

psyAdd

public PsyRealNumeric psyAdd(PsyRealNumeric oRealNumeric)

Specified by:

psyAdd in interface PsyRational

Specified by:

psyAdd in interface PsyRealNumeric

psySub

public PsyRealNumeric psySub(PsyRealNumeric oRealNumeric)

Specified by:

psySub in interface PsyRational

Specified by:

psySub in interface PsyRealNumeric

psyNeg

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

Specified by:

psyNeg in interface PsyRational

Specified by:

psyNeg in interface PsyRealNumeric

Returns:

the additive result of arithmetic negation of this object

psySignum

public PsyInteger psySignum()

Description copied from interface: PsyNumeric

Returns the numeric signum of this object.

Specified by:

psySignum in interface PsyNumeric

Returns:

the numeric signum of this object

compareTo

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

Specified by:

compareTo in interface 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.

toSyntaxString

public String toSyntaxString()

Description copied from interface: PsyObject

Returns the syntactic representation of this object.

Specified by:

toSyntaxString in interface PsyObject

Returns:

the syntactic representation of this object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object