org.tron.tronj.crypto.tuweniTypes

接口 UInt256Value<T extends UInt256Value<T>>

类型参数:

T - The concrete type of the value.

所有超级接口:

Comparable<T>

所有已知实现类:

UInt256

public interface UInt256Value<T extends UInt256Value<T>>
extends Comparable<T>

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

A UInt256Value is an unsigned integer value stored with 32 bytes, so whose value can range between 0 and 2^256-1.

This interface defines operations for value types with a 256-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 UInt256Value types.

Where only a pure numerical 256-bit value is required, UInt256 should be used.

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

方法概要

限定符和类型	方法和说明
T	add(long value) Returns a value that is (this + value).
T	add(T value) Returns a value that is (this + value).
default T	addExact(long value) Returns a value that is (this + value).
default T	addExact(T value) Returns a value that is (this + value).
T	addMod(long value, long modulus) Returns a value equivalent to ((this + value) mod modulus).
T	addMod(long value, UInt256 modulus) Returns a value equivalent to ((this + value) mod modulus).
T	addMod(T value, UInt256 modulus) Returns a value equivalent to ((this + value) mod modulus).
default int	bitLength() Provides the number of bits following and including the highest-order ("leftmost") one-bit in the binary representation of this value, or zero if all bits are zero.
T	divide(long value) Returns a value that is (this / value).
T	divide(T value) Returns a value that is (this / value).
T	divideCeil(long value) Returns a value that is ceiling(this / value).
T	divideCeil(T value) Returns a value that is ceiling(this / value).
default boolean	fitsInt() Returns true if the value can fit in an int.
default boolean	fitsLong() Returns true if the value can fit in a long.
default int	intValue() Provides this value as an int.
default boolean	isZero() Returns true is the value is 0.
T	mod(long modulus) Returns a value that is (this mod modulus).
T	mod(UInt256 modulus) Returns a value that is (this mod modulus).
T	mod0(long modulus) Returns a value that is (this mod modulus), or 0 if modulus is 0.
T	mod0(UInt256 modulus) Returns a value that is (this mod modulus), or 0 if modulus is 0.
T	multiply(long value) Returns a value that is (this * value).
T	multiply(T value) Returns a value that is (this * value).
T	multiplyMod(long value, long modulus) Returns a value that is ((this * value) mod modulus).
T	multiplyMod(long value, UInt256 modulus) Returns a value that is ((this * value) mod modulus).
T	multiplyMod(T value, UInt256 modulus) Returns a value that is ((this * value) mod modulus).
default int	numberOfLeadingZeros() Provides the number of zero bits preceding the highest-order one-bit.
default T	plus(long value) Returns a value that is (this + value).
default T	plus(T value) Returns a value that is (this + value).
T	pow(long exponent) Returns a value that is (this<sup>exponent</sup> mod 2<sup>256</sup>) This calculates an exponentiation over the modulus of 2^256.
T	pow(UInt256 exponent) Returns a value that is (this<sup>exponent</sup> mod 2<sup>256</sup>) This calculates an exponentiation over the modulus of 2^256.
T	subtract(long value) Returns a value that is (this - value).
T	subtract(T value) Returns a value that is (this - value).
default T	subtractExact(long value) Returns a value that is (this - value).
default T	subtractExact(T value) Returns a value that is (this - value).
default BigInteger	toBigInteger() Provides the value as a BigInteger.
Bytes32	toBytes() Provides the value as bytes.
default String	toHexString() This value represented as an hexadecimal string.
default long	toLong() Provides the value as a long.
Bytes	toMinimalBytes() Provides the value as bytes without any leading zero bytes.
default String	toShortHexString() Returns this value represented as a minimal hexadecimal string (without any leading zero)
UInt256	toUInt256() Convert this value to a UInt256.

从接口继承的方法 java.lang.Comparable

compareTo

方法详细资料

isZero

default boolean isZero()

Returns true is the value is 0.

返回:

True if this is the value 0.

add

T add(T value)

Returns a value that is (this + value).

