org.lwjgl.util.xxhash.XXH64Canonical Maven / Gradle / Ivy
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.util.xxhash;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* 64-bit canonical representation.
*
* Member documentation
*
*
* - {@code digest} – the digest in canonical representation
*
*
* Layout
*
*
* struct XXH64_canonical_t {
* unsigned char digest[8];
* }
*/
@NativeType("struct XXH64_canonical_t")
public class XXH64Canonical extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
DIGEST;
static {
Layout layout = __struct(
__array(1, 8)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
DIGEST = layout.offsetof(0);
}
XXH64Canonical(long address, ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link XXH64Canonical} instance at the current position of the specified {@link 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.
*/
public XXH64Canonical(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns a {@link ByteBuffer} view of the {@code digest} field. */
@NativeType("unsigned char[8]")
public ByteBuffer digest() { return ndigest(address()); }
/** Returns the value at the specified index of the {@code digest} field. */
@NativeType("unsigned char")
public byte digest(int index) { return ndigest(address(), index); }
// -----------------------------------
/** Returns a new {@link XXH64Canonical} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XXH64Canonical malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link XXH64Canonical} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XXH64Canonical calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link XXH64Canonical} instance allocated with {@link BufferUtils}. */
public static XXH64Canonical create() {
return new XXH64Canonical(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link XXH64Canonical} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static XXH64Canonical create(long address) {
return address == NULL ? null : new XXH64Canonical(address, null);
}
/**
* Returns a new {@link XXH64Canonical.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XXH64Canonical.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XXH64Canonical.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link XXH64Canonical.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link XXH64Canonical} instance allocated on the thread-local {@link MemoryStack}. */
public static XXH64Canonical mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link XXH64Canonical} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static XXH64Canonical callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link XXH64Canonical} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XXH64Canonical mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link XXH64Canonical} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XXH64Canonical callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link XXH64Canonical.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link XXH64Canonical.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link XXH64Canonical.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XXH64Canonical.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #digest}. */
public static ByteBuffer ndigest(long struct) { return memByteBuffer(struct + XXH64Canonical.DIGEST, 8); }
/** Unsafe version of {@link #digest(int) digest}. */
public static byte ndigest(long struct, int index) {
if (CHECKS) { check(index, 8); }
return memGetByte(struct + XXH64Canonical.DIGEST + index * 1);
}
// -----------------------------------
/** An array of {@link XXH64Canonical} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link XXH64Canonical.Buffer} instance backed by the specified container.
*
* Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
* will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
* by {@link XXH64Canonical#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected XXH64Canonical newInstance(long address) {
return new XXH64Canonical(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns a {@link ByteBuffer} view of the {@code digest} field. */
@NativeType("unsigned char[8]")
public ByteBuffer digest() { return XXH64Canonical.ndigest(address()); }
/** Returns the value at the specified index of the {@code digest} field. */
@NativeType("unsigned char")
public byte digest(int index) { return XXH64Canonical.ndigest(address(), index); }
}
}