org.matheclipse.core.interfaces

Interface IInteger

All Superinterfaces:

edu.jas.structure.AbelianGroupElem<IExpr>, java.lang.Comparable<IExpr>, edu.jas.structure.Element<IExpr>, org.apache.commons.math4.FieldElement<IExpr>, edu.jas.structure.GcdRingElem<IExpr>, IBigNumber, IExpr, INumber, IRational, ISignedNumber, edu.jas.structure.MonoidElem<IExpr>, edu.jas.structure.RingElem<IExpr>, java.io.Serializable

All Known Implementing Classes:

AbstractIntegerSym, BigIntegerSym, IntegerSym

public interface IInteger
extends IRational

An expression representing a big integer number

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRIME_CERTAINTY Certainty for the isProbablePrime() method

Fields inherited from interface org.matheclipse.core.interfaces.IExpr

ASTID, BLANKID, COMPLEXID, DOUBLECOMPLEXID, DOUBLEID, FRACTIONID, INTEGERID, METHODSYMBOLID, PATTERNID, STRINGID, SYMBOLID

Method Summary

Modifier and Type	Method and Description
IInteger	add(IInteger val)
IInteger	div(IInteger that)
IInteger[]	divideAndRemainder(IInteger that) Returns an array of two IIntegers containing (this / that) followed by (this % that).
IAST	divisors()
IInteger	eabs() Get the absolute value for a given number
IInteger	eulerPhi()
IExpr	exponent(IInteger base) Get the highest exponent of base that divides this
IInteger	gcd(IInteger val) Returns the greatest common divisor of this large integer and the one specified.
java.math.BigInteger	getBigNumerator() Returns the numerator of this Rational.
int	intValue() Converts this large integer to int; unlike ISignedNumber.toInt() this method raises no exception, if this integer cannot be represented by an int type.
boolean	isEven()
boolean	isOdd()
boolean	isProbablePrime()
boolean	isProbablePrime(int certainty)
IInteger	jacobiSymbol(IInteger b)
IInteger	jacobiSymbolF()
IInteger	jacobiSymbolG(IInteger b)
IInteger	lcm(IInteger val) Returns the least common multiple of this large integer and the one specified.
long	longValue()
IInteger	mod(IInteger that)
IInteger	modInverse(IInteger m)
IInteger	modPow(IInteger exp, IInteger m)
IInteger	moebiusMu()
IInteger	multiply(IInteger value) Multiply this integer with value
IInteger	negate() Returns an IInteger whose value is (-1) * this.
IInteger	nthRoot(int n) Returns the n-th integer root
IInteger[]	nthRootSplit(int n) Split this integer into the nth-root (with prime factors less equal 1021) and the "rest factor"
IInteger	pow(long exp) Returns this number raised at the specified exponent.
IInteger[]	primitiveRoots()
IInteger	quotient(IInteger that)
IInteger	shiftLeft(int n)
IInteger	shiftRight(int n)
IInteger	subtract(IInteger value)
byte[]	toByteArray()

Methods inherited from interface org.matheclipse.core.interfaces.IRational

abs, add, ceil, compareInt, divideBy, equalsFraction, factorInteger, floor, getBigDenominator, getDenominator, getFraction, getNumerator, multiply, normalize, subtract

Methods inherited from interface org.matheclipse.core.interfaces.ISignedNumber

apfloatNumValue, divideBy, doubleValue, inverse, isGreaterThan, isLessThan, isNegative, isPositive, isZero, numValue, opposite, round, sign, subtractFrom, toInt, toLong

Methods inherited from interface org.matheclipse.core.interfaces.IBigNumber

numericNumber

Methods inherited from interface org.matheclipse.core.interfaces.INumber

apcomplexNumValue, ceilFraction, compareAbsValueToOne, complexNumValue, complexSign, conjugate, equalsInt, floorFraction, getIm, getImaginary, getRe, getReal

Methods inherited from interface org.matheclipse.core.interfaces.IExpr