参数:

value - The amount to be added to this value.

返回:

this + value

plus

default T plus(T value)

Returns a value that is (this + value).

This notation can be used in Kotlin with the + operator.

参数:

value - The amount to be added to this value.

返回:

this + value

plus

default T plus(long value)

Returns a value that is (this + value).

This notation can be used in Kotlin with the + operator.

参数:

value - The amount to be added to this value.

返回:

this + value

addExact

default T addExact(T value)

Returns a value that is (this + value).

参数:

value - the amount to be added to this value

返回:

this + value

抛出:

ArithmeticException - if the result of the addition overflows

add

T add(long value)

Returns a value that is (this + value).

参数:

value - The amount to be added to this value.

返回:

this + value

addExact

default T addExact(long value)

Returns a value that is (this + value).

参数:

value - the amount to be added to this value

返回:

this + value

抛出:

ArithmeticException - if the result of the addition overflows

addMod

T addMod(T value,
         UInt256 modulus)

Returns a value equivalent to ((this + value) mod modulus).

参数:

value - The amount to be added to this value.

modulus - The modulus.

返回:

(this + value) mod modulus

抛出:

ArithmeticException - modulus == 0.

addMod

T addMod(long value,
         UInt256 modulus)

Returns a value equivalent to ((this + value) mod modulus).

参数:

value - The amount to be added to this value.

modulus - The modulus.

返回:

(this + value) mod modulus

抛出:

ArithmeticException - modulus == 0.

addMod

T addMod(long value,
         long modulus)

Returns a value equivalent to ((this + value) mod modulus).

参数:

value - The amount to be added to this value.

modulus - The modulus.

返回:

(this + value) mod modulus

抛出:

ArithmeticException - modulus ≤ 0.

subtract

T subtract(T value)

Returns a value that is (this - value).

参数:

value - The amount to be subtracted from this value.

返回:

this - value

subtractExact

default T subtractExact(T value)

Returns a value that is (this - value).

参数:

value - the amount to be subtracted to this value

返回:

this - value

抛出:

ArithmeticException - if the result of the addition overflows

subtract

T subtract(long value)

Returns a value that is (this - value).

参数:

value - The amount to be subtracted from this value.

返回:

this - value

subtractExact

default T subtractExact(long value)

Returns a value that is (this - value).

参数:

value - the amount to be subtracted to this value

返回:

this - value

抛出:

ArithmeticException - if the result of the addition overflows

multiply

T multiply(T value)

Returns a value that is (this * value).

参数:

value - The amount to multiply this value by.

返回:

this * value

multiply

T multiply(long value)

Returns a value that is (this * value).

参数:

value - The amount to multiply this value by.

返回:

this * value

抛出:

ArithmeticException - value < 0.

multiplyMod

T multiplyMod(T value,
              UInt256 modulus)

Returns a value that is ((this * value) mod modulus).

参数:

value - The amount to multiply this value by.

modulus - The modulus.

返回:

(this * value) mod modulus

抛出:

ArithmeticException - value < 0 or modulus == 0.

multiplyMod

T multiplyMod(long value,
              UInt256 modulus)

Returns a value that is ((this * value) mod modulus).

参数:

value - The amount to multiply this value by.

modulus - The modulus.

返回:

(this * value) mod modulus

抛出:

ArithmeticException - value < 0 or modulus == 0.

multiplyMod

T multiplyMod(long value,
              long modulus)

Returns a value that is ((this * value) mod modulus).

参数:

value - The amount to multiply this value by.

modulus - The modulus.

返回:

(this * value) mod modulus

抛出:

ArithmeticException - value < 0 or modulus ≤ 0.

divide

T divide(T value)

Returns a value that is (this / value).

参数:

value - The amount to divide this value by.

返回:

this / value

抛出:

ArithmeticException - value == 0.

divide

T divide(long value)

Returns a value that is (this / value).

参数:

value - The amount to divide this value by.

返回:

this / value

抛出:

ArithmeticException - value ≤ 0.

divideCeil

