Modifier and Type	Class and Description
public static class	ZSTDSequence.Buffer An array of `ZSTDSequence` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	LITLENGTH The struct member offsets.
public static final int	MATCHLENGTH The struct member offsets.
public static final int	OFFSET The struct member offsets.
public static final int	REP The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Access	Constructor and Description
protected	ZSTDSequence(long address, ByteBuffer container)
public	ZSTDSequence(ByteBuffer container) Creates a `ZSTDSequence` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static ZSTDSequence	calloc() Returns a new `ZSTDSequence` instance allocated with `memCalloc`.
public static ZSTDSequence.Buffer	calloc(int the buffer capacity capacity) Returns a new `ZSTDSequence.Buffer` instance allocated with `memCalloc`.
public static ZSTDSequence	calloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDSequence` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZSTDSequence.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDSequence.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected ZSTDSequence	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 ZSTDSequence	create() Returns a new `ZSTDSequence` instance allocated with `BufferUtils`.
public static ZSTDSequence	create(long address) Returns a new `ZSTDSequence` instance for the specified memory address.
public static ZSTDSequence.Buffer	create(int the buffer capacity capacity) Returns a new `ZSTDSequence.Buffer` instance allocated with `BufferUtils`.
public static ZSTDSequence.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `ZSTDSequence.Buffer` instance at the specified memory.
public static ZSTDSequence	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static ZSTDSequence.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	litLength() literal length of the sequence
public static ZSTDSequence	malloc() Returns a new `ZSTDSequence` instance allocated with `memAlloc`.
public static ZSTDSequence.Buffer	malloc(int the buffer capacity capacity) Returns a new `ZSTDSequence.Buffer` instance allocated with `memAlloc`.
public static ZSTDSequence	malloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDSequence` instance allocated on the specified `MemoryStack`.
public static ZSTDSequence.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDSequence.Buffer` instance allocated on the specified `MemoryStack`.
public int	matchLength() match length of the sequence.
public static int	nlitLength(long struct) Unsafe version of `litLength`.
public static int	nmatchLength(long struct) Unsafe version of `matchLength`.
public static int	noffset(long struct) Unsafe version of `offset`.
public static int	nrep(long struct) Unsafe version of `rep`.
public int	offset() the offset of the match.
public int	rep() Represents which repeat offset is represented by the field `offset`.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

LITLENGTH	back to summary
public static final int LITLENGTH The struct member offsets.

MATCHLENGTH	back to summary
public static final int MATCHLENGTH The struct member offsets.

OFFSET	back to summary
public static final int OFFSET The struct member offsets.

REP	back to summary
public static final int REP The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

ZSTDSequence	back to summary
protected ZSTDSequence(long address, ByteBuffer container)

ZSTDSequence back to summary

ZSTDSequence	back to summary
public ZSTDSequence(ByteBuffer container) Creates a `ZSTDSequence` 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.

public ZSTDSequence(ByteBuffer container)

Creates a ZSTDSequence 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

calloc	back to summary
public static ZSTDSequence calloc() Returns a new `ZSTDSequence` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static ZSTDSequence.Buffer calloc(int capacity) Returns a new `ZSTDSequence.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static ZSTDSequence.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static ZSTDSequence calloc(MemoryStack stack) Returns a new `ZSTDSequence` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static ZSTDSequence calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static ZSTDSequence.Buffer calloc(int capacity, MemoryStack stack) Returns a new `ZSTDSequence.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

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

Returns a new ZSTDSequence.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

create back to summary

create	back to summary
protected ZSTDSequence 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

protected ZSTDSequence 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

create	back to summary
public static ZSTDSequence create() Returns a new `ZSTDSequence` instance allocated with `BufferUtils`.

create	back to summary
public static ZSTDSequence create(long address) Returns a new `ZSTDSequence` instance for the specified memory address.

create back to summary

create	back to summary
public static ZSTDSequence.Buffer create(int capacity) Returns a new `ZSTDSequence.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static ZSTDSequence.Buffer create(int capacity)

Returns a new ZSTDSequence.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static ZSTDSequence.Buffer create(long address, int capacity) Create a `ZSTDSequence.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a ZSTDSequence.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static ZSTDSequence createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static ZSTDSequence createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static ZSTDSequence.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

litLength	back to summary
public int litLength() literal length of the sequence Annotations @NativeType:unsigned int

litLength

back to summary

public int litLength()

literal length of the sequence

Annotations

@NativeType:unsigned int

malloc	back to summary
public static ZSTDSequence malloc() Returns a new `ZSTDSequence` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static ZSTDSequence.Buffer malloc(int capacity) Returns a new `ZSTDSequence.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static ZSTDSequence.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static ZSTDSequence malloc(MemoryStack stack) Returns a new `ZSTDSequence` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static ZSTDSequence malloc(MemoryStack stack)

