units / org.apache.tuweni.units.bigints / UInt256

UInt256

class UInt256 : UInt256Value<UInt256> (source)

An unsigned 256-bit precision number. This is a raw UInt256Value - a 256-bit precision unsigned number of no particular unit.

Properties

MAX_VALUE

static val MAX_VALUE: UInt256

The maximum value of a UInt256

MIN_VALUE

static val MIN_VALUE: UInt256

The minimum value of a UInt256

ONE

static val ONE: UInt256

The value 1

ZERO

static val ZERO: UInt256

The value 0

Functions

add

fun add(value: UInt256): UInt256
fun add(value: Long): UInt256

addMod

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

and

fun and(value: UInt256): UInt256

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

fun and(bytes: Bytes32): UInt256

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

bitLength

fun bitLength(): Int

compareTo

fun compareTo(other: UInt256): Int

divide

fun divide(value: UInt256): UInt256
fun divide(value: Long): UInt256

equals

fun equals(other: Any?): Boolean

fitsInt

fun fitsInt(): Boolean

fitsLong

fun fitsLong(): Boolean

fromBytes

static fun fromBytes(bytes: Bytes): UInt256

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

fromHexString

static fun fromHexString(str: String): UInt256

Parse a hexadecimal string into a UInt256.

hashCode

fun hashCode(): Int

intValue

fun intValue(): Int

isZero

fun isZero(): Boolean

mod

fun mod(modulus: UInt256): UInt256
fun mod(modulus: Long): UInt256

multiply

fun multiply(value: UInt256): UInt256
fun multiply(value: Long): UInt256

multiplyMod

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

not

fun not(): UInt256

Return a bit-wise NOT of this value.

numberOfLeadingZeros

fun numberOfLeadingZeros(): Int

or

fun or(value: UInt256): UInt256

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

fun or(bytes: Bytes32): UInt256

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

pow

fun pow(exponent: UInt256): UInt256
fun pow(exponent: Long): UInt256

shiftLeft

fun shiftLeft(distance: Int): UInt256

Shift all bits in this value to the left.

shiftRight

fun shiftRight(distance: Int): UInt256

Shift all bits in this value to the right.

subtract

fun subtract(value: UInt256): UInt256
fun subtract(value: Long): UInt256

toBigInteger

fun toBigInteger(): BigInteger

toBytes

fun toBytes(): Bytes32

toLong

fun toLong(): Long

toMinimalBytes

fun toMinimalBytes(): Bytes

toString

fun toString(): String

toUInt256

fun toUInt256(): UInt256

valueOf

static fun valueOf(value: Long): UInt256

Return a UInt256 containing the specified value.

static fun valueOf(value: BigInteger): UInt256

Return a UInt256 containing the specified value.

xor

fun xor(value: UInt256): UInt256

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

fun xor(bytes: Bytes32): UInt256

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 32 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