Package org.lwjgl.util.zstd

Class ZDICTFastCoverParams

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<ZDICTFastCoverParams>

org.lwjgl.util.zstd.ZDICTFastCoverParams

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class ZDICTFastCoverParams
extends Struct<ZDICTFastCoverParams>
implements NativeResource

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

Layout

 struct ZDICT_fastCover_params_t {
     unsigned k();
     unsigned d();
     unsigned f();
     unsigned steps();
     unsigned nbThreads();
     double splitPoint();
     unsigned accel();
     ZDICT_params_t zParams;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZDICTFastCoverParams.Buffer	An array of ZDICTFastCoverParams structs.

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACCEL	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
static final int	D	The struct member offsets.
static final int	F	The struct member offsets.
static final int	K	The struct member offsets.
static final int	NBTHREADS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPLITPOINT	The struct member offsets.
static final int	STEPS	The struct member offsets.
static final 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	Description
ZDICTFastCoverParams(ByteBuffer container)	Creates a ZDICTFastCoverParams instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	accel()	acceleration level: constraint: 0 < accel <= 10, higher means faster and less accurate, 0 means default(1)
ZDICTFastCoverParams	accel(int value)	Sets the specified value to the accel() field.
static ZDICTFastCoverParams	calloc()	Returns a new ZDICTFastCoverParams instance allocated with memCalloc.
static ZDICTFastCoverParams.Buffer	calloc(int capacity)	Returns a new ZDICTFastCoverParams.Buffer instance allocated with memCalloc.
static ZDICTFastCoverParams.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new ZDICTFastCoverParams.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ZDICTFastCoverParams	calloc(MemoryStack stack)	Returns a new ZDICTFastCoverParams instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ZDICTFastCoverParams	callocStack()	Deprecated.
static ZDICTFastCoverParams.Buffer	callocStack(int capacity)	Deprecated.
static ZDICTFastCoverParams.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static ZDICTFastCoverParams	callocStack(MemoryStack stack)	Deprecated.
static ZDICTFastCoverParams	create()	Returns a new ZDICTFastCoverParams instance allocated with BufferUtils.
static ZDICTFastCoverParams.Buffer	create(int capacity)	Returns a new ZDICTFastCoverParams.Buffer instance allocated with BufferUtils.
static ZDICTFastCoverParams	create(long address)	Returns a new ZDICTFastCoverParams instance for the specified memory address.
static ZDICTFastCoverParams.Buffer	create(long address, int capacity)	Create a ZDICTFastCoverParams.Buffer instance at the specified memory.
static ZDICTFastCoverParams	createSafe(long address)	Like create, but returns null if address is NULL.
static ZDICTFastCoverParams.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	d()	dmer size : constraint: 0 < d <= k : Reasonable range [6, 16]
ZDICTFastCoverParams	d(int value)	Sets the specified value to the d() field.
int	f()	log of size of frequency array : constraint: 0 < f <= 31 : 1 means default(20)
ZDICTFastCoverParams	f(int value)	Sets the specified value to the f() field.
int	k()	segment size : constraint: 0 < k : Reasonable range [16, 2048+]
ZDICTFastCoverParams	k(int value)	Sets the specified value to the k() field.
static ZDICTFastCoverParams	malloc()	Returns a new ZDICTFastCoverParams instance allocated with memAlloc.
static ZDICTFastCoverParams.Buffer	malloc(int capacity)	Returns a new ZDICTFastCoverParams.Buffer instance allocated with memAlloc.
static ZDICTFastCoverParams.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new ZDICTFastCoverParams.Buffer instance allocated on the specified MemoryStack.
static ZDICTFastCoverParams	malloc(MemoryStack stack)	Returns a new ZDICTFastCoverParams instance allocated on the specified MemoryStack.
static ZDICTFastCoverParams	mallocStack()	Deprecated.
static ZDICTFastCoverParams.Buffer	mallocStack(int capacity)	Deprecated.
static ZDICTFastCoverParams.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static ZDICTFastCoverParams	mallocStack(MemoryStack stack)	Deprecated.
static int	naccel(long struct)	Unsafe version of accel().
static void	naccel(long struct, int value)	Unsafe version of accel.
int	nbThreads()	number of threads : constraint: 0 < nbThreads : 1 means single-threaded : Only used for optimization : Ignored if ZSTD_MULTITHREAD is not defined.
ZDICTFastCoverParams	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	nf(long struct)	Unsafe version of f().
static void	nf(long struct, int value)	Unsafe version of f.
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.
ZDICTFastCoverParams	set(int k, int d, int f, int steps, int nbThreads, double splitPoint, int accel, ZDICTParams zParams)	Initializes this struct with the specified values.
ZDICTFastCoverParams	set(ZDICTFastCoverParams src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
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 (0.75), 1.0 when all samples are used for both training and testing.
ZDICTFastCoverParams	splitPoint(double value)	Sets the specified value to the splitPoint() field.
int	steps()	Number of steps : Only used for optimization : 0 means default (40) : Higher means more parameters checked
ZDICTFastCoverParams	steps(int value)	Sets the specified value to the steps() field.
ZDICTParams	zParams()
ZDICTFastCoverParams	zParams(Consumer<ZDICTParams> consumer)	Passes the zParams field to the specified Consumer.
ZDICTFastCoverParams	zParams(ZDICTParams value)	Copies the specified ZDICTParams to the zParams field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 Details

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.

F

public static final int F

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.

ACCEL

public static final int ACCEL

The struct member offsets.

ZPARAMS

public static final int ZPARAMS

The struct member offsets.

Constructor Details

ZDICTFastCoverParams

public ZDICTFastCoverParams(ByteBuffer container)

Creates a ZDICTFastCoverParams 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<ZDICTFastCoverParams>

k

public int k()

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

d

public int d()

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

f

public int f()

log of size of frequency array : constraint: 0 < f <= 31 : 1 means default(20)

steps

public int steps()

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

nbThreads

public int nbThreads()

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

splitPoint

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 (0.75), 1.0 when all samples are used for both training and testing.

accel

public int accel()

acceleration level: constraint: 0 < accel <= 10, higher means faster and less accurate, 0 means default(1)

zParams

public ZDICTParams zParams()

Returns:

a ZDICTParams view of the zParams field.

k

public ZDICTFastCoverParams k(int value)

Sets the specified value to the k() field.

d

public ZDICTFastCoverParams d(int value)

Sets the specified value to the d() field.

f

public ZDICTFastCoverParams f(int value)

Sets the specified value to the f() field.

steps

public ZDICTFastCoverParams steps(int value)

Sets the specified value to the steps() field.

nbThreads

public ZDICTFastCoverParams nbThreads(int value)

Sets the specified value to the nbThreads() field.

splitPoint

public ZDICTFastCoverParams splitPoint(double value)

Sets the specified value to the splitPoint() field.

accel

public ZDICTFastCoverParams accel(int value)

Sets the specified value to the accel() field.

zParams

public ZDICTFastCoverParams zParams(ZDICTParams value)

Copies the specified ZDICTParams to the zParams field.

zParams

public ZDICTFastCoverParams zParams(Consumer<ZDICTParams> consumer)

Passes the zParams field to the specified Consumer.

set

public ZDICTFastCoverParams set(int k,
 int d,
 int f,
 int steps,
 int nbThreads,
 double splitPoint,
 int accel,
 ZDICTParams zParams)

Initializes this struct with the specified values.

set

public ZDICTFastCoverParams set(ZDICTFastCoverParams src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static ZDICTFastCoverParams malloc()

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

calloc

public static ZDICTFastCoverParams calloc()

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

create

public static ZDICTFastCoverParams create()

Returns a new ZDICTFastCoverParams instance allocated with BufferUtils.

create

public static ZDICTFastCoverParams create(long address)

Returns a new ZDICTFastCoverParams instance for the specified memory address.

createSafe

@Nullable
public static ZDICTFastCoverParams createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static ZDICTFastCoverParams.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static ZDICTFastCoverParams.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static ZDICTFastCoverParams.Buffer create(int capacity)

Returns a new ZDICTFastCoverParams.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static ZDICTFastCoverParams.Buffer create(long address,
 int capacity)

Create a ZDICTFastCoverParams.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static ZDICTFastCoverParams.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static ZDICTFastCoverParams mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static ZDICTFastCoverParams callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static ZDICTFastCoverParams mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ZDICTFastCoverParams callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static ZDICTFastCoverParams.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static ZDICTFastCoverParams.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static ZDICTFastCoverParams.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ZDICTFastCoverParams.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static ZDICTFastCoverParams malloc(MemoryStack stack)

Returns a new ZDICTFastCoverParams instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static ZDICTFastCoverParams calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static ZDICTFastCoverParams.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static ZDICTFastCoverParams.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

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().

nf

public static int nf(long struct)

Unsafe version of f().

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().

naccel

public static int naccel(long struct)

Unsafe version of accel().

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.

nf

public static void nf(long struct,
 int value)

Unsafe version of f.

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.

naccel

public static void naccel(long struct,
 int value)

Unsafe version of accel.

nzParams

public static void nzParams(long struct,
 ZDICTParams value)

Unsafe version of zParams.