Returns a new ZSTDSequence instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static ZSTDSequence.Buffer malloc(int capacity, MemoryStack stack) Returns a new `ZSTDSequence.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

matchLength back to summary

matchLength	back to summary
public int matchLength() match length of the sequence. Note Users of this API may provide a sequence with `matchLength == litLength == offset == 0`. In this case, we will treat the sequence as a marker for a block boundary. Annotations @NativeType:unsigned int

public int matchLength()

match length of the sequence.

Note

Users of this API may provide a sequence with matchLength == litLength == offset == 0. In this case, we will treat the sequence as a marker for a block boundary.

Annotations

@NativeType:unsigned int

nlitLength	back to summary
public static int nlitLength(long struct) Unsafe version of `litLength`.

nmatchLength	back to summary
public static int nmatchLength(long struct) Unsafe version of `matchLength`.

noffset	back to summary
public static int noffset(long struct) Unsafe version of `offset`.

nrep	back to summary
public static int nrep(long struct) Unsafe version of `rep`.

offset back to summary

offset	back to summary
public int offset() the offset of the match. (NOT the same as the offset code) If `offset == 0` and `matchLength == 0`, this sequence represents the last literals in the block of `litLength` size. Annotations @NativeType:unsigned int

public int offset()

the offset of the match. (NOT the same as the offset code)

If offset == 0 and matchLength == 0, this sequence represents the last literals in the block of litLength size.

Annotations

@NativeType:unsigned int

rep back to summary

rep	back to summary
public int rep() Represents which repeat offset is represented by the field `offset`. Ranges from `[0, 3]`. Repeat offsets are essentially previous offsets from previous sequences sorted in recency order. For more detail, see `doc/zstd_compression_format.md`. `If rep == 0, then offset does not contain a repeat offset. If rep > 0: If litLength != 0: rep == 1 --> offset == repeat_offset_1 rep == 2 --> offset == repeat_offset_2 rep == 3 --> offset == repeat_offset_3 If litLength == 0: rep == 1 --> offset == repeat_offset_2 rep == 2 --> offset == repeat_offset_3 rep == 3 --> offset == repeat_offset_1 - 1` Note This field is optional. `generateSequences` will calculate the value of `rep`, but repeat offsets do not necessarily need to be calculated from an external sequence provider's perspective. For example, `compressSequences` does not use this `rep` field at all (as of now). Annotations @NativeType:unsigned int

public int rep()

Represents which repeat offset is represented by the field offset. Ranges from [0, 3].

Repeat offsets are essentially previous offsets from previous sequences sorted in recency order. For more detail, see doc/zstd_compression_format.md.


If rep == 0, then offset does not contain a repeat offset.
If rep > 0:
    If litLength != 0:
        rep == 1 --> offset == repeat_offset_1
        rep == 2 --> offset == repeat_offset_2
        rep == 3 --> offset == repeat_offset_3
    If litLength == 0:
        rep == 1 --> offset == repeat_offset_2
        rep == 2 --> offset == repeat_offset_3
        rep == 3 --> offset == repeat_offset_1 - 1

Note

This field is optional. generateSequences will calculate the value of rep, but repeat offsets do not necessarily need to be calculated from an external sequence provider's perspective. For example, compressSequences does not use this rep field at all (as of now).

Annotations

@NativeType:unsigned int

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.util.zstd back to summary

public Class ZSTDSequence.Buffer

Class Inheritance

extends StructBuffer<ZSTDSequence, ZSTDSequence.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of ZSTDSequence structs.

Field Summary

Modifier and Type	Field and Description
private static final ZSTDSequence	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `ZSTDSequence.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 Type	Method and Description
protected ZSTDSequence	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `ZSTDSequence#litLength` field. litLength()
public int	Returns: the value of the `ZSTDSequence#matchLength` field. matchLength()
public int	Returns: the value of the `ZSTDSequence#offset` field. offset()
public int	Returns: the value of the `ZSTDSequence#rep` field. rep()
protected ZSTDSequence.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final ZSTDSequence ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `ZSTDSequence.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 `ZSTDSequence#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

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

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

getElementFactory	back to summary
protected ZSTDSequence getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected ZSTDSequence getElementFactory()

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

Annotations

@Override

litLength	back to summary
public int litLength() Returns:int the value of the `ZSTDSequence#litLength` field. Annotations @NativeType:unsigned int

matchLength	back to summary
public int matchLength() Returns:int the value of the `ZSTDSequence#matchLength` field. Annotations @NativeType:unsigned int

offset	back to summary
public int offset() Returns:int the value of the `ZSTDSequence#offset` field. Annotations @NativeType:unsigned int

rep	back to summary
public int rep() Returns:int the value of the `ZSTDSequence#rep` field. Annotations @NativeType:unsigned int

self	back to summary
protected ZSTDSequence.Buffer self() Implements abstract org.lwjgl.system.CustomBuffer.self. Annotations @Override

self

back to summary

protected ZSTDSequence.Buffer self()

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

Annotations

@Override

public Class ZSTDSequence

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ZSTDSequence.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail