UInt256 (radixdlt-java abt-218-g3b993a7-SNAPSHOT API)

java.lang.Object
- org.radix.utils.UInt256

All Implemented Interfaces:

java.lang.Comparable<UInt256>
```
public final class UInt256
extends java.lang.Object
implements java.lang.Comparable<UInt256>
```
A 256-bit signed integer, with comparison and some basic arithmetic operations.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTES` Size of this numeric type in bytes.
`static UInt256`	`EIGHT`
`static UInt256`	`FIVE`
`static UInt256`	`FOUR`
`static UInt256`	`MAX_VALUE` A constant holding the maximum value an `Int256` can have, 2²⁵⁵-1.
`static UInt256`	`MIN_VALUE` A constant holding the minimum value an `Int256` can have, -2²⁵⁵.
`static UInt256`	`NINE`
`static UInt256`	`ONE`
`static UInt256`	`SEVEN`
`static UInt256`	`SIX`
`static int`	`SIZE` Size of this numeric type in bits.
`static UInt256`	`TEN`
`static UInt256`	`THREE`
`static UInt256`	`TWO`
`static UInt256`	`ZERO`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UInt256`	`add(UInt256 other)` Adds `other` to `this`, returning the result.
`UInt256`	`and(UInt256 other)` Calculates the bitwise and of `this` with `other` (`this & other`).
`int`	`compareTo(UInt256 n)`
`UInt256`	`decrement()` Decrements `this`.
`UInt256`	`divide(UInt256 divisor)` Divides `this` by the specified divisor.
`boolean`	`equals(java.lang.Object obj)`
`static UInt256`	`from(byte[] bytes)` Factory method for materialising an `UInt256` from an array of bytes.
`static UInt256`	`from(byte[] bytes, int offset)` Factory method for materialising an `UInt256` from an array of bytes.
`static UInt256`	`from(int value)` Factory method for materialising an `UInt256` from an `int` value.
`static UInt256`	`from(Int128 value)` Factory method for materialising an `UInt256` from an `Int128` value.
`static UInt256`	`from(Int128 high, Int128 low)` Factory method for materialising an `UInt256` from an `Int128` value.
`static UInt256`	`from(long value)` Factory method for materialising an `UInt256` from a `long` value.
`static UInt256`	`from(short value)` Factory method for materialising an `UInt256` from a `short` value.
`static UInt256`	`from(java.lang.String s)` Factory method for materialising an `UInt256` from a string.
`Int128`	`getHigh()` Returns the most significant word.
`Int128`	`getLow()` Returns the least significant word.
`int`	`hashCode()`
`UInt256`	`increment()` Increments `this`.
`UInt256`	`invert()` Returns the value of `~this`.
`boolean`	`isEven()` Returns `true` if `this` is an even number.
`boolean`	`isOdd()` Returns `true` if `this` is an odd number.
`boolean`	`isZero()` Returns `true` if `this` is zero.
`UInt256`	`multiply(UInt256 multiplicand)` Multiplies `this` by the specified multiplicand.
`int`	`numberOfLeadingZeros()` Returns the number of zero bits preceding the highest-order ("leftmost") one-bit in the two's complement binary representation of the specified `long` value.
`UInt256`	`or(UInt256 other)` Calculates the bitwise inclusive-or of `this` with `other` (`this \| other`).
`UInt256`	`pow(int exp)` Calculates `this`^exp.
`UInt256`	`remainder(UInt256 divisor)` Returns the remainder of the division of `this` by the specified divisor.
`UInt256`	`shiftLeft()` Shifts `this` left 1 bit.
`UInt256`	`shiftRight()` Shifts `this` right 1 bit.
`UInt256`	`subtract(UInt256 other)` Subtracts `other` from `this`, returning the result.
`byte[]`	`toByteArray()` Converts `this` to an array of bytes.
`byte[]`	`toByteArray(byte[] bytes, int offset)` Converts `this` to an array of bytes.
`java.lang.String`	`toString()`
`java.lang.String`	`toString(int radix)` Returns a string representation of this object in the specified radix.
`UInt256`	`xor(UInt256 other)` Calculates the exclusive-or of `this` with `other` (`this ^ other`).

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SIZE
```
public static final int SIZE
```
    Size of this numeric type in bits.
    
    See Also:
    
    Constant Field Values
  - BYTES
```
public static final int BYTES
```
    Size of this numeric type in bytes.
    
    See Also:
    
    Constant Field Values
  - MIN_VALUE
```
public static final UInt256 MIN_VALUE
```
    A constant holding the minimum value an Int256 can have, -2²⁵⁵.
  - MAX_VALUE
```
public static final UInt256 MAX_VALUE
```
    A constant holding the maximum value an Int256 can have, 2²⁵⁵-1.
  - ZERO
```
public static final UInt256 ZERO
```
  - ONE
```
public static final UInt256 ONE
```
  - TWO
```
public static final UInt256 TWO
```
  - THREE
