kitejs/io.github.yuroyami.kitejs/KBigInt

KBigInt

class KBigInt : Comparable<KBigInt>

An arbitrary-precision integer: what BigInt values are made of.

Upstream uses java.math.BigInteger, which common Kotlin has no equal of, so this is the port's own (D-5). Sign and magnitude, with the magnitude a little-endian IntArray of base 2^32 limbs and no trailing zero limbs, so a value has exactly one representation and equality is a plain array comparison.

The bitwise operations follow the JavaScript rule: two's complement over an infinitely long bit string, so -1n and 3n is 3n and not(5n) is -6n. shiftRight floors, matching >>.

It deliberately does NOT extend Number, even though upstream's BigInteger does: on Kotlin/JS Number is the JS primitive number type, so a class extending it fails is Number and throws on as Number. The runtime tells a bigint apart with is KBigInt instead (D-54).

Constructors

constructor(digits: String, radix: Int)

Parses digits in radix. This is the shape the lexer builds a 123n literal with.

Types

object Companion

Properties

val isZero: Boolean

Functions

fun abs(): KBigInt

fun add(other: KBigInt): KBigInt

fun and(other: KBigInt): KBigInt

fun asIntN(bits: Int): KBigInt

BigInt.asIntN: the low bits bits, read as a two's complement signed number.

fun asUintN(bits: Int): KBigInt

BigInt.asUintN: the low bits bits, read as a number that is never negative.

fun bitLength(): Int

The bits in the shortest two's complement spelling, not counting the sign bit, the same count java.math.BigInteger.bitLength gives.

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

compareToDouble

fun compareToDouble(d: Double): Int

Compares against a finite d without losing anything to rounding.

fun divide(other: KBigInt): KBigInt

Truncates toward zero, which is what / does on BigInt.

divideAndRemainder

fun divideAndRemainder(other: KBigInt): Pair<KBigInt, KBigInt>

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

open override fun hashCode(): Int

fun intValueExact(): Int

The value as an Int, or an error when it does not fit.

fun longValueExact(): Long

The value as a Long, or an error when it does not fit.

fun mod(modulus: KBigInt): KBigInt

The remainder that is never negative, so (-7).mod(3) is 2.

fun multiply(other: KBigInt): KBigInt

fun negate(): KBigInt

fun not(): KBigInt

-x - 1, which is what ~ means on an infinitely long two's complement number.

fun or(other: KBigInt): KBigInt

fun pow(exponent: Int): KBigInt

fun remainder(other: KBigInt): KBigInt

Takes the sign of the dividend, which is what % does on BigInt.

fun shiftLeft(n: Int): KBigInt

fun shiftRight(n: Int): KBigInt

Arithmetic, so it floors: -5 shr 1 is -3, not -2.

fun signum(): Int

-1, 0 or 1.

fun subtract(other: KBigInt): KBigInt

fun testBit(n: Int): Boolean

fun toByte(): Byte

fun toDouble(): Double

The nearest double, rounded to even, and infinite once past the double range.

fun toFloat(): Float

fun toInt(): Int

The low 32 bits, wrapping the way a cast does.

fun toLong(): Long

The low 64 bits, wrapping the way a cast does.

fun toShort(): Short

open override fun toString(): String

fun toString(radix: Int): String

fun xor(other: KBigInt): KBigInt