bignum/com.ionspin.kotlin.bignum.integer/BigIntegerList63Arithmetic

BigIntegerList63Arithmetic

interface BigIntegerList63Arithmetic

Interface defining big integer operations

Created by Ugljesa Jovanovic ugljesa.jovanovic@ionspin.com on 10-Mar-2019

Properties

abstract val basePowerOfTwo: Int

abstract val ONE: List<ULong>

abstract val TEN: List<ULong>

abstract val TWO: List<ULong>

abstract val ZERO: List<ULong>

Functions

abstract fun add(first: List<ULong>, second: List<ULong>): List<ULong>

Adds two big integers

abstract fun and(operand: List<ULong>, mask: List<ULong>): List<ULong>

abstract fun bitAt(operand: List<ULong>, position: Long): Boolean

abstract fun bitLength(value: List<ULong>): Int

Number of bits needed to represent this number

abstract fun compare(first: List<ULong>, second: List<ULong>): Int

Compares two numbers

abstract fun divide(first: List<ULong>, second: List<ULong>): Pair<List<ULong>, List<ULong>>

Divide two big integers

abstract fun fromByte(byte: Byte): List<ULong>

abstract fun fromByteArray(source: ByteArray): List<ULong>

abstract fun fromInt(int: Int): List<ULong>

abstract fun fromLong(long: Long): List<ULong>

abstract fun fromShort(short: Short): List<ULong>

abstract fun fromUByte(uByte: UByte): List<ULong>

abstract fun fromUByteArray(source: UByteArray): List<ULong>

abstract fun fromUInt(uInt: UInt): List<ULong>

abstract fun fromULong(uLong: ULong): List<ULong>

abstract fun fromUShort(uShort: UShort): List<ULong>

abstract fun gcd(first: List<ULong>, second: List<ULong>): List<ULong>

abstract fun multiply(first: List<ULong>, second: List<ULong>): List<ULong>

Multiplies two big integers

abstract fun not(operand: List<ULong>): List<ULong>

numberOfDecimalDigits

abstract fun numberOfDecimalDigits(operand: List<ULong>): Long

numberOfLeadingZerosInAWord

abstract fun numberOfLeadingZerosInAWord(value: ULong): Int

Returns the number of leading zeros in a word

abstract fun or(operand: List<ULong>, mask: List<ULong>): List<ULong>

abstract fun parseForBase(number: String, base: Int): List<ULong>

Parse a string in a specific base into a big integer

abstract fun pow(base: List<ULong>, exponent: Long): List<ULong>

Exponentiation function

abstract fun reciprocal(operand: List<ULong>): Pair<List<ULong>, List<ULong>>

Returns a integer reciprocal of this number such that 0 <= base ^ word - operand * reciprocal <= operand, and remainder such that 0 < reciprocal < operand

abstract fun setBitAt(operand: List<ULong>, position: Long, bit: Boolean): List<ULong>

abstract fun shiftLeft(operand: List<ULong>, places: Int): List<ULong>

Arithmetic shift left. Shifts the number to the left, by required places of bits, creating new words if necessary

abstract fun shiftRight(operand: List<ULong>, places: Int): List<ULong>

Arithmetic shift right. Shifts the number to the right, by required places of bits, removing words that no longer relevant

abstract fun sqrt(operand: List<ULong>): Pair<List<ULong>, List<ULong>>

abstract fun subtract(first: List<ULong>, second: List<ULong>): List<ULong>

Subtracts two big integers

abstract fun toByteArray(operand: List<ULong>): ByteArray

abstract fun toString(operand: List<ULong>, base: Int): String

return a string representation of big integer in a specific number base

abstract fun toUByteArray(operand: List<ULong>): UByteArray

trailingZeroBits

abstract fun trailingZeroBits(value: List<ULong>): Int

Number of consecutive zeros count from the right in binary representation

abstract fun xor(operand: List<ULong>, mask: List<ULong>): List<ULong>