Package org.apache.tuweni.units.bigints

Interface UInt384Value<T extends UInt384Value<T>>

Type Parameters:
T - The concrete type of the value.
All Superinterfaces:
Comparable<T>
All Known Implementing Classes:
BaseUInt384Value, UInt384
public interface UInt384Value<T extends UInt384Value<T>> extends Comparable<T>
Represents a 384-bit (48 bytes) unsigned integer value.

A UInt384Value is an unsigned integer value stored with 48 bytes, so whose value can range between 0 and 2^384-1.

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

Where only a pure numerical 384-bit value is required, UInt384 should be used.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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, UInt384 modulus)
    Returns a value equivalent to ((this + value) mod modulus).
    T
    addMod(T value, UInt384 modulus)
    Returns a value equivalent to ((this + value) mod modulus).
    default int
    bitLength()
    Returns the number of bits following and including the highest-order ("leftmost") one-bit
    T
    divide(long value)
    Returns a value that is (this / value).
    T
    divide(T value)
    Returns a value that is (this / value).
    default boolean
    fitsInt()
    Returns true if this value fits an int
    default boolean
    fitsLong()
    Returns true if this value fits in a long.
    default int
    intValue()
    Returns the value as an int.
    default boolean
    isZero()
    Returns true is this is 0.
    T
    mod(long modulus)
    Returns a value that is (this mod modulus).
    T
    mod(UInt384 modulus)
    Returns a value that is (this mod modulus).
    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, UInt384 modulus)
    Returns a value that is ((this * value) mod modulus).
    T
    multiplyMod(T value, UInt384 modulus)
    Returns a value that is ((this * value) mod modulus).
    default int
    numberOfLeadingZeros()
    Returns the number of zero bits preceding the highest-order ("leftmost") one-bit
    T
    pow(long exponent)
    Returns a value that is (this<sup>exponent</sup> mod 2<sup>384</sup>)
    T
    pow(UInt384 exponent)
    Returns a value that is (this<sup>exponent</sup> mod 2<sup>384</sup>)
    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()
    Returns this value as a BigInteger.
    org.apache.tuweni.bytes.Bytes48
    toBytes()
    Returns the value as bytes
    default String
    toDecimalString()
    Returns the decimal representation of this value as a String.
    default String
    toHexString()
    This value represented as an hexadecimal string.
    default long
    toLong()
    Returns this value as a long.
    org.apache.tuweni.bytes.Bytes
    toMinimalBytes()
    Retuns 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).
    UInt384
    toUInt384()
    Convert this value to a UInt384.

    Methods inherited from interface java.lang.Comparable

    compareTo

  • Method Details

    • isZero

      default boolean isZero()
      Returns true is this is 0.
      Returns:
      True if this is the value 0.

    • add

      T add(T value)
      Returns a value that is (this + value).
      Parameters:
      value - The amount to be added to this value.
      Returns:
      this + value

    • addExact

      default T addExact(T value)
      Returns a value that is (this + value).
      Parameters:
      value - the amount to be added to this value
      Returns:
      this + value
      Throws:
      ArithmeticException - if the result of the addition overflows

    • add

      T add(long value)
      Returns a value that is (this + value).
      Parameters:
      value - The amount to be added to this value.
      Returns:
      this + value

    • addExact

      default T addExact(long value)
      Returns a value that is (this + value).
      Parameters:
      value - the amount to be added to this value
      Returns:
      this + value
      Throws:
      ArithmeticException - if the result of the addition overflows

    • addMod

      T addMod(T value, UInt384 modulus)
      Returns a value equivalent to ((this + value) mod modulus).
      Parameters:
      value - The amount to be added to this value.
      modulus - The modulus.
      Returns:
      (this + value) mod modulus
      Throws:
      ArithmeticException - modulus == 0.

    • addMod

      T addMod(long value, UInt384 modulus)
      Returns a value equivalent to ((this + value) mod modulus).
      Parameters:
      value - The amount to be added to this value.
      modulus - The modulus.
      Returns:
      (this + value) mod modulus
      Throws:
      ArithmeticException - modulus == 0.

    • addMod

      T addMod(long value, long modulus)
      Returns a value equivalent to ((this + value) mod modulus).
      Parameters:
      value - The amount to be added to this value.
      modulus - The modulus.
      Returns:
      (this + value) mod modulus
      Throws:
      ArithmeticException - modulus ≤ 0.

    • subtract

      T subtract(T value)
      Returns a value that is (this - value).
      Parameters:
      value - The amount to be subtracted from this value.
      Returns:
      this - value

    • subtractExact

      default T subtractExact(T value)
      Returns a value that is (this - value).
      Parameters:
      value - the amount to be subtracted to this value
      Returns:
      this - value
      Throws:
      ArithmeticException - if the result of the addition overflows

    • subtract

      T subtract(long value)
      Returns a value that is (this - value).
      Parameters:
      value - The amount to be subtracted from this value.
      Returns:
      this - value

    • subtractExact

      default T subtractExact(long value)
      Returns a value that is (this - value).
      Parameters:
      value - the amount to be subtracted to this value
      Returns:
      this - value
      Throws:
      ArithmeticException - if the result of the addition overflows

    • multiply

      T multiply(T value)
      Returns a value that is (this * value).
      Parameters:
      value - The amount to multiply this value by.
      Returns:
      this * value

    • multiply

      T multiply(long value)
      Returns a value that is (this * value).
      Parameters:
      value - The amount to multiply this value by.
      Returns:
      this * value
      Throws:
      ArithmeticException - value < 0.

    • multiplyMod

      T multiplyMod(T value, UInt384 modulus)
      Returns a value that is ((this * value) mod modulus).
      Parameters:
      value - The amount to multiply this value by.
      modulus - The modulus.
      Returns:
      (this * value) mod modulus
      Throws:
      ArithmeticException - value < 0 or modulus == 0.

    • multiplyMod

      T multiplyMod(long value, UInt384 modulus)
      Returns a value that is ((this * value) mod modulus).
      Parameters:
      value - The amount to multiply this value by.
      modulus - The modulus.
      Returns:
      (this * value) mod modulus
      Throws:
      ArithmeticException - value < 0 or modulus == 0.

    • multiplyMod

      T multiplyMod(long value, long modulus)
      Returns a value that is ((this * value) mod modulus).
      Parameters:
      value - The amount to multiply this value by.
      modulus - The modulus.
      Returns:
      (this * value) mod modulus
      Throws:
      ArithmeticException - value < 0 or modulus ≤ 0.

    • divide

      T divide(T value)
      Returns a value that is (this / value).
      Parameters:
      value - The amount to divide this value by.
      Returns:
      this / value
      Throws:
      ArithmeticException - value == 0.

    • divide

      T divide(long value)
      Returns a value that is (this / value).
      Parameters:
      value - The amount to divide this value by.
      Returns:
      this / value
      Throws:
      ArithmeticException - value ≤ 0.

    • pow

      T pow(UInt384 exponent)
      Returns a value that is (this<sup>exponent</sup> mod 2<sup>384</sup>)

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

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

      Parameters:
      exponent - The exponent to which this value is to be raised.
      Returns:
      this<sup>exponent</sup> mod 2<sup>384</sup>

    • pow

      T pow(long exponent)
      Returns a value that is (this<sup>exponent</sup> mod 2<sup>384</sup>)

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

      Parameters:
      exponent - The exponent to which this value is to be raised.
      Returns:
      this<sup>exponent</sup> mod 2<sup>384</sup>

    • mod

      T mod(UInt384 modulus)
      Returns a value that is (this mod modulus).
      Parameters:
      modulus - The modulus.
      Returns:
      this mod modulus.
      Throws:
      ArithmeticException - modulus == 0.

    • mod

      T mod(long modulus)
      Returns a value that is (this mod modulus).
      Parameters:
      modulus - The modulus.
      Returns:
      this mod modulus.
      Throws:
      ArithmeticException - modulus ≤ 0.

    • fitsInt

      default boolean fitsInt()
      Returns true if this value fits an int
      Returns:
      True if this value fits a java int (i.e. is less or equal to Integer.MAX_VALUE).

    • intValue

      default int intValue()
      Returns the value as an int.
      Returns:
      This value as a java int assuming it is small enough to fit an int.
      Throws:
      ArithmeticException - If the value does not fit an int, that is if !fitsInt().

    • fitsLong

      default boolean fitsLong()
      Returns true if this value fits in a long.
      Returns:
      True if this value fits a java long (i.e. is less or equal to Long.MAX_VALUE).

    • toLong

      default long toLong()
      Returns this value as a long.
      Returns:
      This value as a java long assuming it is small enough to fit a long.
      Throws:
      ArithmeticException - If the value does not fit a long, that is if !fitsLong().

    • toBigInteger

      default BigInteger toBigInteger()
      Returns this value as a BigInteger.
      Returns:
      This value as a BigInteger.

    • toHexString

      default String toHexString()
      This value represented as an hexadecimal string.

      Note that this representation includes all the 48 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().

      Returns:
      This value represented as an hexadecimal string.

    • toShortHexString

      default String toShortHexString()
      Returns this value represented as a minimal hexadecimal string (without any leading zero).
      Returns:
      This value represented as a minimal hexadecimal string (without any leading zero).

    • toUInt384

      UInt384 toUInt384()
      Convert this value to a UInt384.
      Returns:
      This value as a UInt384.

    • toBytes

      org.apache.tuweni.bytes.Bytes48 toBytes()
      Returns the value as bytes
      Returns:
      The value as bytes.

    • toMinimalBytes

      org.apache.tuweni.bytes.Bytes toMinimalBytes()
      Retuns the value as bytes without any leading zero bytes.
      Returns:
      The value as bytes without any leading zero bytes.

    • numberOfLeadingZeros

      default int numberOfLeadingZeros()
      Returns the number of zero bits preceding the highest-order ("leftmost") one-bit
      Returns:
      the number of zero bits preceding the highest-order ("leftmost") one-bit in the binary representation of this value, or 384 if the value is equal to zero.

    • bitLength

      default int bitLength()
      Returns the number of bits following and including the highest-order ("leftmost") one-bit
      Returns:
      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.

    • toDecimalString

      default String toDecimalString()
      Returns the decimal representation of this value as a String.
      Returns:
      the decimal representation of this value as a String.