```
public static final UInt256 THREE
```
  - FOUR
```
public static final UInt256 FOUR
```
  - FIVE
```
public static final UInt256 FIVE
```
  - SIX
```
public static final UInt256 SIX
```
  - SEVEN
```
public static final UInt256 SEVEN
```
  - EIGHT
```
public static final UInt256 EIGHT
```
  - NINE
```
public static final UInt256 NINE
```
  - TEN
```
public static final UInt256 TEN
```
- Method Detail
  - from
```
public static UInt256 from(short value)
```
    Factory method for materialising an UInt256 from a short value.
    
    Parameters:
    
    value - The value to be represented as an UInt256.
    
    Returns:
    
    value as an UInt256 type.
  - from
```
public static UInt256 from(int value)
```
    Factory method for materialising an UInt256 from an int value.
    
    Parameters:
    
    value - The value to be represented as an UInt256.
    
    Returns:
    
    value as an UInt256 type.
  - from
```
public static UInt256 from(long value)
```
    Factory method for materialising an UInt256 from a long value. Note that values are sign extended into the 256 bit value.
    
    Parameters:
    
    value - The value to be represented as an UInt256.
    
    Returns:
    
    value as an UInt256 type.
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is negative
  - from
```
public static UInt256 from(Int128 value)
```
    Factory method for materialising an UInt256 from an Int128 value.
    
    Parameters:
    
    value - The least significant word of the value.
    
    Returns:
    
    the specified value as an UInt256 type.
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is negative
  - from
```
public static UInt256 from(Int128 high,
                           Int128 low)
```
    Factory method for materialising an UInt256 from an Int128 value.
    Note that the value of high is treated as an unsigned value.
    
    Parameters:
    
    high - The most significant word of the value.
    
    low - The least significant word of the value.
    
    Returns:
    
    the specified values as an UInt256 type.
  - from
```
public static UInt256 from(byte[] bytes)
```
    Factory method for materialising an UInt256 from an array of bytes. The array is most-significant byte first, and must not be zero length.
    If the array is smaller than BYTES, then it is effectively padded with leading bytes with the correct sign.
    If the array is longer than BYTES, then values at index BYTES and beyond are ignored.
    
    Parameters:
    
    bytes - The array of bytes to be used.
    
    Returns:
    
    bytes as an UInt256 type.
    
    Throws:
    
    java.lang.IllegalArgumentException - if bytes is 0 length.
    
    See Also:
    
    toByteArray()
  - from
```
public static UInt256 from(byte[] bytes,
                           int offset)
```
    Factory method for materialising an UInt256 from an array of bytes. The array is most-significant byte first.
    
    Parameters:
    
    bytes - The array of bytes to be used.
    
    offset - The offset within the array to be used.
    
    Returns:
    
    bytes from offset as an UInt256 type.
    
    See Also:
    
    toByteArray()
  - from
```
public static UInt256 from(java.lang.String s)
```
    Factory method for materialising an UInt256 from a string. Conversion is performed base 10 and leading sign characters are permitted.
    
    Parameters:
    
    s - The array of bytes to be used.
    
    Returns:
    
    s as an UInt256 type.
    
    Throws:
    
    java.lang.NumberFormatException - if s is not a valid integer number.
  - toByteArray
```
public byte[] toByteArray()
```
    Converts this to an array of bytes. The most significant byte will be returned in index zero. The array will always be BYTES bytes long, and will be zero filled to suit the actual value.
    
    Returns:
    
    An array of BYTES bytes representing the value of this UInt256.
  - toByteArray
```
public byte[] toByteArray(byte[] bytes,
                          int offset)
```
    Converts this to an array of bytes. The most significant byte will be returned in index offset. The array must be at least offset + BYTES long.
    
    Parameters:
    
    bytes - The array to place the bytes in.
    
    offset - The offset within the array to place the bytes.
    
    Returns:
    
    The passed-in value of bytes.
  - add
```
public UInt256 add(UInt256 other)
```
    Adds other to this, returning the result.
    
    Parameters:
    
    other - The addend.
    
    Returns:
    
    An UInt256 with the value this + other.
  - subtract
```
public UInt256 subtract(UInt256 other)
```
    Subtracts other from this, returning the result.
    
    Parameters:
    
    other - The subtrahend.
    
    Returns:
    
    An UInt256 with the value this - other.
  - increment
```
public UInt256 increment()
```
    Increments this. Equivalent to this.add(Int256.ONE), but faster.
    
    Returns:
    
    This number incremented by one.
  - decrement
```
public UInt256 decrement()
```
    Decrements this. Equivalent to this.subtract(Int256.ONE), but faster.
    
    Returns:
    
    This number decremented by one.
  - multiply
```
public UInt256 multiply(UInt256 multiplicand)
```
    Multiplies this by the specified multiplicand.
    
    Parameters:
    
    multiplicand - The multiplicand to multiply this by.
    
    Returns:
    
    The result this * multiplicand.
  - divide
