added a few comments for clarifications

This commit is contained in:
Yann Collet 2018-10-26 15:21:52 -07:00
parent 450356b5af
commit 8d56f4baee
3 changed files with 9 additions and 3 deletions

View File

@ -139,7 +139,7 @@ struct ZSTD_matchState_t {
U32* hashTable3; U32* hashTable3;
U32* chainTable; U32* chainTable;
optState_t opt; /* optimal parser state */ optState_t opt; /* optimal parser state */
const ZSTD_matchState_t *dictMatchState; const ZSTD_matchState_t * dictMatchState;
ZSTD_compressionParameters cParams; ZSTD_compressionParameters cParams;
}; };

View File

@ -323,7 +323,9 @@ static void ZSTD_buildSeqTable_rle(ZSTD_seqSymbol* dt, U32 baseValue, U32 nbAddB
/* ZSTD_buildFSETable() : /* ZSTD_buildFSETable() :
* generate FSE decoding table for one symbol (ll, ml or off) */ * generate FSE decoding table for one symbol (ll, ml or off)
* cannot fail if input is valid =>
* all inputs are presumed validated at this stage */
void void
ZSTD_buildFSETable(ZSTD_seqSymbol* dt, ZSTD_buildFSETable(ZSTD_seqSymbol* dt,
const short* normalizedCounter, unsigned maxSymbolValue, const short* normalizedCounter, unsigned maxSymbolValue,

View File

@ -18,6 +18,7 @@
#include <stddef.h> /* size_t */ #include <stddef.h> /* size_t */
#include "zstd.h" /* DCtx, and some public functions */ #include "zstd.h" /* DCtx, and some public functions */
#include "zstd_internal.h" /* blockProperties_t, and some public functions */ #include "zstd_internal.h" /* blockProperties_t, and some public functions */
#include "zstd_decompress_internal.h" /* ZSTD_seqSymbol */
/* === Prototypes === */ /* === Prototypes === */
@ -44,7 +45,10 @@ size_t ZSTD_decompressBlock_internal(ZSTD_DCtx* dctx,
/* ZSTD_buildFSETable() : /* ZSTD_buildFSETable() :
* generate FSE decoding table for one symbol (ll, ml or off) * generate FSE decoding table for one symbol (ll, ml or off)
* this function cannot fail * this function must be called with valid parameters only
* (dt is large enough, normalizedCounter distribution total is a power of 2, max is within range, etc.)
* in which case it cannot fail.
* Internal use only.
*/ */
void ZSTD_buildFSETable(ZSTD_seqSymbol* dt, void ZSTD_buildFSETable(ZSTD_seqSymbol* dt,
const short* normalizedCounter, unsigned maxSymbolValue, const short* normalizedCounter, unsigned maxSymbolValue,