ZDICTCoverParams (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.zstd.ZDICTCoverParams

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class ZDICTCoverParams
extends org.lwjgl.system.Struct
implements org.lwjgl.system.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+]
- d – dmer 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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ZDICTCoverParams.Buffer
An array of ZDICTCoverParams structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`D` The struct member offsets.
`static int`	`K` The struct member offsets.
`static int`	`NBTHREADS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SPLITPOINT` The struct member offsets.
`static int`	`STEPS` The struct member offsets.
`static int`	`ZPARAMS` 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 and Description

ZDICTCoverParams(java.nio.ByteBuffer container)
Creates a ZDICTCoverParams instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`ZDICTCoverParams(java.nio.ByteBuffer container)` Creates a `ZDICTCoverParams` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ZDICTCoverParams`	`calloc()` Returns a new `ZDICTCoverParams` instance allocated with `memCalloc`.
`static ZDICTCoverParams.Buffer`	`calloc(int capacity)` Returns a new `ZDICTCoverParams.Buffer` instance allocated with `memCalloc`.
`static ZDICTCoverParams`	`callocStack()` Returns a new `ZDICTCoverParams` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZDICTCoverParams.Buffer`	`callocStack(int capacity)` Returns a new `ZDICTCoverParams.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZDICTCoverParams.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZDICTCoverParams.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZDICTCoverParams`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZDICTCoverParams` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZDICTCoverParams`	`create()` Returns a new `ZDICTCoverParams` instance allocated with `BufferUtils`.
`static ZDICTCoverParams.Buffer`	`create(int capacity)` Returns a new `ZDICTCoverParams.Buffer` instance allocated with `BufferUtils`.
`static ZDICTCoverParams`	`create(long address)` Returns a new `ZDICTCoverParams` instance for the specified memory address.
`static ZDICTCoverParams.Buffer`	`create(long address, int capacity)` Create a `ZDICTCoverParams.Buffer` instance at the specified memory.
`static ZDICTCoverParams`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZDICTCoverParams.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`d()` Returns the value of the `d` field.
`ZDICTCoverParams`	`d(int value)` Sets the specified value to the `d` field.
`int`	`k()` Returns the value of the `k` field.
`ZDICTCoverParams`	`k(int value)` Sets the specified value to the `k` field.
`static ZDICTCoverParams`	`malloc()` Returns a new `ZDICTCoverParams` instance allocated with `memAlloc`.
`static ZDICTCoverParams.Buffer`	`malloc(int capacity)` Returns a new `ZDICTCoverParams.Buffer` instance allocated with `memAlloc`.
`static ZDICTCoverParams`	`mallocStack()` Returns a new `ZDICTCoverParams` instance allocated on the thread-local `MemoryStack`.
`static ZDICTCoverParams.Buffer`	`mallocStack(int capacity)` Returns a new `ZDICTCoverParams.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ZDICTCoverParams.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZDICTCoverParams.Buffer` instance allocated on the specified `MemoryStack`.
`static ZDICTCoverParams`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZDICTCoverParams` instance allocated on the specified `MemoryStack`.
`int`	`nbThreads()` Returns the value of the `nbThreads` field.
`ZDICTCoverParams`	`nbThreads(int value)` Sets the specified value to the `nbThreads` field.
`static int`	`nd(long struct)` Unsafe version of `d()`.
`static void`	`nd(long struct, int value)` Unsafe version of `d`.
`static int`	`nk(long struct)` Unsafe version of `k()`.
`static void`	`nk(long struct, int value)` Unsafe version of `k`.
`static int`	`nnbThreads(long struct)` Unsafe version of `nbThreads()`.
`static void`	`nnbThreads(long struct, int value)` Unsafe version of `nbThreads`.
`static double`	`nsplitPoint(long struct)` Unsafe version of `splitPoint()`.
`static void`	`nsplitPoint(long struct, double value)` Unsafe version of `splitPoint`.
`static int`	`nsteps(long struct)` Unsafe version of `steps()`.
`static void`	`nsteps(long struct, int value)` Unsafe version of `steps`.
`static ZDICTParams`	`nzParams(long struct)` Unsafe version of `zParams()`.
`static void`	`nzParams(long struct, ZDICTParams value)` Unsafe version of `zParams`.
`ZDICTCoverParams`	`set(int k, int d, int steps, int nbThreads, double splitPoint, ZDICTParams zParams)` Initializes this struct with the specified values.
`ZDICTCoverParams`	`set(ZDICTCoverParams src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`double`	`splitPoint()` Returns the value of the `splitPoint` field.
`ZDICTCoverParams`	`splitPoint(double value)` Sets the specified value to the `splitPoint` field.
`int`	`steps()` Returns the value of the `steps` field.
`ZDICTCoverParams`	`steps(int value)` Sets the specified value to the `steps` field.
`ZDICTParams`	`zParams()` Returns a `ZDICTParams` view of the `zParams` field.
`ZDICTCoverParams`	`zParams(java.util.function.Consumer<ZDICTParams> consumer)` Passes the `zParams` field to the specified `Consumer`.
`ZDICTCoverParams`	`zParams(ZDICTParams value)` Copies the specified `ZDICTParams` to the `zParams` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - K
```
public static final int K
```
    The struct member offsets.
  - D
```
public static final int D
```
    The struct member offsets.
  - STEPS
```
public static final int STEPS
```
    The struct member offsets.
  - NBTHREADS
```
public static final int NBTHREADS
```
    The struct member offsets.
  - SPLITPOINT
```
public static final int SPLITPOINT
```
    The struct member offsets.
  - ZPARAMS
```
public static final int 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - zParams
```
public ZDICTParams zParams()
```
    Returns a ZDICTParams view of the zParams 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(ZDICTParams value)
```
    Copies the specified ZDICTParams to the zParams 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()
```
    Returns a new ZDICTCoverParams instance allocated with BufferUtils.
  - 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.
  - malloc
```
public static ZDICTCoverParams.Buffer malloc(int capacity)
```
    Returns a new ZDICTCoverParams.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static ZDICTCoverParams.Buffer calloc(int capacity)
```
    Returns a new ZDICTCoverParams.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZDICTCoverParams.Buffer create(int capacity)
```
    Returns a new ZDICTCoverParams.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZDICTCoverParams.Buffer create(long address,
                                             int capacity)
```
    Create a ZDICTCoverParams.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - 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(org.lwjgl.system.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(org.lwjgl.system.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
  - mallocStack
```
public static ZDICTCoverParams.Buffer mallocStack(int capacity)
```
    Returns a new ZDICTCoverParams.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ZDICTCoverParams.Buffer callocStack(int capacity)
```
    Returns a new ZDICTCoverParams.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ZDICTCoverParams.Buffer mallocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZDICTCoverParams.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ZDICTCoverParams.Buffer callocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZDICTCoverParams.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
  - 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().
  - nzParams
```
public static ZDICTParams nzParams(long struct)
```
    Unsafe version of zParams().
  - 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.

Class ZDICTCoverParams

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

K

D

STEPS

NBTHREADS

SPLITPOINT

ZPARAMS

Constructor Detail

ZDICTCoverParams

Method Detail

sizeof

k

d

steps

nbThreads

splitPoint

zParams

k

d

steps

nbThreads

splitPoint

zParams

zParams

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nk

nd

nsteps

nnbThreads

nsplitPoint

nzParams

nk

nd

nsteps

nnbThreads

nsplitPoint

nzParams