Unsigned (Graal OpenJDK Project Documentation)

All Superinterfaces:

ComparableWord, TrustedInterface, WordBase

All Known Subinterfaces:

Pointer

All Known Implementing Classes:

HostedWord, Word
```
public interface Unsigned
extends ComparableWord
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`aboveOrEqual(int val)` Compares this Unsigned with the specified value.
`boolean`	`aboveOrEqual(Unsigned val)` Compares this Unsigned with the specified value.
`boolean`	`aboveThan(int val)` Compares this Unsigned with the specified value.
`boolean`	`aboveThan(Unsigned val)` Compares this Unsigned with the specified value.
`Unsigned`	`add(int val)` Returns a Unsigned whose value is `(this + val)`.
`Unsigned`	`add(Unsigned val)` Returns a Unsigned whose value is `(this + val)`.
`Unsigned`	`and(int val)` Returns a Unsigned whose value is `(this & val)`.
`Unsigned`	`and(Unsigned val)` Returns a Unsigned whose value is `(this & val)`.
`boolean`	`belowOrEqual(int val)` Compares this Unsigned with the specified value.
`boolean`	`belowOrEqual(Unsigned val)` Compares this Unsigned with the specified value.
`boolean`	`belowThan(int val)` Compares this Unsigned with the specified value.
`boolean`	`belowThan(Unsigned val)` Compares this Unsigned with the specified value.
`boolean`	`equal(int val)` Compares this Unsigned with the specified value.
`boolean`	`equal(Unsigned val)` Compares this Unsigned with the specified value.
`Unsigned`	`multiply(int val)` Returns a Unsigned whose value is `(this * val)`.
`Unsigned`	`multiply(Unsigned val)` Returns a Unsigned whose value is `(this * val)`.
`Unsigned`	`not()` Returns a Unsigned whose value is `(~this)`.
`boolean`	`notEqual(int val)` Compares this Unsigned with the specified value.
`boolean`	`notEqual(Unsigned val)` Compares this Unsigned with the specified value.
`Unsigned`	`or(int val)` Returns a Unsigned whose value is `(this \| val)`.
`Unsigned`	`or(Unsigned val)` Returns a Unsigned whose value is `(this \| val)`.
`Unsigned`	`shiftLeft(int n)` Returns a Unsigned whose value is `(this << n)`.
`Unsigned`	`shiftLeft(Unsigned n)` Returns a Unsigned whose value is `(this << n)`.
`Unsigned`	`subtract(int val)` Returns a Unsigned whose value is `(this - val)`.
`Unsigned`	`subtract(Unsigned val)` Returns a Unsigned whose value is `(this - val)`.
`Unsigned`	`unsignedDivide(int val)` Returns a Unsigned whose value is `(this / val)`.
`Unsigned`	`unsignedDivide(Unsigned val)` Returns a Unsigned whose value is `(this / val)`.
`Unsigned`	`unsignedRemainder(int val)` Returns a Unsigned whose value is `(this % val)`.
`Unsigned`	`unsignedRemainder(Unsigned val)` Returns a Unsigned whose value is `(this % val)`.
`Unsigned`	`unsignedShiftRight(int n)` Returns a Unsigned whose value is `(this >>> n)`.
`Unsigned`	`unsignedShiftRight(Unsigned n)` Returns a Unsigned whose value is `(this >>> n)`.
`Unsigned`	`xor(int val)` Returns a Unsigned whose value is `(this ^ val)`.
`Unsigned`	`xor(Unsigned val)` Returns a Unsigned whose value is `(this ^ val)`.

Methods inherited from interface com.oracle.graal.word.ComparableWord
equal, notEqual

Methods inherited from interface com.oracle.graal.word.WordBase
rawValue

- Method Detail
  - add
```
Unsigned add(Unsigned val)
```
    Returns a Unsigned whose value is (this + val).
    
    Parameters:
    
    val - value to be added to this Unsigned.
    
    Returns:
    
    this + val
  - subtract
```
Unsigned subtract(Unsigned val)
```
    Returns a Unsigned whose value is (this - val).
    
    Parameters:
    
    val - value to be subtracted from this Unsigned.
    
    Returns:
    
    this - val
  - multiply
```
Unsigned multiply(Unsigned val)
```
    Returns a Unsigned whose value is (this * val).
    
    Parameters:
    
    val - value to be multiplied by this Unsigned.
    
    Returns:
    
    this * val
  - unsignedDivide
```
Unsigned unsignedDivide(Unsigned val)
```
    Returns a Unsigned whose value is (this / val).
    
    Parameters:
    
    val - value by which this Unsigned is to be divided.
    
    Returns:
    
    this / val
  - unsignedRemainder
```
Unsigned unsignedRemainder(Unsigned val)
```
    Returns a Unsigned whose value is (this % val).
    
    Parameters:
    
    val - value by which this Unsigned is to be divided, and the remainder computed.
    
    Returns:
    
    this % val
  - shiftLeft
```
Unsigned shiftLeft(Unsigned n)
```
    Returns a Unsigned whose value is (this << n).
    
    Parameters:
    
    n - shift distance, in bits.
    
    Returns:
    
    this << n
  - unsignedShiftRight
```
Unsigned unsignedShiftRight(Unsigned n)
```
    Returns a Unsigned whose value is (this >>> n). No sign extension is performed.
    
    Parameters:
    
    n - shift distance, in bits.
    
    Returns:
    
    this >> n
  - and
```
Unsigned and(Unsigned val)
```
    Returns a Unsigned whose value is (this & val).
    
    Parameters:
    
    val - value to be AND'ed with this Unsigned.
    
    Returns:
    
    this & val
  - or
```
Unsigned or(Unsigned val)
```
    Returns a Unsigned whose value is (this | val).
    
    Parameters:
    
    val - value to be OR'ed with this Unsigned.
    
    Returns:
    
    this | val
  - xor
```
Unsigned xor(Unsigned val)
```
    Returns a Unsigned whose value is (this ^ val).
    
    Parameters:
    
    val - value to be XOR'ed with this Unsigned.
    
    Returns:
    
    this ^ val
  - not
```
Unsigned not()
```
    Returns a Unsigned whose value is (~this).
    
    Returns:
    
    ~this
  - equal
```
boolean equal(Unsigned val)
```
    Compares this Unsigned with the specified value.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this == val
  - notEqual
```
boolean notEqual(Unsigned val)
```
    Compares this Unsigned with the specified value.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this != val
  - belowThan
```
boolean belowThan(Unsigned val)
```
    Compares this Unsigned with the specified value.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this < val
  - belowOrEqual
```
boolean belowOrEqual(Unsigned val)
```
    Compares this Unsigned with the specified value.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this <= val
  - aboveThan
```
boolean aboveThan(Unsigned val)
```
    Compares this Unsigned with the specified value.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this > val
  - aboveOrEqual
```
boolean aboveOrEqual(Unsigned val)
```
    Compares this Unsigned with the specified value.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this >= val
  - add
```
Unsigned add(int val)
```
    Returns a Unsigned whose value is (this + val).
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to be added to this Unsigned.
    
    Returns:
    
    this + val
  - subtract
```
Unsigned subtract(int val)
```
    Returns a Unsigned whose value is (this - val).
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to be subtracted from this Unsigned.
    
    Returns:
    
    this - val
  - multiply
```
Unsigned multiply(int val)
```
    Returns a Unsigned whose value is (this * val).
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to be multiplied by this Unsigned.
    
    Returns:
    
    this * val
  - unsignedDivide
```
Unsigned unsignedDivide(int val)
```
    Returns a Unsigned whose value is (this / val).
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value by which this Unsigned is to be divided.
    
    Returns:
    
    this / val
  - unsignedRemainder
```
Unsigned unsignedRemainder(int val)
```
    Returns a Unsigned whose value is (this % val).
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value by which this Unsigned is to be divided, and the remainder computed.
    
    Returns:
    
    this % val
  - shiftLeft
```
Unsigned shiftLeft(int n)
```
    Returns a Unsigned whose value is (this << n).
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    n - shift distance, in bits.
    
    Returns:
    
    this << n
  - unsignedShiftRight
```
Unsigned unsignedShiftRight(int n)
```
    Returns a Unsigned whose value is (this >>> n). No sign extension is performed.
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    n - shift distance, in bits.
    
    Returns:
    
    this >> n
  - and
```
Unsigned and(int val)
```
    Returns a Unsigned whose value is (this & val).
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to be AND'ed with this Unsigned.
    
    Returns:
    
    this & val
  - or
```
Unsigned or(int val)
```
    Returns a Unsigned whose value is (this | val).
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to be OR'ed with this Unsigned.
    
    Returns:
    
    this | val
  - xor
```
Unsigned xor(int val)
```
    Returns a Unsigned whose value is (this ^ val).
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to be XOR'ed with this Unsigned.
    
    Returns:
    
    this ^ val
  - equal
```
boolean equal(int val)
```
    Compares this Unsigned with the specified value.
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this == val
  - notEqual
```
boolean notEqual(int val)
```
    Compares this Unsigned with the specified value.
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this != val
  - belowThan
```
boolean belowThan(int val)
```
    Compares this Unsigned with the specified value.
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this < val
  - belowOrEqual
```
boolean belowOrEqual(int val)
```
    Compares this Unsigned with the specified value.
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this <= val
  - aboveThan
```
boolean aboveThan(int val)
```
    Compares this Unsigned with the specified value.
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this > val
  - aboveOrEqual
```
boolean aboveOrEqual(int val)
```
    Compares this Unsigned with the specified value.
    Note that the right operand is a signed value, while the operation is performed unsigned. Therefore, the result is only well-defined for positive right operands.
    
    Parameters:
    
    val - value to which this Unsigned is to be compared.
    
    Returns:
    
    this >= val

Interface Unsigned

Method Summary

Methods inherited from interface com.oracle.graal.word.ComparableWord

Methods inherited from interface com.oracle.graal.word.WordBase

Method Detail

add

subtract

multiply

unsignedDivide

unsignedRemainder

shiftLeft

unsignedShiftRight

and

or

xor

not

equal

notEqual

belowThan

belowOrEqual

aboveThan

aboveOrEqual

add

subtract

multiply

unsignedDivide

unsignedRemainder

shiftLeft

unsignedShiftRight

and

or

xor

equal

notEqual

belowThan

belowOrEqual

aboveThan

aboveOrEqual