T divideCeil(T value)

Returns a value that is ceiling(this / value).

参数:

value - The amount to divide this value by.

返回:

this / value + ( this % value == 0 ? 0 : 1)

抛出:

ArithmeticException - value == 0.

divideCeil

T divideCeil(long value)

Returns a value that is ceiling(this / value).

参数:

value - The amount to divide this value by.

返回:

this / value + ( this % value == 0 ? 0 : 1)

抛出:

ArithmeticException - value == 0.

pow

T pow(UInt256 exponent)

Returns a value that is (this<sup>exponent</sup> mod 2<sup>256</sup>)

This calculates an exponentiation over the modulus of 2^256.

Note that exponent is an UInt256 rather than of the type T.

参数:

exponent - The exponent to which this value is to be raised.

返回:

this<sup>exponent</sup> mod 2<sup>256</sup>

pow

T pow(long exponent)

Returns a value that is (this<sup>exponent</sup> mod 2<sup>256</sup>)

This calculates an exponentiation over the modulus of 2^256.

参数:

exponent - The exponent to which this value is to be raised.

返回:

this<sup>exponent</sup> mod 2<sup>256</sup>

mod

T mod(UInt256 modulus)

Returns a value that is (this mod modulus).

参数:

modulus - The modulus.

返回:

this mod modulus.

抛出:

ArithmeticException - modulus == 0.

mod

T mod(long modulus)

Returns a value that is (this mod modulus).

参数:

modulus - The modulus.

返回:

this mod modulus.

抛出:

ArithmeticException - modulus ≤ 0.

mod0

T mod0(UInt256 modulus)

Returns a value that is (this mod modulus), or 0 if modulus is 0.

参数:

modulus - The modulus.

返回:

this mod modulus.

mod0

T mod0(long modulus)

Returns a value that is (this mod modulus), or 0 if modulus is 0.

参数:

modulus - The modulus.

返回:

this mod modulus.

fitsInt

default boolean fitsInt()

Returns true if the value can fit in an int.

返回:

True if this value fits a java int (i.e. is less or equal to Integer.MAX_VALUE).

intValue

default int intValue()

Provides this value as an int.

返回:

This value as a java int assuming it is small enough to fit an int.

抛出:

ArithmeticException - If the value does not fit an int, that is if !fitsInt().

fitsLong

default boolean fitsLong()

Returns true if the value can fit in a long.

返回:

True if this value fits a java long (i.e. is less or equal to Long.MAX_VALUE).

toLong

default long toLong()

Provides the value as a long.

返回:

This value as a java long assuming it is small enough to fit a long.

抛出:

ArithmeticException - If the value does not fit a long, that is if !fitsLong().

toBigInteger

default BigInteger toBigInteger()

Provides the value as a BigInteger.

返回:

This value as a BigInteger.

toHexString

default String toHexString()

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().

返回:

This value represented as an hexadecimal string.

toShortHexString

default String toShortHexString()

Returns this value represented as a minimal hexadecimal string (without any leading zero)

返回:

This value represented as a minimal hexadecimal string (without any leading zero).

toUInt256

UInt256 toUInt256()

Convert this value to a UInt256.

返回:

This value as a UInt256.

toBytes

Bytes32 toBytes()

Provides the value as bytes.

返回:

The value as bytes.

toMinimalBytes

Bytes toMinimalBytes()

Provides the value as bytes without any leading zero bytes.

返回:

The value as bytes without any leading zero bytes.

numberOfLeadingZeros

default int numberOfLeadingZeros()

Provides the number of zero bits preceding the highest-order one-bit.

返回:

the number of zero bits preceding the highest-order ("leftmost") one-bit in the binary representation of this value, or 256 if the value is equal to zero.

bitLength

default int bitLength()

Provides the number of bits following and including the highest-order ("leftmost") one-bit in the binary representation of this value, or zero if all bits are zero.

返回:

The number of bits following and including the highest-order ("leftmost") one-bit in the binary representation of this value, or zero if all bits are zero.