Package org.lwjgl.util.xxhash

Class XXH64Canonical

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XXH64Canonical>

org.lwjgl.util.xxhash.XXH64Canonical

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class XXH64Canonical
extends Struct<XXH64Canonical>
implements NativeResource

64-bit canonical representation.

Layout

 struct XXH64_canonical_t {
     unsigned char digest()[8];
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XXH64Canonical.Buffer	An array of XXH64Canonical structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DIGEST	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XXH64Canonical(ByteBuffer container)	Creates a XXH64Canonical instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XXH64Canonical	calloc()	Returns a new XXH64Canonical instance allocated with memCalloc.
static XXH64Canonical.Buffer	calloc(int capacity)	Returns a new XXH64Canonical.Buffer instance allocated with memCalloc.
static XXH64Canonical.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new XXH64Canonical.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XXH64Canonical	calloc(MemoryStack stack)	Returns a new XXH64Canonical instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XXH64Canonical	callocStack()	Deprecated.
static XXH64Canonical.Buffer	callocStack(int capacity)	Deprecated.
static XXH64Canonical.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static XXH64Canonical	callocStack(MemoryStack stack)	Deprecated.
static XXH64Canonical	create()	Returns a new XXH64Canonical instance allocated with BufferUtils.
static XXH64Canonical.Buffer	create(int capacity)	Returns a new XXH64Canonical.Buffer instance allocated with BufferUtils.
static XXH64Canonical	create(long address)	Returns a new XXH64Canonical instance for the specified memory address.
static XXH64Canonical.Buffer	create(long address, int capacity)	Create a XXH64Canonical.Buffer instance at the specified memory.
static XXH64Canonical	createSafe(long address)	Like create, but returns null if address is NULL.
static XXH64Canonical.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
ByteBuffer	digest()	the digest in canonical representation
byte	digest(int index)	the digest in canonical representation
static XXH64Canonical	malloc()	Returns a new XXH64Canonical instance allocated with memAlloc.
static XXH64Canonical.Buffer	malloc(int capacity)	Returns a new XXH64Canonical.Buffer instance allocated with memAlloc.
static XXH64Canonical.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new XXH64Canonical.Buffer instance allocated on the specified MemoryStack.
static XXH64Canonical	malloc(MemoryStack stack)	Returns a new XXH64Canonical instance allocated on the specified MemoryStack.
static XXH64Canonical	mallocStack()	Deprecated.
static XXH64Canonical.Buffer	mallocStack(int capacity)	Deprecated.
static XXH64Canonical.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static XXH64Canonical	mallocStack(MemoryStack stack)	Deprecated.
static ByteBuffer	ndigest(long struct)	Unsafe version of digest().
static byte	ndigest(long struct, int index)	Unsafe version of digest.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

DIGEST

public static final int DIGEST

The struct member offsets.

Constructor Details

XXH64Canonical

public XXH64Canonical(ByteBuffer container)

Creates a XXH64Canonical instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<XXH64Canonical>

digest

public ByteBuffer digest()

the digest in canonical representation

digest

public byte digest(int index)

the digest in canonical representation

malloc

public static XXH64Canonical malloc()

Returns a new XXH64Canonical instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static XXH64Canonical calloc()

Returns a new XXH64Canonical instance allocated with memCalloc. The instance must be explicitly freed.

create

public static XXH64Canonical create()

Returns a new XXH64Canonical instance allocated with BufferUtils.

create

public static XXH64Canonical create(long address)

Returns a new XXH64Canonical instance for the specified memory address.

createSafe

@Nullable
public static XXH64Canonical createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XXH64Canonical.Buffer malloc(int capacity)

Returns a new XXH64Canonical.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static XXH64Canonical.Buffer calloc(int capacity)

Returns a new XXH64Canonical.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static XXH64Canonical.Buffer create(int capacity)

Returns a new XXH64Canonical.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static XXH64Canonical.Buffer create(long address,
 int capacity)

Create a XXH64Canonical.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static XXH64Canonical.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static XXH64Canonical mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static XXH64Canonical callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static XXH64Canonical mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static XXH64Canonical callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static XXH64Canonical.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static XXH64Canonical.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static XXH64Canonical.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static XXH64Canonical.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static XXH64Canonical malloc(MemoryStack stack)

Returns a new XXH64Canonical instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XXH64Canonical calloc(MemoryStack stack)

Returns a new XXH64Canonical instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static XXH64Canonical.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new XXH64Canonical.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XXH64Canonical.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new XXH64Canonical.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ndigest

public static ByteBuffer ndigest(long struct)

Unsafe version of digest().

ndigest

public static byte ndigest(long struct,
 int index)

Unsafe version of digest.