tuweni / org.apache.tuweni.units.bigints / UInt32Value

UInt32Value

interface UInt32Value<T : UInt32Value<T>!> : Comparable<T> (source)

Represents a 32-bit (8 bytes) unsigned integer value.

A UInt32Value is an unsigned integer value whose value can range between 0 and 2^32-1.

This interface defines operations for value types with a 32-bit precision range. The methods provided by this interface take parameters of the same type (and also long. This provides type safety by ensuring calculations cannot mix different UInt32Value types.

Where only a pure numerical 32-bit value is required, UInt32 should be used.

It is strongly advised to extend BaseUInt32Value rather than implementing this interface directly. Doing so provides type safety in that quantities of different units cannot be mixed accidentally.

Functions

add	Returns a value that is `(this + value)`. `abstract fun add(value: T): T` `abstract fun add(value: Int): T`
addExact	Returns a value that is `(this + value)`. `open fun addExact(value: T): T` `open fun addExact(value: Int): T`
addMod	Returns a value equivalent to `((this + value) mod modulus)`. `abstract fun addMod(value: T, modulus: UInt32!): T` `abstract fun addMod(value: Long, modulus: UInt32!): T` `abstract fun addMod(value: Long, modulus: Long): T`
bitLength	Provides the number of bits following and including the highest-order ("leftmost") one-bit `open fun bitLength(): Int`
divide	Returns a value that is `(this / value)`. `abstract fun divide(value: T): T` `abstract fun divide(value: Int): T`
fitsInt	Returns true if this value fits an int. `open fun fitsInt(): Boolean`
fitsLong	Returns true if this value fits a long. `open fun fitsLong(): Boolean`
intValue	Returns this value as an int. `open fun intValue(): Int`
isZero	Returns true is this is 0. `open fun isZero(): Boolean`
mod	Returns a value that is `(this mod modulus)`. `abstract fun mod(modulus: UInt32!): T` `abstract fun mod(modulus: Int): T`
multiply	Returns a value that is `(this * value)`. `abstract fun multiply(value: T): T` `abstract fun multiply(value: Int): T`
multiplyMod	Returns a value that is `((this * value) mod modulus)`. `abstract fun multiplyMod(value: T, modulus: UInt32!): T` `abstract fun multiplyMod(value: Int, modulus: UInt32!): T` `abstract fun multiplyMod(value: Int, modulus: Int): T`
numberOfLeadingZeros	Provides the number of zero bits preceding the highest-order ("leftmost") one-bit `open fun numberOfLeadingZeros(): Int`
pow	Returns a value that is `(this<sup>exponent</sup> mod 2<sup>32</sup>)` `abstract fun pow(exponent: UInt32!): T` `abstract fun pow(exponent: Long): T`
subtract	Returns a value that is `(this - value)`. `abstract fun subtract(value: T): T` `abstract fun subtract(value: Int): T`
subtractExact	Returns a value that is `(this - value)`. `open fun subtractExact(value: T): T` `open fun subtractExact(value: Int): T`
toBigInteger	Provides this value as a BigInteger. `open fun toBigInteger(): BigInteger!`
toBytes	Provides the value as bytes. `abstract fun toBytes(): Bytes!`
toHexString	This value represented as an hexadecimal string. `open fun toHexString(): String!`
toLong	Returns this value as a long. `open fun toLong(): Long`
toMinimalBytes	Provides the value as bytes without any leading zero bytes `abstract fun toMinimalBytes(): Bytes!`
toShortHexString	Returns this value represented as a minimal hexadecimal string (without any leading zero). `open fun toShortHexString(): String!`
toUInt32	Convert this value to a `UInt32`. `abstract fun toUInt32(): UInt32!`

Inheritors

BaseUInt32Value	Base class for `UInt32Value`. `abstract class BaseUInt32Value<T : UInt32Value<T>!> : UInt32Value<T>`
UInt32	An unsigned 32-bit precision number. `class UInt32 : UInt32Value<UInt32!>`