Package org.lwjgl.util.xxhash

Class XXH64State

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class XXH64State
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    The opaque state struct for the XXH64 streaming API.

    Layout

    
 struct XXH64_state_t {
     XXH64_hash_t total_len();
     XXH64_hash_t v()[4];
     XXH64_hash_t mem64()[4];
     XXH32_hash_t memsize();
     XXH32_hash_t reserved32();
     XXH64_hash_t reserved64();
 }

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  XXH64State.Buffer
      An array of XXH64State structs.

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

        org.lwjgl.system.Pointer.Default

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

        org.lwjgl.system.Struct.StructValidation

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALIGNOF
      The struct alignment in bytes.
      static int MEM64
      MEMSIZE
      RESERVED32
      RESERVED64
      The struct member offsets.
      static int SIZEOF
      The struct size in bytes.
      static int TOTAL_LEN
      V
      The struct member offsets.

      • Fields inherited from interface org.lwjgl.system.Pointer

        BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

    • Constructor Summary

      Constructors 
      Constructor Description
      XXH64State​(java.nio.ByteBuffer container)
      Creates a XXH64State instance at the current position of the specified ByteBuffer container.

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • TOTAL_LEN, V, MEM64, MEMSIZE, RESERVED32, RESERVED64

        The struct member offsets.

    • Constructor Detail

      • XXH64State

        public XXH64State​(java.nio.ByteBuffer container)
        Creates a XXH64State 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 Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • total_len

        public long total_len()
        total length hashed. This is always 64-bit.

      • v

        public java.nio.LongBuffer v()

public long v​(int index)
        accumulator lanes

      • mem64

        public java.nio.LongBuffer mem64()

public long mem64​(int index)
        internal buffer for partial reads. Treated as unsigned char[32].

      • memsize

        public int memsize()
        amount of data in mem64

      • reserved32

        public int reserved32()
        reserved field, needed for padding anyways

      • reserved64

        public long reserved64()
        reserved field. Do not read or write to it, it may be removed.

      • malloc

        public static XXH64State malloc()
        Returns a new XXH64State instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static XXH64State calloc()
        Returns a new XXH64State instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static XXH64State create()
        Returns a new XXH64State instance allocated with BufferUtils.

      • create

        public static XXH64State create​(long address)
        Returns a new XXH64State instance for the specified memory address.

      • createSafe

        @Nullable
public static XXH64State createSafe​(long address)
        Like create, but returns null if address is NULL.

      • malloc

        public static XXH64State.Buffer malloc​(int capacity)
        Returns a new XXH64State.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity

      • calloc

        public static XXH64State.Buffer calloc​(int capacity)
        Returns a new XXH64State.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity

      • create

        public static XXH64State.Buffer create​(int capacity)
        Returns a new XXH64State.Buffer instance allocated with BufferUtils.
        Parameters:
        capacity - the buffer capacity

      • create

        public static XXH64State.Buffer create​(long address,
                                       int capacity)
        Create a XXH64State.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity

      • createSafe

        @Nullable
public static XXH64State.Buffer createSafe​(long address,
                                           int capacity)
        Like create, but returns null if address is NULL.

      • mallocStack

        @Deprecated
public static XXH64State mallocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

      • callocStack

        @Deprecated
public static XXH64State callocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

      • mallocStack

        @Deprecated
public static XXH64State.Buffer mallocStack​(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

      • callocStack

        @Deprecated
public static XXH64State.Buffer callocStack​(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

      • malloc

        public static XXH64State malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new XXH64State instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static XXH64State calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new XXH64State instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • malloc

        public static XXH64State.Buffer malloc​(int capacity,
                                       org.lwjgl.system.MemoryStack stack)
        Returns a new XXH64State.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • calloc

        public static XXH64State.Buffer calloc​(int capacity,
                                       org.lwjgl.system.MemoryStack stack)
        Returns a new XXH64State.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • ntotal_len

        public static long ntotal_len​(long struct)
        Unsafe version of total_len().

      • nv

        public static java.nio.LongBuffer nv​(long struct)
        Unsafe version of v().

      • nv

        public static long nv​(long struct,
                      int index)
        Unsafe version of v.

      • nmem64

        public static java.nio.LongBuffer nmem64​(long struct)
        Unsafe version of mem64().

      • nmem64

        public static long nmem64​(long struct,
                          int index)
        Unsafe version of mem64.

      • nmemsize

        public static int nmemsize​(long struct)
        Unsafe version of memsize().

      • nreserved32

        public static int nreserved32​(long struct)
        Unsafe version of reserved32().

      • nreserved64

        public static long nreserved64​(long struct)
        Unsafe version of reserved64().