Top Description Inners Fields Constructors Methods
org.lwjgl.util.zstd

public Class ZDICTCoverParams

extends Struct<ZDICTCoverParams>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ZDICT_cover_params_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

k and d are the only required parameters. For others, value 0 means default.

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
D

The struct member offsets.

public static final int
K

The struct member offsets.

public static final int
NBTHREADS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SPLITPOINT

The struct member offsets.

public static final int
STEPS

The struct member offsets.

public static final int
ZPARAMS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
ZDICTCoverParams(long address, ByteBuffer container)

public
ZDICTCoverParams(ByteBuffer container)

Creates a ZDICTCoverParams instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static ZDICTCoverParams
calloc()

Returns a new ZDICTCoverParams instance allocated with memCalloc.

public static ZDICTCoverParams.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new ZDICTCoverParams.Buffer instance allocated with memCalloc.

public static ZDICTCoverParams
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static ZDICTCoverParams.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static ZDICTCoverParams
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ZDICTCoverParams
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ZDICTCoverParams.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ZDICTCoverParams.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected ZDICTCoverParams
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static ZDICTCoverParams
create()

Returns a new ZDICTCoverParams instance allocated with BufferUtils.

public static ZDICTCoverParams
create(long address)

Returns a new ZDICTCoverParams instance for the specified memory address.

public static ZDICTCoverParams.Buffer
create(int
the buffer capacity
capacity
)

Returns a new ZDICTCoverParams.Buffer instance allocated with BufferUtils.

public static ZDICTCoverParams.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a ZDICTCoverParams.Buffer instance at the specified memory.

public static ZDICTCoverParams
createSafe(long address)

Like create, but returns null if address is NULL.

public static ZDICTCoverParams.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
d()

dmer size : constraint: 0 < d <= k : Reasonable range [6, 16]

public ZDICTCoverParams
d(int value)

Sets the specified value to the d field.

public int
k()

segment size : constraint: 0 < k : Reasonable range [16, 2048+]

public ZDICTCoverParams
k(int value)

Sets the specified value to the k field.

public static ZDICTCoverParams
malloc()

Returns a new ZDICTCoverParams instance allocated with memAlloc.

public static ZDICTCoverParams.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new ZDICTCoverParams.Buffer instance allocated with memAlloc.

public static ZDICTCoverParams
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new ZDICTCoverParams instance allocated on the specified MemoryStack.

public static ZDICTCoverParams.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static ZDICTCoverParams
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ZDICTCoverParams
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ZDICTCoverParams.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ZDICTCoverParams.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
nbThreads()

number of threads : constraint: 0 < nbThreads : 1 means single-threaded : Only used for optimization : Ignored if ZSTD_MULTITHREAD is not defined.

public ZDICTCoverParams
nbThreads(int value)

Sets the specified value to the nbThreads field.

public static int
nd(long struct)

Unsafe version of d.

public static void
nd(long struct, int value)

Unsafe version of d.

public static int
nk(long struct)

Unsafe version of k.

public static void
nk(long struct, int value)

Unsafe version of k.

public static int
nnbThreads(long struct)

Unsafe version of nbThreads.

public static void
nnbThreads(long struct, int value)

Unsafe version of nbThreads.

public static double
nsplitPoint(long struct)

Unsafe version of splitPoint.

public static void
nsplitPoint(long struct, double value)

Unsafe version of splitPoint.

public static int
nsteps(long struct)

Unsafe version of steps.

public static void
nsteps(long struct, int value)

Unsafe version of steps.

public static ZDICTParams
nzParams(long struct)

Unsafe version of zParams.

public static void
nzParams(long struct, ZDICTParams value)

Unsafe version of zParams.

public ZDICTCoverParams
set(int k, int d, int steps, int nbThreads, double splitPoint, ZDICTParams zParams)

Initializes this struct with the specified values.

public ZDICTCoverParams

Returns:

this struct
set
(ZDICTCoverParams
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public double
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.

public ZDICTCoverParams
splitPoint(double value)

Sets the specified value to the splitPoint field.

public int
steps()

Number of steps : Only used for optimization : 0 means default (40) : Higher means more parameters checked

public ZDICTCoverParams
steps(int value)

Sets the specified value to the steps field.

public ZDICTParams

Returns:

a ZDICTParams view of the zParams field.
zParams
()

public ZDICTCoverParams
zParams(ZDICTParams value)

Copies the specified ZDICTParams to the zParams field.

public ZDICTCoverParams
zParams(Consumer<ZDICTParams> consumer)

Passes the zParams field to the specified Consumer.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

Dback to summary
public static final int D

The struct member offsets.

Kback to summary
public static final int K

The struct member offsets.

NBTHREADSback to summary
public static final int NBTHREADS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SPLITPOINTback to summary
public static final int SPLITPOINT

The struct member offsets.

STEPSback to summary
public static final int STEPS

The struct member offsets.

ZPARAMSback to summary
public static final int ZPARAMS

The struct member offsets.

Constructor Detail

ZDICTCoverParamsback to summary
protected ZDICTCoverParams(long address, ByteBuffer container)
ZDICTCoverParamsback to summary
public ZDICTCoverParams(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

callocback to summary
public static ZDICTCoverParams calloc()

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

callocback to summary
public static ZDICTCoverParams.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static ZDICTCoverParams calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static ZDICTCoverParams.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static ZDICTCoverParams callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static ZDICTCoverParams callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static ZDICTCoverParams.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static ZDICTCoverParams.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected ZDICTCoverParams create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static ZDICTCoverParams create()

Returns a new ZDICTCoverParams instance allocated with BufferUtils.

createback to summary
public static ZDICTCoverParams create(long address)

Returns a new ZDICTCoverParams instance for the specified memory address.

createback to summary
public static ZDICTCoverParams.Buffer create(int capacity)

Returns a new ZDICTCoverParams.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static ZDICTCoverParams.Buffer create(long address, int capacity)

Create a ZDICTCoverParams.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static ZDICTCoverParams createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static ZDICTCoverParams.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
dback to summary
public int d()

dmer size : constraint: 0 < d <= k : Reasonable range [6, 16]

Annotations
@NativeType:unsigned
dback to summary
public ZDICTCoverParams d(int value)

Sets the specified value to the d field.

kback to summary
public int k()

segment size : constraint: 0 < k : Reasonable range [16, 2048+]

Annotations
@NativeType:unsigned
kback to summary
public ZDICTCoverParams k(int value)

Sets the specified value to the k field.

mallocback to summary
public static ZDICTCoverParams malloc()

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

mallocback to summary
public static ZDICTCoverParams.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static ZDICTCoverParams malloc(MemoryStack stack)

Returns a new ZDICTCoverParams instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static ZDICTCoverParams.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static ZDICTCoverParams mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static ZDICTCoverParams mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static ZDICTCoverParams.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static ZDICTCoverParams.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nbThreadsback to summary
public int nbThreads()

number of threads : constraint: 0 < nbThreads : 1 means single-threaded : Only used for optimization : Ignored if ZSTD_MULTITHREAD is not defined.

Annotations
@NativeType:unsigned
nbThreadsback to summary
public ZDICTCoverParams nbThreads(int value)

Sets the specified value to the nbThreads field.

ndback to summary
public static int nd(long struct)

Unsafe version of d.

ndback to summary
public static void nd(long struct, int value)

Unsafe version of d.

nkback to summary
public static int nk(long struct)

Unsafe version of k.

nkback to summary
public static void nk(long struct, int value)

Unsafe version of k.

nnbThreadsback to summary
public static int nnbThreads(long struct)

Unsafe version of nbThreads.

nnbThreadsback to summary
public static void nnbThreads(long struct, int value)

Unsafe version of nbThreads.

nsplitPointback to summary
public static double nsplitPoint(long struct)

Unsafe version of splitPoint.

nsplitPointback to summary
public static void nsplitPoint(long struct, double value)

Unsafe version of splitPoint.

nstepsback to summary
public static int nsteps(long struct)

Unsafe version of steps.

nstepsback to summary
public static void nsteps(long struct, int value)

Unsafe version of steps.

nzParamsback to summary
public static ZDICTParams nzParams(long struct)

Unsafe version of zParams.

nzParamsback to summary
public static void nzParams(long struct, ZDICTParams value)

Unsafe version of zParams.

setback to summary
public ZDICTCoverParams set(int k, int d, int steps, int nbThreads, double splitPoint, ZDICTParams zParams)

Initializes this struct with the specified values.

setback to summary
public ZDICTCoverParams set(ZDICTCoverParams src)

Copies the specified struct data to this struct.

Parameters
src:ZDICTCoverParams

the source struct

Returns:ZDICTCoverParams

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
splitPointback to summary
public double 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.

splitPointback to summary
public ZDICTCoverParams splitPoint(double value)

Sets the specified value to the splitPoint field.

stepsback to summary
public int steps()

Number of steps : Only used for optimization : 0 means default (40) : Higher means more parameters checked

Annotations
@NativeType:unsigned
stepsback to summary
public ZDICTCoverParams steps(int value)

Sets the specified value to the steps field.

zParamsback to summary
public ZDICTParams zParams()
Returns:ZDICTParams

a ZDICTParams view of the zParams field.

Annotations
@NativeType:ZDICT_params_t
zParamsback to summary
public ZDICTCoverParams zParams(ZDICTParams value)

Copies the specified ZDICTParams to the zParams field.

zParamsback to summary
public ZDICTCoverParams zParams(Consumer<ZDICTParams> consumer)

Passes the zParams field to the specified Consumer.

org.lwjgl.util.zstd back to summary

public Class ZDICTCoverParams.Buffer

extends StructBuffer<ZDICTCoverParams, ZDICTCoverParams.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of ZDICTCoverParams structs.

Field Summary

Modifier and TypeField and Description
private static final ZDICTCoverParams

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new ZDICTCoverParams.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the ZDICTCoverParams#d field.
d
()

public ZDICTCoverParams.Buffer
d(int value)

Sets the specified value to the ZDICTCoverParams#d field.

protected ZDICTCoverParams
public int

Returns:

the value of the ZDICTCoverParams#k field.
k
()

public ZDICTCoverParams.Buffer
k(int value)

Sets the specified value to the ZDICTCoverParams#k field.

public int

Returns:

the value of the ZDICTCoverParams#nbThreads field.
nbThreads
()

public ZDICTCoverParams.Buffer
nbThreads(int value)

Sets the specified value to the ZDICTCoverParams#nbThreads field.

protected ZDICTCoverParams.Buffer
public double

Returns:

the value of the ZDICTCoverParams#splitPoint field.
splitPoint
()

public ZDICTCoverParams.Buffer
splitPoint(double value)

Sets the specified value to the ZDICTCoverParams#splitPoint field.

public int

Returns:

the value of the ZDICTCoverParams#steps field.
steps
()

public ZDICTCoverParams.Buffer
steps(int value)

Sets the specified value to the ZDICTCoverParams#steps field.

public ZDICTParams

Returns:

a ZDICTParams view of the zParams field.
zParams
()

public ZDICTCoverParams.Buffer
zParams(ZDICTParams value)

Copies the specified ZDICTParams to the zParams field.

public ZDICTCoverParams.Buffer
zParams(Consumer<ZDICTParams> consumer)

Passes the zParams field to the specified Consumer.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final ZDICTCoverParams ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new ZDICTCoverParams.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 ZDICTCoverParams#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

dback to summary
public int d()
Returns:int

the value of the ZDICTCoverParams#d field.

Annotations
@NativeType:unsigned
dback to summary
public ZDICTCoverParams.Buffer d(int value)

Sets the specified value to the ZDICTCoverParams#d field.

getElementFactoryback to summary
protected ZDICTCoverParams getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
kback to summary
public int k()
Returns:int

the value of the ZDICTCoverParams#k field.

Annotations
@NativeType:unsigned
kback to summary
public ZDICTCoverParams.Buffer k(int value)

Sets the specified value to the ZDICTCoverParams#k field.

nbThreadsback to summary
public int nbThreads()
Returns:int

the value of the ZDICTCoverParams#nbThreads field.

Annotations
@NativeType:unsigned
nbThreadsback to summary
public ZDICTCoverParams.Buffer nbThreads(int value)

Sets the specified value to the ZDICTCoverParams#nbThreads field.

selfback to summary
protected ZDICTCoverParams.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
splitPointback to summary
public double splitPoint()
Returns:double

the value of the ZDICTCoverParams#splitPoint field.

splitPointback to summary
public ZDICTCoverParams.Buffer splitPoint(double value)

Sets the specified value to the ZDICTCoverParams#splitPoint field.

stepsback to summary
public int steps()
Returns:int

the value of the ZDICTCoverParams#steps field.

Annotations
@NativeType:unsigned
stepsback to summary
public ZDICTCoverParams.Buffer steps(int value)

Sets the specified value to the ZDICTCoverParams#steps field.

zParamsback to summary
public ZDICTParams zParams()
Returns:ZDICTParams

a ZDICTParams view of the zParams field.

Annotations
@NativeType:ZDICT_params_t
zParamsback to summary
public ZDICTCoverParams.Buffer zParams(ZDICTParams value)

Copies the specified ZDICTParams to the zParams field.

zParamsback to summary
public ZDICTCoverParams.Buffer zParams(Consumer<ZDICTParams> consumer)

Passes the zParams field to the specified Consumer.