$div, $minus, $plus, $times, $up, accept, accept, accept, accept, and, apply, apply, asType, compareTo, dec, divide, evalComplex, evalDouble, evalNumber, evalSignedNumber, evaluate, evaluateHead, fullFormString, getAt, getField, head, hierarchy, ifPresent, inc, internalFormString, internalJavaString, internalScalaString, isAllExpanded, isAnd, isArcCos, isArcCosh, isArcSin, isArcSinh, isArcTan, isArcTanh, isAST, isAST, isAST, isAST, isAST, isAST, isAST, isASTSizeGE, isAtom, isBlank, isComplex, isComplexInfinity, isComplexNumeric, isCondition, isConstant, isCos, isCosh, isDerivative, isDirectedInfinity, isE, isExpanded, isFalse, isFlatAST, isFraction, isFree, isFree, isFree, isFreeAST, isFreeAST, isFreeOfPatterns, isFunction, isGEOrdered, isGTOrdered, isIndeterminate, isInfinity, isInteger, isIntegerResult, isLEOrdered, isList, isListOfLists, isLog, isLTOrdered, isMatrix, isMember, isMember, isMinusOne, isModule, isNegativeInfinity, isNegativeResult, isNonNegativeResult, isNot, isNumber, isNumEqualInteger, isNumEqualRational, isNumeric, isNumericFunction, isNumericMode, isNumIntValue, isOne, isONE, isOr, isOrderlessAST, isPattern, isPatternDefault, isPatternExpr, isPatternSequence, isPi, isPlus, isPlusTimesPower, isPolynomial, isPolynomial, isPolynomialOfMaxDegree, isPositiveResult, isPower, isPresent, isRational, isRationalResult, isRationalValue, isRealResult, isRuleAST, isSame, isSame, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSpan, isSymbol, isTan, isTanh, isTimes, isTrue, isUnit, isValue, isVariable, isVector, isZERO, leafCount, leaves, minus, mod, multiply, multiply, negative, ofNullable, optional, or, orElse, orElseGet, orElseThrow, plus, power, power, reciprocal, replaceAll, replaceAll, replacePart, replaceRepeated, replaceRepeated, replaceSlots, signum, subtract, sum, times, timesDistributed, topHead, variables2Slots

Methods inherited from interface edu.jas.structure.RingElem

egcd, gcd

Methods inherited from interface edu.jas.structure.MonoidElem

remainder

Methods inherited from interface edu.jas.structure.Element

copy, equals, factory, hashCode, toScript, toScriptFactory

Field Detail

PRIME_CERTAINTY

static final int PRIME_CERTAINTY

Certainty for the isProbablePrime() method

See Also:

Constant Field Values

Method Detail

add

IInteger add(IInteger val)

div

IInteger div(IInteger that)

divideAndRemainder

IInteger[] divideAndRemainder(IInteger that)

Returns an array of two IIntegers containing (this / that) followed by (this % that).

Parameters:

that -

Returns:

divisors

IAST divisors()

eabs

IInteger eabs()

Description copied from interface: INumber

Get the absolute value for a given number

Specified by:

eabs in interface INumber

Returns:

eulerPhi

IInteger eulerPhi()
           throws java.lang.ArithmeticException

Throws:

java.lang.ArithmeticException

exponent

IExpr exponent(IInteger base)

Get the highest exponent of base that divides this

Parameters:

base - an integer greater than 1

Returns:

the exponent

gcd

IInteger gcd(IInteger val)

Returns the greatest common divisor of this large integer and the one specified.

getBigNumerator

java.math.BigInteger getBigNumerator()

Returns the numerator of this Rational.

Specified by:

getBigNumerator in interface IRational

Returns:

numerator

intValue

int intValue()

Converts this large integer to int; unlike ISignedNumber.toInt() this method raises no exception, if this integer cannot be represented by an int type.

Returns:

the numeric value represented by this integer after conversion to type int.

isEven

boolean isEven()

isOdd

boolean isOdd()

isProbablePrime

boolean isProbablePrime()

isProbablePrime

boolean isProbablePrime(int certainty)

jacobiSymbol

IInteger jacobiSymbol(IInteger b)

jacobiSymbolF

IInteger jacobiSymbolF()

jacobiSymbolG

IInteger jacobiSymbolG(IInteger b)

lcm

IInteger lcm(IInteger val)

Returns the least common multiple of this large integer and the one specified.

longValue

long longValue()

mod

IInteger mod(IInteger that)

modInverse

IInteger modInverse(IInteger m)

modPow

IInteger modPow(IInteger exp,
                IInteger m)

moebiusMu

IInteger moebiusMu()

multiply

IInteger multiply(IInteger value)

Multiply this integer with value

Parameters:

value -

Returns:

negate

IInteger negate()

Returns an IInteger whose value is (-1) * this.

Specified by:

negate in interface edu.jas.structure.AbelianGroupElem<IExpr>

Specified by:

negate in interface org.apache.commons.math4.FieldElement<IExpr>

Specified by:

negate in interface IRational

Specified by:

negate in interface ISignedNumber

Returns:

nthRoot

IInteger nthRoot(int n)
          throws java.lang.ArithmeticException

Returns the n-th integer root

Parameters:

n -

Returns:

Throws:

java.lang.ArithmeticException

nthRootSplit

IInteger[] nthRootSplit(int n)

Split this integer into the nth-root (with prime factors less equal 1021) and the "rest factor"

Returns:

{nth-root, rest factor}

pow

IInteger pow(long exp)
      throws java.lang.ArithmeticException

Description copied from interface: IRational

Returns this number raised at the specified exponent.

Specified by:

pow in interface IRational

Parameters:

exp - the exponent.

Returns:

thisexp

Throws:

java.lang.ArithmeticException - if 0^0 is given.

primitiveRoots

IInteger[] primitiveRoots()
                   throws java.lang.ArithmeticException

Throws:

java.lang.ArithmeticException

quotient

IInteger quotient(IInteger that)

shiftLeft

IInteger shiftLeft(int n)

shiftRight

IInteger shiftRight(int n)

subtract

IInteger subtract(IInteger value)

toByteArray

byte[] toByteArray()