```
public UInt256 divide(UInt256 divisor)
```
    Divides this by the specified divisor.
    
    Parameters:
    
    divisor - The divisor to divide this by.
    
    Returns:
    
    The result floor(this / divisor).
    
    Throws:
    
    java.lang.IllegalArgumentException - if divisor is zero
  - remainder
```
public UInt256 remainder(UInt256 divisor)
```
    Returns the remainder of the division of this by the specified divisor.
    
    Parameters:
    
    divisor - The divisor to divide this by.
    
    Returns:
    
    The remainder of the division this / divisor.
  - pow
```
public UInt256 pow(int exp)
```
    Calculates this^exp.
    
    Parameters:
    
    exp - the exponent to raise this to
    
    Returns:
    
    this^exp
  - shiftLeft
```
public UInt256 shiftLeft()
```
    Shifts this left 1 bit. A zero bit is moved into the leftmost bit.
    
    Returns:
    
    The result of shifting this left one bit.
  - shiftRight
```
public UInt256 shiftRight()
```
    Shifts this right 1 bit. A zero bit is moved into the into the rightmost bit.
    
    Returns:
    
    The result of arithmetic shifting this right one bit.
  - invert
```
public UInt256 invert()
```
    Returns the value of ~this.
    
    Returns:
    
    The logical inverse of this.
  - compareTo
```
public int compareTo(UInt256 n)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<UInt256>
  - getHigh
```
public Int128 getHigh()
```
    Returns the most significant word.
    
    Returns:
    
    the most significant word.
  - getLow
```
public Int128 getLow()
```
    Returns the least significant word.
    
    Returns:
    
    the least significant word.
  - or
```
public UInt256 or(UInt256 other)
```
    Calculates the bitwise inclusive-or of this with other (this | other).
    
    Parameters:
    
    other - The value to inclusive-or with this.
    
    Returns:
    
    this | other
  - and
```
public UInt256 and(UInt256 other)
```
    Calculates the bitwise and of this with other (this & other).
    
    Parameters:
    
    other - The value to and with this.
    
    Returns:
    
    this & other
  - xor
```
public UInt256 xor(UInt256 other)
```
    Calculates the exclusive-or of this with other (this ^ other).
    
    Parameters:
    
    other - The value to exclusive-or with this.
    
    Returns:
    
    this ^ other
  - numberOfLeadingZeros
```
public int numberOfLeadingZeros()
```
    Returns the number of zero bits preceding the highest-order ("leftmost") one-bit in the two's complement binary representation of the specified long value. Returns 128 if the specified value has no one-bits in its two's complement representation, in other words if it is equal to zero.
    Note that this method is closely related to the logarithm base 2. For all positive long values x:
    - floor(log₂(x)) = 255 - numberOfLeadingZeros(x)
    - ceil(log₂(x)) = 256 - numberOfLeadingZeros(x - 1)
    Returns:
    
    the number of zero bits preceding the highest-order ("leftmost") one-bit in the two's complement binary representation of the specified long value, or 256 if the value is equal to zero.
  - isZero
```
public boolean isZero()
```
    Returns true if this is zero.
    
    Returns:
    
    true if this is zero.
  - isEven
```
public boolean isEven()
```
    Returns true if this is an even number.
    
    Returns:
    
    true if this is an even number.
  - isOdd
```
public boolean isOdd()
```
    Returns true if this is an odd number.
    
    Returns:
    
    true if this is an odd number.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(int radix)
```
    Returns a string representation of this object in the specified radix.
    If the radix is smaller than Character.MIN_RADIX or larger than Character.MAX_RADIX, an IllegalArgumentException is thrown.
    The characters of the result represent the magnitude of this. If the magnitude is zero, it is represented by a single zero character '0'; otherwise no leading zeros are output.
    The following ASCII characters are used as digits:
    0123456789abcdefghijklmnopqrstuvwxyz
    If radix is N, then the first N of these characters are used as radix-N digits in the order shown, i.e. the digits for hexadecimal (radix 16) are 0123456789abcdef.
    
    Parameters:
    
    radix - the radix to use in the string representation.
    
    Returns:
    
    a string representation of the argument in the specified radix.
    
    Throws:
    
    java.lang.IllegalArgumentException - if radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX.
    
    See Also:
    
    Character.MAX_RADIX, Character.MIN_RADIX

Class UInt256

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIZE

BYTES

MIN_VALUE

MAX_VALUE

ZERO

ONE

TWO

THREE

FOUR

FIVE

SIX

SEVEN

EIGHT

NINE

TEN

Method Detail

from

from

from

from

from

from

from

from

toByteArray

toByteArray

add

subtract

increment

decrement

multiply

divide

remainder

pow

shiftLeft

shiftRight

invert

compareTo

getHigh

getLow

or

and

xor

numberOfLeadingZeros

isZero

isEven

isOdd

hashCode

equals

toString

toString