bignum/com.ionspin.kotlin.bignum.modular/ModularBigInteger

ModularBigInteger

class ModularBigInteger : BigNumber<ModularBigInteger> , CommonBigNumberOperations<ModularBigInteger> , NarrowingOperations<ModularBigInteger> , ByteArraySerializable

Implementation of operations on modular integer

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

Types

object Companion

Properties

open val isNegative: Boolean

open val isPositive: Boolean

val modulus: BigInteger

val residue: BigInteger

Functions

open override fun abs(): ModularBigInteger

Return absolute value of this big integer

open override fun add(other: ModularBigInteger): ModularBigInteger

open override fun byteValue(exactRequired: Boolean): Byte

fun compare(other: ModularBigInteger): Int

open override fun compareTo(other: Any): Int

open operator fun div(other: ModularBigInteger): ModularBigInteger

open operator fun div(byte: Byte): ModularBigInteger

open operator fun div(int: Int): ModularBigInteger

open operator fun div(long: Long): ModularBigInteger

open operator fun div(short: Short): ModularBigInteger

open override fun divide(other: ModularBigInteger): ModularBigInteger

divideAndRemainder

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

Perform integer division and return quotient and remainder

infix fun divrem(other: ModularBigInteger): ModularQuotientAndRemainder

open override fun doubleValue(exactRequired: Boolean): Double

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

open override fun floatValue(exactRequired: Boolean): Float

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

open override fun getInstance(): ModularBigInteger

open override fun hashCode(): Int

open override fun intValue(exactRequired: Boolean): Int

fun inverse(): ModularBigInteger

open override fun isZero(): Boolean

open override fun longValue(exactRequired: Boolean): Long

open operator fun minus(other: ModularBigInteger): ModularBigInteger

open operator fun minus(byte: Byte): ModularBigInteger

open operator fun minus(int: Int): ModularBigInteger

open operator fun minus(long: Long): ModularBigInteger

open operator fun minus(short: Short): ModularBigInteger

open override fun multiply(other: ModularBigInteger): ModularBigInteger

open override fun negate(): ModularBigInteger

Return additive inverse of this number

numberOfDecimalDigits

open override fun numberOfDecimalDigits(): Long

Return the number of decimal digits representing this number

open operator fun plus(other: ModularBigInteger): ModularBigInteger

open operator fun plus(byte: Byte): ModularBigInteger

open operator fun plus(int: Int): ModularBigInteger

open operator fun plus(long: Long): ModularBigInteger

open operator fun plus(short: Short): ModularBigInteger

fun pow(exponent: BigInteger): ModularBigInteger

fun pow(exponent: ModularBigInteger): ModularBigInteger

open override fun pow(exponent: Int): ModularBigInteger

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

open override fun pow(exponent: Long): ModularBigInteger

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

open operator fun rem(byte: Byte): ModularBigInteger

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

open operator fun rem(int: Int): ModularBigInteger

open operator fun rem(long: Long): ModularBigInteger

open operator fun rem(short: Short): ModularBigInteger

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

open operator override fun rem(other: ModularBigInteger): ModularBigInteger

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

open override fun remainder(other: ModularBigInteger): ModularBigInteger

Remainder of integer division operation. Remainder has same sign as 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 shortValue(exactRequired: Boolean): Short

open override fun signum(): Int

open override fun subtract(other: ModularBigInteger): ModularBigInteger

open operator fun times(other: ModularBigInteger): ModularBigInteger

open operator fun times(byte: Byte): ModularBigInteger

open operator fun times(int: Int): ModularBigInteger

open operator fun times(long: Long): ModularBigInteger

open operator fun times(short: Short): ModularBigInteger

fun toBigInteger(): BigInteger

open override fun toByteArray(): ByteArray

open override fun toString(): String

open override fun toString(base: Int): String

toStringWithModulo

fun toStringWithModulo(base: Int = 10): String

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(): ModularBigInteger

open override fun ushortValue(exactRequired: Boolean): UShort