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

java.lang.Object
- java.lang.Number
- - org.radix.utils.Int128

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Int128>
```
public final class Int128
extends java.lang.Number
implements java.lang.Comparable<Int128>
```
A 128-bit signed integer, with comparison and some basic arithmetic operations.

See Also:

Serialized Form

Field Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Int128`	`abs()` Return the absolute value of `this`.
`Int128`	`add(Int128 other)` Add `other` to `this`, returning the result.
`Int128`	`and(Int128 other)` Calculates the bitwise and of `this` with `other` (`this & other`).
`int`	`compareTo(Int128 n)`
`int`	`compareToUnsigned(Int128 n)` Compares `this` and `n` numerically treating the values as unsigned.
`Int128`	`decrement()` Decrement a number.
`Int128`	`div2()` Similar to `shiftRight()`, but rounds towards zero.
`Int128`	`divide(Int128 divisor)` Divide `this` by the specified divisor.
`double`	`doubleValue()`
`boolean`	`equals(java.lang.Object obj)`
`float`	`floatValue()`
`static Int128`	`from(byte[] bytes)` Factory method for materialising an `Int128` from an array of bytes.
`static Int128`	`from(byte[] bytes, int offset)` Factory method for materialising an `Int128` from an array of bytes.
`static Int128`	`from(int value)` Factory method for materialising an `Int128` from an `int` value.
`static Int128`	`from(long value)` Factory method for materialising an `Int128` from a `long` value.
`static Int128`	`from(long high, long low)` Factory method for materialising an `Int128` from two `long` values.
`static Int128`	`from(short value)` Factory method for materialising an `Int128` from a `short` value.
`static Int128`	`from(java.lang.String s)` Factory method for materialising an `Int128` from a string.
`long`	`getHigh()` Return the most significant word.
`long`	`getLow()` Return the least significant word.
`int`	`hashCode()`
`Int128`	`increment()` Increment a number.
`int`	`intValue()`
`Int128`	`invert()` Return the value of `~this`.
`boolean`	`isEven()` Return `true` if `this` is an even number.
`boolean`	`isNegative()` Return `true` if the `Int128` is negative.
`boolean`	`isOdd()` Return `true` if `this` is an odd number.
`boolean`	`isZero()` Return `true` if `this` is zero.
`Int128`	`logicalShiftRight()` Logical shift `this` right 1 bit.
`long`	`longValue()`
`Int128`	`multiply(Int128 multiplicand)` Multiply `this` by the specified multiplicand.
`Int128`	`negate()` Return the value of `0 - this`.
`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.
`Int128`	`or(Int128 other)` Calculates the bitwise inclusive-or of `this` with `other` (`this \| other`).
`Int128`	`remainder(Int128 divisor)` Return the remainder of the division of `this` by the specified divisor.
`Int128`	`shiftLeft()` Shift `this` left 1 bit.
`Int128`	`shiftRight()` Arithmetic shift `this` right 1 bit.
`Int128`	`subtract(Int128 other)` Subtract `other` from `this`, returning the result.
`byte[]`	`toByteArray()` Convert value to an array of bytes.
`byte[]`	`toByteArray(byte[] bytes, int offset)` Convert value to an array of bytes.
`java.lang.String`	`toString()`
`Int128`	`xor(Int128 other)` Calculates the exclusive-or of `this` with `other` (`this ^ other`).

Methods inherited from class java.lang.Number
byteValue, shortValue

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 Int128 MIN_VALUE
```
    A constant holding the minimum value an Int128 can have, -2¹²⁷.
  - MAX_VALUE
```
public static final Int128 MAX_VALUE
```
    A constant holding the maximum value an Int128 can have, 2¹²⁷-1.
  - ZERO
```
public static final Int128 ZERO
```
  - ONE
```
public static final Int128 ONE
```
  - TWO
```
public static final Int128 TWO
```
  - THREE
```
public static final Int128 THREE
```
  - FOUR
```
public static final Int128 FOUR
```
  - FIVE
```
public static final Int128 FIVE
```
  - SIX
```
public static final Int128 SIX
```
  - SEVEN
```
public static final Int128 SEVEN
```
  - EIGHT
```
public static final Int128 EIGHT
```
  - NINE
```
public static final Int128 NINE
```
  - TEN
```
public static final Int128 TEN
```
  - MINUS_ONE
```
public static final Int128 MINUS_ONE
```
- Method Detail
  - from
```
public static Int128 from(short value)
```
    Factory method for materialising an Int128 from a short value.
    
    Parameters:
    
    value - The value to be represented as an Int128.
    
    Returns:
    
    value as an Int128 type.
  - from
```
public static Int128 from(int value)
```
    Factory method for materialising an Int128 from an int value.
    
    Parameters:
    
    value - The value to be represented as an Int128.
    
    Returns:
    
    value as an Int128 type.
  - from
```
public static Int128 from(long value)
```
    Factory method for materialising an Int128 from a long value. Note that values are sign extended into the 128 bit value.
    
    Parameters:
    
    value - The value to be represented as an Int128.
    
    Returns:
    
    value as an Int128 type.
  - from
```
public static Int128 from(long high,
                          long low)
```
    Factory method for materialising an Int128 from two long values. high is the most significant word, and low the least significant.
    
    Parameters:
    
    high - The most significant word of the 128 bit value.
    
    low - The least significant word of the 128 bit value.
    
    Returns:
    
    (high << 64) | low as an Int128 type.
  - from
```
public static Int128 from(byte[] bytes)
```
    Factory method for materialising an Int128 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 Int128 type.
    
    Throws:
    
    java.lang.IllegalArgumentException - if bytes is 0 length.
    
    See Also:
    
    toByteArray()
  - from
```
public static Int128 from(byte[] bytes,
                          int offset)
