bignum/com.ionspin.kotlin.bignum.integer/BigInteger

BigInteger

class BigInteger : BigNumber<BigInteger> , CommonBigNumberOperations<BigInteger> , NarrowingOperations<BigInteger> , BitwiseCapable<BigInteger> , Comparable<Any> , ByteArraySerializable

Arbitrary precision integer arithmetic.

Based on unsigned arrays, currently limited to Int.MAX_VALUE words.

Constructors

constructor(long: Long)

constructor(int: Int)

constructor(short: Short)

constructor(byte: Byte)

Types

BigIntegerIterator

class BigIntegerIterator(start: BigInteger, endInclusive: BigInteger) : Iterator<BigInteger>

BigIntegerRange

class BigIntegerRange(val start: BigInteger, val endInclusive: BigInteger) : ClosedRange<BigInteger> , Iterable<BigInteger>

object Companion : BigNumber.Creator<BigInteger> , BigNumber.Util<BigInteger> , ByteArrayDeserializable<BigInteger>

QuotientAndRemainder

data class QuotientAndRemainder(val quotient: BigInteger, val remainder: BigInteger)

SqareRootAndRemainder

data class SqareRootAndRemainder(val squareRoot: BigInteger, val remainder: BigInteger)

Properties

open val isNegative: Boolean

open val isPositive: Boolean

val numberOfWords: Int

stringRepresentation

var stringRepresentation: String?

Functions

open override fun abs(): BigInteger

Return absolute value of this big integer

open override fun add(other: BigInteger): BigInteger

open infix override fun and(other: BigInteger): BigInteger

open override fun bitAt(position: Long): Boolean

open override fun bitLength(): Int

Returns the number of bits needed to represent this number

open override fun byteValue(exactRequired: Boolean): Byte

fun compare(other: BigInteger): Int

compareDoubleAndBigInt

fun compareDoubleAndBigInt(double: Double, comparisonBlock: (BigInteger) -> Int): Int

compareFloatAndBigInt

fun compareFloatAndBigInt(float: Float, comparisonBlock: (BigInteger) -> Int): Int

open operator override fun compareTo(other: Any): Int

operator fun dec(): BigInteger

open operator fun div(other: BigInteger): BigInteger

open operator fun div(byte: Byte): BigInteger

open operator fun div(int: Int): BigInteger

open operator fun div(long: Long): BigInteger

open operator fun div(short: Short): BigInteger

open override fun divide(other: BigInteger): BigInteger

divideAndRemainder

open override fun divideAndRemainder(other: BigInteger): Pair<BigInteger, BigInteger>

Perform integer division and return quotient and remainder

infix fun divrem(other: BigInteger): BigInteger.QuotientAndRemainder

open override fun doubleValue(exactRequired: Boolean): Double

open operator override fun equals(other: Any?): Boolean

fun factorial(): BigInteger

open override fun floatValue(exactRequired: Boolean): Float

fun gcd(other: BigInteger): BigInteger

getBackingArrayCopy

fun getBackingArrayCopy(): WordArray

open override fun getCreator(): BigNumber.Creator<BigInteger>

open override fun getInstance(): BigInteger

fun getSign(): Sign

open override fun hashCode(): Int

operator fun inc(): BigInteger

open override fun intValue(exactRequired: Boolean): Int

open override fun isZero(): Boolean

open override fun longValue(exactRequired: Boolean): Long

open operator fun minus(other: BigInteger): BigInteger

open operator fun minus(byte: Byte): BigInteger

open operator fun minus(int: Int): BigInteger

open operator fun minus(long: Long): BigInteger

open operator fun minus(short: Short): BigInteger

infix fun mod(modulo: BigInteger): BigInteger

Returns an always positive remainder of division operation

fun modInverse(modulo: BigInteger): BigInteger

open override fun multiply(other: BigInteger): BigInteger

open override fun negate(): BigInteger

Return additive inverse of this number

open override fun not(): BigInteger

Inverts only up to chosen arithmetic bits. This is different from Java biginteger which returns inverse in two's complement.

numberOfDecimalDigits

open override fun numberOfDecimalDigits(): Long

Return the number of decimal digits representing this number

open infix override fun or(other: BigInteger): BigInteger

Returns a new BigInt with bits combining this, other doing a bitwise |/or operation. Forces sign to positive.

open operator fun plus(other: BigInteger): BigInteger

open operator fun plus(byte: Byte): BigInteger

open operator fun plus(int: Int): BigInteger

open operator fun plus(long: Long): BigInteger

open operator fun plus(short: Short): BigInteger

fun pow(exponent: BigInteger): BigInteger

open override fun pow(exponent: Int): BigInteger

Return result of exponentiation of this number by supplied integer exponent i.e.

open override fun pow(exponent: Long): BigInteger

Return result of exponentiation of this number by supplied long exponent i.e.

operator fun rangeTo(other: BigInteger): BigInteger.BigIntegerRange

open operator fun rem(other: BigInteger): BigInteger

Remainder of integer division operation. Returns the least absolute remainder (remainder has same sign as dividend)

open operator fun rem(byte: Byte): BigInteger

Remainder of integer division operation. Remainder has same sign as dividend.

open operator fun rem(int: Int): BigInteger

open operator fun rem(long: Long): BigInteger

open operator fun rem(short: Short): BigInteger

Remainder of integer division operation. Remainder has same sign as dividend

open override fun remainder(other: BigInteger): BigInteger

Returns the remainder of division operation. Uses truncating division, which means that the sign of remainder will be same as sign of dividend

secureOverwrite

open override fun secureOverwrite()

Overwrite the underlying backing structure with zeroes. Meant to be used by libraries that require it for security purposes. NOTE: This breaks the immutability of BigNumber, and this instance cannot be used for further calculations. If it used the results are undefined.

open override fun setBitAt(position: Long, bit: Boolean): BigInteger

open infix override fun shl(places: Int): BigInteger

open override fun shortValue(exactRequired: Boolean): Short

open infix override fun shr(places: Int): BigInteger

open override fun signum(): Int

fun sqrt(): BigInteger

sqrtAndRemainder

fun sqrtAndRemainder(): BigInteger.SqareRootAndRemainder

open override fun subtract(other: BigInteger): BigInteger

open operator fun times(other: BigInteger): BigInteger

open operator fun times(byte: Byte): BigInteger

open operator fun times(int: Int): BigInteger

open operator fun times(long: Long): BigInteger

open operator fun times(short: Short): BigInteger

operator fun times(char: Char): String

open override fun toByteArray(): ByteArray

toJavaBigInteger

fun BigInteger.toJavaBigInteger(): BigInteger

toModularBigInteger

fun toModularBigInteger(modulo: BigInteger): ModularBigInteger

open override fun toString(): String

open override fun toString(base: Int): String

toTwosComplementByteArray

fun BigInteger.toTwosComplementByteArray(): ByteArray

open override fun toUByteArray(): UByteArray

open override fun ubyteValue(exactRequired: Boolean): UByte

open override fun uintValue(exactRequired: Boolean): UInt

open override fun ulongValue(exactRequired: Boolean): ULong

open operator override fun unaryMinus(): BigInteger

open override fun ushortValue(exactRequired: Boolean): UShort

open infix override fun xor(other: BigInteger): BigInteger