ZSTDMT_getBuffer() : * assumption : bufPool must be valid * @return : a buffer, with start pointer and size * note: allocation may fail, in this

ZSTDMT_releaseAllJobResources() : * note : ensure all workers are killed first ! */

store buffer for later re-use, up to pool capacity */

ZSTDMT_setBufferSize() : * all future buffers provided by this buffer pool will have _at least_ this size * note : it's better for all buffers to ha

Returns 1 if compression parameters are such that we should * enable long distance matching (wlog >= 27, strategy >= btopt). * Returns 0 otherwise.

Returns 1 if compression parameters are such that we should * enable blockSplitter (wlog >= 17, strategy >= btopt). * Returns 0 otherwise. */

ZSTD_MLcode() : * note : mlBase = matchLength - MINMATCH; * because it's the format it's stored in seqStore->sequences */

The high-level approach of the SIMD row based match finder is as follows: * - Figure out where to insert the new entry: * - Generate a hash fro

! ZSTD_buildSeqTable() : * @return : nb bytes read from src, * or an error code if it fails */

ZSTD_cParam_withinBounds: * @return 1 if value is within cParam bounds, * 0 otherwise */

ZSTD_compressBegin_usingCDict_internal() : * Implementation of various ZSTD_compressBegin_usingCDict* functions. */

ZSTD_compress_insertDictionary() : * @return : dictID, or an error code */

Returns literals bytes represented in a seqStore */

* Returns the cost in bits of encoding the distribution in count using the * table described by norm. The max symbol support by norm is assumed >= ma

* Moves the management of a workspace from one cwksp to another. The src cwksp * is left in an invalid state (src must be re-init()'ed before it's us

* Aligned on 64 bytes. These buffers have the special property that * their values remain constrained, allowing us to re-use them without * memset()

ZSTD_cycleLog() : * condition for correct operation : hashLog > 1 */

ZSTD_decodeFrameHeader() : * `headerSize` must be the size provided by ZSTD_frameHeaderSize(). * If multiple DDict references are enabled, also will

Dictionaries that assign zero probability to symbols that show up causes problems * when FSE encoding. Mark dictionaries with zero probability symbol

Returns the size estimate for the FSE-compressed symbols (of, ml, ll) of a block */

* Returns the cost in bits of encoding the distribution in count using ctable. * Returns an error if ctable cannot represent all the symbols in count

ZSTD_getFrameHeader_advanced() : * decode Frame Header, or require larger `srcSize`. * note : only works for formats ZSTD_f_zstd1 and ZSTD_f_zstd1

! ZSTD_getParams() : * same idea as ZSTD_getCParams() * @return a `ZSTD_parameters` structure (instead of `ZSTD_compressionParameters`). * Fields

! ZSTD_getcBlockSize() : * Provides the size of compressed block from block header `src` */

ZSTD_ldm_countBackwardsMatch() : * Returns the number of bytes that match backwards before pIn and pMatch. * * We count only bytes where pMatch >

! ZSTD_loadDictionaryContent() : * @return : 0, or an error code */

ZSTD_minGain() : * minimum compression required * to generate a compress block or a compressed literals section. * note : use same formula for both

* Similar to ZSTD_nextSrcSizeToDecompress(), but when when a block input can be streamed, * we allow taking a partial block as the input. Currently o

ZSTD_rotateRight_*(): * Rotates a bitfield to the right by "count" bits. * https://en.wikipedia.org/w/index.php?title=Circular_shift&oldid=991635599

ZSTD_row_prefetch(): * Performs prefetching for the hashTable and tagTable at a given row. */

After a compression call set the expected input/output buffer. * This is validated at the start of the next compression call. */

* ZSTD_window_clear(): * Clears the window containing the history by simply setting it to empty. */

This function returns a list containing the known CLIs. The tuples in this list are: (CLI name, parameter specification, description)

Exclusive usage, either hash is provided, either hash is computed, do not mix