units / org.apache.tuweni.units.bigints / UInt64

UInt64

class UInt64 : UInt64Value<UInt64> (source)

An unsigned 64-bit precision number. This is a raw UInt64Value - a 64-bit precision unsigned number of no particular unit.

Properties

MAX_VALUE

static val MAX_VALUE: UInt64

The maximum value of a UInt64

MIN_VALUE

static val MIN_VALUE: UInt64

The minimum value of a UInt64

ONE

static val ONE: UInt64

The value 1

ZERO

static val ZERO: UInt64

The value 0

Functions

add

fun add(value: UInt64): UInt64
fun add(value: Long): UInt64

addMod

fun addMod(value: UInt64, modulus: UInt64): UInt64
fun addMod(value: Long, modulus: UInt64): UInt64
fun addMod(value: Long, modulus: Long): UInt64

and

fun and(value: UInt64): UInt64

Return a bit-wise AND of this value and the supplied value.

fun and(bytes: Bytes): UInt64

Return a bit-wise AND of this value and the supplied bytes.

bitLength

fun bitLength(): Int

compareTo

fun compareTo(other: UInt64): Int

divide

fun divide(value: UInt64): UInt64
fun divide(value: Long): UInt64

equals

fun equals(other: Any?): Boolean

fitsInt

fun fitsInt(): Boolean

fitsLong

fun fitsLong(): Boolean

fromBytes

static fun fromBytes(bytes: Bytes): UInt64

Return a UInt64 containing the value described by the specified bytes.

fromHexString

static fun fromHexString(str: String): UInt64

Parse a hexadecimal string into a UInt64.

hashCode

fun hashCode(): Int

intValue

fun intValue(): Int

isZero

fun isZero(): Boolean

mod

fun mod(modulus: UInt64): UInt64
fun mod(modulus: Long): UInt64

multiply

fun multiply(value: UInt64): UInt64
fun multiply(value: Long): UInt64

multiplyMod

fun multiplyMod(value: UInt64, modulus: UInt64): UInt64
fun multiplyMod(value: Long, modulus: UInt64): UInt64
fun multiplyMod(value: Long, modulus: Long): UInt64

not

fun not(): UInt64

Return a bit-wise NOT of this value.

numberOfLeadingZeros

fun numberOfLeadingZeros(): Int

or

fun or(value: UInt64): UInt64

Return a bit-wise OR of this value and the supplied value.

fun or(bytes: Bytes): UInt64

Return a bit-wise OR of this value and the supplied bytes.

pow

fun pow(exponent: UInt64): UInt64
fun pow(exponent: Long): UInt64

shiftLeft

fun shiftLeft(distance: Int): UInt64

Shift all bits in this value to the left.

shiftRight

fun shiftRight(distance: Int): UInt64

Shift all bits in this value to the right.

subtract

fun subtract(value: UInt64): UInt64
fun subtract(value: Long): UInt64

toBigInteger

fun toBigInteger(): BigInteger

toBytes

fun toBytes(): Bytes

toLong

fun toLong(): Long

toMinimalBytes

fun toMinimalBytes(): Bytes

toString

fun toString(): String

toUInt64

fun toUInt64(): UInt64

valueOf

static fun valueOf(value: Long): UInt64

Return a UInt64 containing the specified value.

static fun valueOf(value: BigInteger): UInt64

Return a UInt64 containing the specified value.

xor

fun xor(value: UInt64): UInt64

Return a bit-wise XOR of this value and the supplied value. If this value and the supplied value are different lengths, then the shorter will be zero-padded to the left.

fun xor(bytes: Bytes): UInt64

Return a bit-wise XOR of this value and the supplied bytes.

Inherited Functions

addExact

open fun addExact(value: T): T
open fun addExact(value: Long): T

Returns a value that is (this + value).

subtractExact

open fun subtractExact(value: T): T
open fun subtractExact(value: Long): T

Returns a value that is (this - value).

toHexString

open fun toHexString(): String

This value represented as an hexadecimal string.

Note that this representation includes all the 8 underlying bytes, no matter what the integer actually represents (in other words, it can have many leading zeros). For a shorter representation that don't include leading zeros, use #toShortHexString.

toShortHexString

open fun toShortHexString(): String