bignum/com.ionspin.kotlin.bignum/BigNumber

BigNumber

interface BigNumber<BigType : BigNumber<BigType>>

Created by Ugljesa Jovanovic ugljesa.jovanovic@ionspin.com on 04-Apr-2019

Inheritors

ModularBigInteger

Types

interface Creator<BigType>

interface Util<BigType>

Properties

open val isNegative: Boolean

open val isPositive: Boolean

Functions

abstract fun abs(): BigType

Return absolute value of this big integer

abstract fun add(other: BigType): BigType

abstract fun compareTo(other: Any): Int

abstract fun divide(other: BigType): BigType

divideAndRemainder

abstract fun divideAndRemainder(other: BigType): Pair<BigType, BigType>

Perform integer division and return quotient and remainder

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

abstract fun getCreator(): BigNumber.Creator<BigType>

abstract fun isZero(): Boolean

abstract fun multiply(other: BigType): BigType

abstract fun negate(): BigType

Return additive inverse of this number

numberOfDecimalDigits

abstract fun numberOfDecimalDigits(): Long

Return the number of decimal digits representing this number

abstract fun pow(exponent: Int): BigType

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

abstract fun pow(exponent: Long): BigType

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

abstract fun remainder(other: BigType): BigType

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

secureOverwrite

abstract 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.

abstract fun signum(): Int

abstract fun subtract(other: BigType): BigType

abstract override fun toString(): String

abstract fun toString(base: Int): String

abstract operator fun unaryMinus(): BigType