Class ZDICTCoverParams

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class ZDICTCoverParams
    extends Struct
    implements NativeResource
    k and d are the only required parameters. For others, value 0 means default.

    Member documentation

    • k – segment size : constraint: 0 < k : Reasonable range [16, 2048+]
    • ddmer size : constraint: 0 < d <= k : Reasonable range [6, 16]
    • steps – Number of steps : Only used for optimization : 0 means default (40) : Higher means more parameters checked
    • nbThreads – number of threads : constraint: 0 < nbThreads : 1 means single-threaded : Only used for optimization : Ignored if ZSTD_MULTITHREAD is not defined.
    • splitPoint – percentage of samples used for training: Only used for optimization: the first nbSamples * splitPoint samples will be used to training, the last nbSamples * (1 - splitPoint) samples will be used for testing, 0 means default (1.0), 1.0 when all samples are used for both training and testing.

    Layout

    
     struct ZDICT_cover_params_t {
         unsigned k;
         unsigned d;
         unsigned steps;
         unsigned nbThreads;
         double splitPoint;
         ZDICT_params_t zParams;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • K, D, STEPS, NBTHREADS, SPLITPOINT, ZPARAMS

        The struct member offsets.
    • Constructor Detail

      • ZDICTCoverParams

        public ZDICTCoverParams​(java.nio.ByteBuffer container)
        Creates a ZDICTCoverParams 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • k

        public int k()
        Returns the value of the k field.
      • d

        public int d()
        Returns the value of the d field.
      • steps

        public int steps()
        Returns the value of the steps field.
      • nbThreads

        public int nbThreads()
        Returns the value of the nbThreads field.
      • splitPoint

        public double splitPoint()
        Returns the value of the splitPoint field.
      • k

        public ZDICTCoverParams k​(int value)
        Sets the specified value to the k field.
      • d

        public ZDICTCoverParams d​(int value)
        Sets the specified value to the d field.
      • steps

        public ZDICTCoverParams steps​(int value)
        Sets the specified value to the steps field.
      • nbThreads

        public ZDICTCoverParams nbThreads​(int value)
        Sets the specified value to the nbThreads field.
      • splitPoint

        public ZDICTCoverParams splitPoint​(double value)
        Sets the specified value to the splitPoint field.
      • zParams

        public ZDICTCoverParams zParams​(java.util.function.Consumer<ZDICTParams> consumer)
        Passes the zParams field to the specified Consumer.
      • set

        public ZDICTCoverParams set​(int k,
                                    int d,
                                    int steps,
                                    int nbThreads,
                                    double splitPoint,
                                    ZDICTParams zParams)
        Initializes this struct with the specified values.
      • set

        public ZDICTCoverParams set​(ZDICTCoverParams src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct
      • malloc

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

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

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

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

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

        public static ZDICTCoverParams mallocStack()
        Returns a new ZDICTCoverParams instance allocated on the thread-local MemoryStack.
      • callocStack

        public static ZDICTCoverParams callocStack()
        Returns a new ZDICTCoverParams instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static ZDICTCoverParams mallocStack​(MemoryStack stack)
        Returns a new ZDICTCoverParams instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static ZDICTCoverParams callocStack​(MemoryStack stack)
        Returns a new ZDICTCoverParams instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • nk

        public static int nk​(long struct)
        Unsafe version of k().
      • nd

        public static int nd​(long struct)
        Unsafe version of d().
      • nsteps

        public static int nsteps​(long struct)
        Unsafe version of steps().
      • nnbThreads

        public static int nnbThreads​(long struct)
        Unsafe version of nbThreads().
      • nsplitPoint

        public static double nsplitPoint​(long struct)
        Unsafe version of splitPoint().
      • nk

        public static void nk​(long struct,
                              int value)
        Unsafe version of k.
      • nd

        public static void nd​(long struct,
                              int value)
        Unsafe version of d.
      • nsteps

        public static void nsteps​(long struct,
                                  int value)
        Unsafe version of steps.
      • nnbThreads

        public static void nnbThreads​(long struct,
                                      int value)
        Unsafe version of nbThreads.
      • nsplitPoint

        public static void nsplitPoint​(long struct,
                                       double value)
        Unsafe version of splitPoint.
      • nzParams

        public static void nzParams​(long struct,
                                    ZDICTParams value)
        Unsafe version of zParams.