Top Description Methods
org.graalvm.word

public Interface UnsignedWord

extends ComparableWord
Known Direct Subinterfaces
org.graalvm.word.Pointer
Represents an unsigned word-sized value.
Since
19.0

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

this >= val
aboveOrEqual(UnsignedWord
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public boolean

Returns:

this >= val
aboveOrEqual(int
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public boolean

Returns:

this > val
aboveThan(UnsignedWord
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public boolean

Returns:

this > val
aboveThan(int
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public UnsignedWord

Returns:

this + val
add(UnsignedWord
value to be added to this Unsigned.
val)

Returns a Unsigned whose value is (this + val).

public UnsignedWord

Returns:

this + val
add(int
value to be added to this Unsigned.
val)

Returns a Unsigned whose value is (this + val).

public UnsignedWord

Returns:

this & val
and(UnsignedWord
value to be AND'ed with this Unsigned.
val)

Returns a Unsigned whose value is (this & val).

public UnsignedWord

Returns:

this & val
and(int
value to be AND'ed with this Unsigned.
val)

Returns a Unsigned whose value is (this & val).

public boolean

Returns:

this <= val
belowOrEqual(UnsignedWord
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public boolean

Returns:

this <= val
belowOrEqual(int
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public boolean

Returns:

this < val
belowThan(UnsignedWord
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public boolean

Returns:

this < val
belowThan(int
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public boolean

Returns:

this == val
equal(UnsignedWord
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public boolean

Returns:

this == val
equal(int
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public UnsignedWord

Returns:

this * val
multiply(UnsignedWord
value to be multiplied by this Unsigned.
val)

Returns a Unsigned whose value is (this * val).

public UnsignedWord

Returns:

this * val
multiply(int
value to be multiplied by this Unsigned.
val)

Returns a Unsigned whose value is (this * val).

public UnsignedWord

Returns:

~this
not()

Returns a Unsigned whose value is (~this).

public boolean

Returns:

this != val
notEqual(UnsignedWord
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public boolean

Returns:

this != val
notEqual(int
value to which this Unsigned is to be compared.
val)

Compares this Unsigned with the specified value.

public UnsignedWord

Returns:

this | val
or(UnsignedWord
value to be OR'ed with this Unsigned.
val)

Returns a Unsigned whose value is (this | val).

public UnsignedWord

Returns:

this | val
or(int
value to be OR'ed with this Unsigned.
val)

Returns a Unsigned whose value is (this | val).

public UnsignedWord

Returns:

this << n
shiftLeft(UnsignedWord
shift distance, in bits.
n)

Returns a Unsigned whose value is (this << n).

public UnsignedWord

Returns:

this << n
shiftLeft(int
shift distance, in bits.
n)

Returns a Unsigned whose value is (this << n).

public UnsignedWord

Returns:

this - val
subtract(UnsignedWord
value to be subtracted from this Unsigned.
val)

Returns a Unsigned whose value is (this - val).

public UnsignedWord

Returns:

this - val
subtract(int
value to be subtracted from this Unsigned.
val)

Returns a Unsigned whose value is (this - val).

public UnsignedWord

Returns:

this / val
unsignedDivide(UnsignedWord
value by which this Unsigned is to be divided.
val)

Returns a Unsigned whose value is (this / val).

public UnsignedWord

Returns:

this / val
unsignedDivide(int
value by which this Unsigned is to be divided.
val)

Returns a Unsigned whose value is (this / val).

public UnsignedWord

Returns:

this % val
unsignedRemainder(UnsignedWord
value by which this Unsigned is to be divided, and the remainder computed.
val)

Returns a Unsigned whose value is (this % val).

public UnsignedWord

Returns:

this % val
unsignedRemainder(int
value by which this Unsigned is to be divided, and the remainder computed.
val)

Returns a Unsigned whose value is (this % val).

public UnsignedWord

Returns:

this >> n
unsignedShiftRight(UnsignedWord
shift distance, in bits.
n)

Returns a Unsigned whose value is (this >>> n).

public UnsignedWord

Returns:

this >> n
unsignedShiftRight(int
shift distance, in bits.
n)

Returns a Unsigned whose value is (this >>> n).

public UnsignedWord

Returns:

this ^ val
xor(UnsignedWord
value to be XOR'ed with this Unsigned.
val)

Returns a Unsigned whose value is (this ^ val).

public UnsignedWord

Returns:

this ^ val
xor(int
value to be XOR'ed with this Unsigned.
val)

Returns a Unsigned whose value is (this ^ val).

Inherited from org.graalvm.word.ComparableWord:
equalnotEqual

Method Detail

aboveOrEqualback to summary
public boolean aboveOrEqual(UnsignedWord val)

Compares this Unsigned with the specified value.

Parameters
val:UnsignedWord

value to which this Unsigned is to be compared.

Returns:boolean

this >= val

Since
19.0
aboveOrEqualback to summary
public 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:int

value to which this Unsigned is to be compared.

Returns:boolean

this >= val

Since
19.0
aboveThanback to summary
public boolean aboveThan(UnsignedWord val)

Compares this Unsigned with the specified value.

Parameters
val:UnsignedWord

value to which this Unsigned is to be compared.

Returns:boolean

this > val

Since
19.0
aboveThanback to summary
public 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:int

value to which this Unsigned is to be compared.

Returns:boolean

this > val

Since
19.0
addback to summary
public UnsignedWord add(UnsignedWord val)

Returns a Unsigned whose value is (this + val).

Parameters
val:UnsignedWord

value to be added to this Unsigned.

Returns:UnsignedWord

this + val

Since
19.0
addback to summary
public UnsignedWord 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:int

value to be added to this Unsigned.

Returns:UnsignedWord

this + val

Since
19.0
andback to summary
public UnsignedWord and(UnsignedWord val)

Returns a Unsigned whose value is (this & val).

Parameters
val:UnsignedWord

value to be AND'ed with this Unsigned.

Returns:UnsignedWord

this & val

Since
19.0
andback to summary
public UnsignedWord 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:int

value to be AND'ed with this Unsigned.

Returns:UnsignedWord

this & val

Since
19.0
belowOrEqualback to summary
public boolean belowOrEqual(UnsignedWord val)

Compares this Unsigned with the specified value.

Parameters
val:UnsignedWord

value to which this Unsigned is to be compared.

Returns:boolean

this <= val

Since
19.0
belowOrEqualback to summary
public 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:int

value to which this Unsigned is to be compared.

Returns:boolean

this <= val

Since
19.0
belowThanback to summary
public boolean belowThan(UnsignedWord val)

Compares this Unsigned with the specified value.

Parameters
val:UnsignedWord

value to which this Unsigned is to be compared.

Returns:boolean

this < val

Since
19.0
belowThanback to summary
public 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:int

value to which this Unsigned is to be compared.

Returns:boolean

this < val

Since
19.0
equalback to summary
public boolean equal(UnsignedWord val)

Compares this Unsigned with the specified value.

Parameters
val:UnsignedWord

value to which this Unsigned is to be compared.

Returns:boolean

this == val

Since
19.0
equalback to summary
public 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:int

value to which this Unsigned is to be compared.

Returns:boolean

this == val

Since
19.0
multiplyback to summary
public UnsignedWord multiply(UnsignedWord val)

Returns a Unsigned whose value is (this * val).

Parameters
val:UnsignedWord

value to be multiplied by this Unsigned.

Returns:UnsignedWord

this * val

Since
19.0
multiplyback to summary
public UnsignedWord 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:int

value to be multiplied by this Unsigned.

Returns:UnsignedWord

this * val

Since
19.0
notback to summary
public UnsignedWord not()

Returns a Unsigned whose value is (~this).

Returns:UnsignedWord

~this

Since
19.0
notEqualback to summary
public boolean notEqual(UnsignedWord val)

Compares this Unsigned with the specified value.

Parameters
val:UnsignedWord

value to which this Unsigned is to be compared.

Returns:boolean

this != val

Since
19.0
notEqualback to summary
public 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:int

value to which this Unsigned is to be compared.

Returns:boolean

this != val

Since
19.0
orback to summary
public UnsignedWord or(UnsignedWord val)

Returns a Unsigned whose value is (this | val).

Parameters
val:UnsignedWord

value to be OR'ed with this Unsigned.

Returns:UnsignedWord

this | val

Since
19.0
orback to summary
public UnsignedWord 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:int

value to be OR'ed with this Unsigned.

Returns:UnsignedWord

this | val

Since
19.0
shiftLeftback to summary
public UnsignedWord shiftLeft(UnsignedWord n)

Returns a Unsigned whose value is (this << n).

Parameters
n:UnsignedWord

shift distance, in bits.

Returns:UnsignedWord

this << n

Since
19.0
shiftLeftback to summary
public UnsignedWord 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:int

shift distance, in bits.

Returns:UnsignedWord

this << n

Since
19.0
subtractback to summary
public UnsignedWord subtract(UnsignedWord val)

Returns a Unsigned whose value is (this - val).

Parameters
val:UnsignedWord

value to be subtracted from this Unsigned.

Returns:UnsignedWord

this - val

Since
19.0
subtractback to summary
public UnsignedWord 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:int

value to be subtracted from this Unsigned.

Returns:UnsignedWord

this - val

Since
19.0
unsignedDivideback to summary
public UnsignedWord unsignedDivide(UnsignedWord val)

Returns a Unsigned whose value is (this / val).

Parameters
val:UnsignedWord

value by which this Unsigned is to be divided.

Returns:UnsignedWord

this / val

Since
19.0
unsignedDivideback to summary
public UnsignedWord 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:int

value by which this Unsigned is to be divided.

Returns:UnsignedWord

this / val

Since
19.0
unsignedRemainderback to summary
public UnsignedWord unsignedRemainder(UnsignedWord val)

Returns a Unsigned whose value is (this % val).

Parameters
val:UnsignedWord

value by which this Unsigned is to be divided, and the remainder computed.

Returns:UnsignedWord

this % val

Since
19.0
unsignedRemainderback to summary
public UnsignedWord 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:int

value by which this Unsigned is to be divided, and the remainder computed.

Returns:UnsignedWord

this % val

Since
19.0
unsignedShiftRightback to summary
public UnsignedWord unsignedShiftRight(UnsignedWord n)

Returns a Unsigned whose value is (this >>> n). No sign extension is performed.

Parameters
n:UnsignedWord

shift distance, in bits.

Returns:UnsignedWord

this >> n

Since
19.0
unsignedShiftRightback to summary
public UnsignedWord 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:int

shift distance, in bits.

Returns:UnsignedWord

this >> n

Since
19.0
xorback to summary
public UnsignedWord xor(UnsignedWord val)

Returns a Unsigned whose value is (this ^ val).

Parameters
val:UnsignedWord

value to be XOR'ed with this Unsigned.

Returns:UnsignedWord

this ^ val

Since
19.0
xorback to summary
public UnsignedWord 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:int

value to be XOR'ed with this Unsigned.

Returns:UnsignedWord

this ^ val

Since
19.0