com.oracle.svm.core.util

Class PointerUtils

java.lang.Object

com.oracle.svm.core.util.PointerUtils

public final class PointerUtils
extends Object

Utility methods on Pointers.

Method Summary

Modifier and Type	Method and Description
static org.graalvm.word.UnsignedWord	absoluteDifference(org.graalvm.word.PointerBase pointer1, org.graalvm.word.PointerBase pointer2) Return the distance between two Pointers.
static boolean	isAMultiple(org.graalvm.word.PointerBase that, org.graalvm.word.UnsignedWord multiple) Check that a Pointer is an even multiple.
static <T extends org.graalvm.word.PointerBase> T	max(T x, T y) The maximum of two Pointers.
static <T extends org.graalvm.word.PointerBase> T	min(T x, T y) The minimum of two Pointers.
static org.graalvm.word.Pointer	roundDown(org.graalvm.word.PointerBase that, org.graalvm.word.UnsignedWord multiple) Round a Pointer down to the nearest smaller multiple.
static org.graalvm.word.Pointer	roundUp(org.graalvm.word.PointerBase that, org.graalvm.word.UnsignedWord multiple) Round a Pointer up to the nearest larger multiple.

Methods inherited from class java.lang.Object

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

Method Detail

roundDown

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

Round a Pointer down to the nearest smaller multiple.

Parameters:

that - The Pointer to be rounded up.

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

Returns:

That Pointer, but rounded down.

roundUp

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

Round a Pointer up to the nearest larger multiple.

Parameters:

that - The Pointer to be rounded up.

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

Returns:

That Pointer, but rounded up.

isAMultiple

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

Check that a Pointer is an even multiple.

Parameters:

that - The Pointer to be verified as a multiple.

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

Returns:

true if that Pointer is a multiple, false otherwise.

absoluteDifference

public static org.graalvm.word.UnsignedWord absoluteDifference(org.graalvm.word.PointerBase pointer1,
                                                               org.graalvm.word.PointerBase pointer2)

Return the distance between two Pointers.

Parameters:

pointer1 - A first Pointer.

pointer2 - A second Pointer.

Returns:

The distance in bytes between the two Pointers.

min

public static <T extends org.graalvm.word.PointerBase> T min(T x,
                                                             T y)

The minimum of two Pointers.

Parameters:

x - A Pointer.

y - Another Pointer.

Returns:

The whichever Pointer is smaller.

max

public static <T extends org.graalvm.word.PointerBase> T max(T x,
                                                             T y)

The maximum of two Pointers.

Parameters:

x - A Pointer.

y - Another Pointer.

Returns:

The whichever Pointer is larger.