cryptohash/com.appmattus.crypto.internal.core.uint

Package-level declarations

Types

class UInt128(val upper: ULong, val lower: ULong) : Comparable<UInt128>

Represents a 128-bit unsigned integer.

UInt128Iterator

abstract class UInt128Iterator : Iterator<UInt128>

An iterator over a sequence of values of type UInt128.

UInt128Progression

open class UInt128Progression : Iterable<UInt128>

A progression of values of type UInt128.

class UInt128Range(start: UInt128, endInclusive: UInt128) : UInt128Progression, ClosedRange<UInt128>

A range of values of type UInt128.

Functions

countLeadingZeroBits

inline fun UInt128.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this UInt128 number.

inline fun UInt128.countOneBits(): Int

Counts the number of set bits in the binary representation of this UInt128 number.

countTrailingZeroBits

inline fun UInt128.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this UInt128 number.

fun UInt128.isqrt(): UInt128

Get the floor value of the exact square root of this

fun UInt128.pow(n: Int): UInt128

Raises this value to the integer power n

inline fun UInt128.rotateLeft(bitCount: Int): UInt128

Rotates the binary representation of this UInt128 number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

inline fun UInt128.rotateRight(bitCount: Int): UInt128

Rotates the binary representation of this UInt128 number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

infix fun UInt128Progression.step(step: Long): UInt128Progression

Returns a progression that goes over the same range with the given step.

takeHighestOneBit

inline fun UInt128.takeHighestOneBit(): UInt128

Returns a number having a single bit set in the position of the most significant set bit of this UInt128 number, or zero, if this number is zero.

takeLowestOneBit

inline fun UInt128.takeLowestOneBit(): UInt128

Returns a number having a single bit set in the position of the least significant set bit of this UInt128 number, or zero, if this number is zero.

fun UInt128.toString(radix: Int): String

Returns a string representation of this UInt128 value in the specified radix.

inline fun Byte.toUInt128(): UInt128

Converts this Byte value to UInt128.

inline fun Int.toUInt128(): UInt128

Converts this Int value to UInt128.

inline fun Long.toUInt128(): UInt128

Converts this Long value to UInt128.

inline fun Short.toUInt128(): UInt128

Converts this Short value to UInt128.

fun String.toUInt128(): UInt128

fun String.toUInt128(radix: Int): UInt128

Parses the string as a UInt128 number and returns the result.

inline fun UByte.toUInt128(): UInt128

Converts this UByte value to UInt128.

inline fun UInt.toUInt128(): UInt128

Converts this UInt value to UInt128.

inline fun ULong.toUInt128(): UInt128

Converts this ULong value to UInt128.

inline fun UShort.toUInt128(): UInt128

Converts this UShort value to UInt128.

toUInt128OrNull

inline fun String.toUInt128OrNull(): UInt128?

fun String.toUInt128OrNull(radix: Int): UInt128?

Parses the string as an ULong number and returns the result or null if the string is not a valid representation of a number.

infix fun UInt128.until(to: UInt128): UInt128Range

Returns a range from this value up to but excluding the specified to value.