```
    Factory method for materialising an Int128 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 Int128 type.
    
    See Also:
    
    toByteArray()
  - from
```
public static Int128 from(java.lang.String s)
```
    Factory method for materialising an Int128 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 Int128 type.
    
    Throws:
    
    java.lang.NumberFormatException - if s is not a valid integer number.
  - toByteArray
```
public byte[] toByteArray()
```
    Convert value 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 Int128.
  - toByteArray
```
public byte[] toByteArray(byte[] bytes,
                          int offset)
```
    Convert value 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 Int128 add(Int128 other)
```
    Add other to this, returning the result.
    
    Parameters:
    
    other - The addend.
    
    Returns:
    
    An Int128 with the value this + other.
  - subtract
```
public Int128 subtract(Int128 other)
```
    Subtract other from this, returning the result.
    
    Parameters:
    
    other - The subtrahend.
    
    Returns:
    
    An Int128 with the value this - other.
  - multiply
```
public Int128 multiply(Int128 multiplicand)
```
    Multiply this by the specified multiplicand.
    
    Parameters:
    
    multiplicand - The multiplicand to multiply this by.
    
    Returns:
    
    The result this * multiplicand.
  - increment
```
public Int128 increment()
```
    Increment a number. Equivalent to this.add(Int128.ONE), but faster.
    
    Returns:
    
    This number incremented by one.
  - decrement
```
public Int128 decrement()
```
    Decrement a number. Equivalent to this.subtract(Int128.ONE), but faster.
    
    Returns:
    
    This number decremented by one.
  - divide
```
public Int128 divide(Int128 divisor)
```
    Divide this by the specified divisor.
    
    Parameters:
    
    divisor - The divisor to divide this by.
    
    Returns:
    
    The result floor(this / divisor).
  - remainder
```
public Int128 remainder(Int128 divisor)
```
    Return 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.
  - shiftLeft
```
public Int128 shiftLeft()
```
    Shift this left 1 bit. A zero bit is moved into the leftmost bit.
    
    Returns:
    
    The result of shifting this left one bit.
  - shiftRight
```
public Int128 shiftRight()
```
    Arithmetic shift this right 1 bit. The current value of the sign bit is duplicated into the rightmost bit.
    
    Returns:
    
    The result of arithmetic shifting this right one bit.
  - logicalShiftRight
```
public Int128 logicalShiftRight()
```
    Logical shift this right 1 bit. Zeros are shifted into the rightmost bit.
    
    Returns:
    
    The result of logical shifting this right one bit.
  - div2
```
public Int128 div2()
```
    Similar to shiftRight(), but rounds towards zero.
    
    Returns:
    
    The result of calculating this / 2.
  - abs
```
public Int128 abs()
```
    Return the absolute value of this.
    Note that, similarly to other two's complement numbers, the absolute value of the maximal negative value is returned as itself.
    
    Returns:
    
    The absolute value of this.
  - negate
```
public Int128 negate()
```
    Return the value of 0 - this.
    Note that, similarly to other two's complement numbers, the negative value of the maximal negative value is returned as itself.
    
    Returns:
    
    The negative value of this.
  - invert
```
public Int128 invert()
```
    Return the value of ~this.
    
    Returns:
    
    The logical inverse of this.
  - compareTo
```
public int compareTo(Int128 n)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Int128>
  - compareToUnsigned
```
public int compareToUnsigned(Int128 n)
```
    Compares this and n numerically treating the values as unsigned.
    
    Parameters:
    
    n - the second Int128 to compare.
    
    Returns:
    
    the value 0 if this == n; a value less than 0 if this < n as unsigned values; and a value greater than 0 if this > n as unsigned values
  - getHigh
```
public long getHigh()
```
    Return the most significant word.
    
    Returns:
    
    the most significant word.
  - getLow
```
public long getLow()
```
    Return the least significant word.
    
    Returns:
    
    the least significant word.
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class java.lang.Number
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class java.lang.Number
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class java.lang.Number
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class java.lang.Number
  - or
```
public Int128 or(Int128 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 Int128 and(Int128 other)
```
    Calculates the bitwise and of this with other (this & other).
    
    Parameters:
    
    other - The value to and with this.
    
    Returns:
    
    this & other
  - xor
```
public Int128 xor(Int128 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)) = 127 - numberOfLeadingZeros(x)
    - ceil(log₂(x)) = 128 - 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 128 if the value is equal to zero.
  - isNegative
```
public boolean isNegative()
```
    Return true if the Int128 is negative.
    
    Returns:
    
    true if the Int128 is negative.
  - isZero
```
public boolean isZero()
```
    Return true if this is zero.
    
    Returns:
    
    true if this is zero.
  - isEven
```
public boolean isEven()
```
    Return true if this is an even number.
    
    Returns:
    
    true if this is an even number.
  - isOdd
```
public boolean isOdd()
```
    Return 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

Class Int128

Field Summary

Method Summary

Methods inherited from class java.lang.Number

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

MINUS_ONE

Method Detail

from

from

from

from

from

from

from

toByteArray

toByteArray

add

subtract

multiply

increment

decrement

divide

remainder

shiftLeft

shiftRight

logicalShiftRight

div2

abs

negate

invert

compareTo

compareToUnsigned

getHigh

getLow

intValue

longValue

floatValue

doubleValue

or

and

xor

numberOfLeadingZeros

isNegative

isZero

isEven

isOdd

hashCode

equals

toString