com.oracle.svm.core.util

Class UnsignedUtils

java.lang.Object

com.oracle.svm.core.util.UnsignedUtils

public final class UnsignedUtils
extends Object

Utility methods on Unsigned values.

Field Summary

Fields

Modifier and Type	Field and Description
static org.graalvm.word.UnsignedWord	MAX_VALUE The UnsignedWord of the greatest magnitude.

Method Summary

Modifier and Type	Method and Description
static boolean	isAMultiple(org.graalvm.word.UnsignedWord that, org.graalvm.word.UnsignedWord multiple) Check that an Unsigned is an even multiple.
static org.graalvm.word.UnsignedWord	max(org.graalvm.word.UnsignedWord x, org.graalvm.word.UnsignedWord y) The maximum of two Unsigneds.
static org.graalvm.word.UnsignedWord	min(org.graalvm.word.UnsignedWord x, org.graalvm.word.UnsignedWord y) The minimum of two Unsigneds.
static org.graalvm.word.UnsignedWord	roundDown(org.graalvm.word.UnsignedWord that, org.graalvm.word.UnsignedWord multiple) Round an Unsigned down to the nearest smaller multiple.
static org.graalvm.word.UnsignedWord	roundUp(org.graalvm.word.UnsignedWord that, org.graalvm.word.UnsignedWord multiple) Round an Unsigned up to the nearest larger multiple.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_VALUE

public static final org.graalvm.word.UnsignedWord MAX_VALUE

The UnsignedWord of the greatest magnitude.

Method Detail

roundDown

public static org.graalvm.word.UnsignedWord roundDown(org.graalvm.word.UnsignedWord that,
                                                      org.graalvm.word.UnsignedWord multiple)

Round an Unsigned down to the nearest smaller multiple.

Parameters:

that - The Unsigned to be rounded down.

multiple - The multiple to which that Unsigned should be decreased.

Returns:

That Unsigned, but rounded down.

roundUp

public static org.graalvm.word.UnsignedWord roundUp(org.graalvm.word.UnsignedWord that,
                                                    org.graalvm.word.UnsignedWord multiple)

Round an Unsigned up to the nearest larger multiple.

Parameters:

that - The Unsigned to be rounded up.

multiple - The multiple to which that Unsigned should be increased.

Returns:

That Unsigned, but rounded up.

isAMultiple

public static boolean isAMultiple(org.graalvm.word.UnsignedWord that,
                                  org.graalvm.word.UnsignedWord multiple)

Check that an Unsigned is an even multiple.

Parameters:

that - The Unsigned to be verified as a multiple.

multiple - The multiple against which the Unsigned should be verified.

Returns:

true if that Unsigned is a multiple, false otherwise.

min

public static org.graalvm.word.UnsignedWord min(org.graalvm.word.UnsignedWord x,
                                                org.graalvm.word.UnsignedWord y)

The minimum of two Unsigneds.

Parameters:

x - An Unsigned.

y - Another Unsigned.

Returns:

The whichever Unsigned is smaller.

max

public static org.graalvm.word.UnsignedWord max(org.graalvm.word.UnsignedWord x,
                                                org.graalvm.word.UnsignedWord y)

The maximum of two Unsigneds.

Parameters:

x - An Unsigned.

y - Another Unsigned.

Returns:

The whichever Unsigned is larger.