Package org.lwjgl.util.zstd

Class ZDICTCoverParams

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<ZDICTCoverParams>

org.lwjgl.util.zstd.ZDICTCoverParams

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class ZDICTCoverParams
extends Struct<ZDICTCoverParams>
implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZDICTCoverParams.Buffer	An array of ZDICTCoverParams 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	ALIGNOF	The struct alignment in bytes.
static final int	D	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
ZDICTCoverParams(ByteBuffer container)	Creates a ZDICTCoverParams instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new ZDICTCoverParams.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ZDICTCoverParams	calloc(MemoryStack stack)	Returns a new ZDICTCoverParams instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ZDICTCoverParams	callocStack()	Deprecated.
static ZDICTCoverParams.Buffer	callocStack(int capacity)	Deprecated.
static ZDICTCoverParams.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static ZDICTCoverParams	callocStack(MemoryStack stack)	Deprecated.
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 @Nullable ZDICTCoverParams	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable ZDICTCoverParams.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	d()
ZDICTCoverParams	d(int value)	Sets the specified value to the d field.
int	k()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new ZDICTCoverParams.Buffer instance allocated on the specified MemoryStack.
static ZDICTCoverParams	malloc(MemoryStack stack)	Returns a new ZDICTCoverParams instance allocated on the specified MemoryStack.
static ZDICTCoverParams	mallocStack()	Deprecated.
static ZDICTCoverParams.Buffer	mallocStack(int capacity)	Deprecated.
static ZDICTCoverParams.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static ZDICTCoverParams	mallocStack(MemoryStack stack)	Deprecated.
int	nbThreads()
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()	Returns sizeof(struct).
double	splitPoint()
ZDICTCoverParams	splitPoint(double value)	Sets the specified value to the splitPoint field.
int	steps()
ZDICTCoverParams	steps(int value)	Sets the specified value to the steps field.
ZDICTParams	zParams()
ZDICTCoverParams	zParams(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, validate, 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.

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 Details

ZDICTCoverParams

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<ZDICTCoverParams>

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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static ZDICTCoverParams mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static ZDICTCoverParams callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static ZDICTCoverParams mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ZDICTCoverParams callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static ZDICTCoverParams malloc(MemoryStack stack)

Returns a new ZDICTCoverParams instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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.