zstd/common/fse.h

62 …                 if FSE_isError(return), compression failed (more details using FSE_getErrorName())
71               or an error code, which can be tested using FSE_isError() .
112 3. save normalized counters to memory buffer using writeNCount()
114 5. encode the data stream using encoding table 'CTable'
119 3. decode the data stream using decoding table 'DTable'
122 For example, it's possible to compress several blocks using the same 'CTable',
123 or to save and provide normalized distribution using external method.
130 …  It saves CPU time, by using smaller tables, while preserving or even improving compression ratio.
144               or an errorCode, which can be tested using FSE_isError() */
156               or an errorCode, which can be tested using FSE_isError(). */
168     Builds `ct`, which must be already allocated, using FSE_createCTable().
169     @return : 0, or an errorCode, which can be tested using FSE_isError() */
173     Compress `src` using `ct` into `dst` which must be already allocated.
176               or an errorCode, which can be tested using FSE_isError() */
188 If there is an error, the function will return an ErrorCode (which can be tested using FSE_isError(…
202 …d tableLog value), the function will return an ErrorCode (which can be tested using FSE_isError()).
204 'normalizedCounter' can be saved in a compact manner to a memory area using FSE_writeNCount().
208 If there is an error, the function will return an ErrorCode (which can be tested using FSE_isError(…
211 The space required by 'CTable' must be already allocated, using FSE_createCTable().
213 If there is an error, both functions will return an ErrorCode (which can be tested using FSE_isErro…
219 If there is an error, the function will return an ErrorCode (which can be tested using FSE_isError(…
228               or an errorCode, which can be tested using FSE_isError().
248     Builds 'dt', which must be already allocated, using FSE_createDTable().
249     return : 0, or an errorCode, which can be tested using FSE_isError() */
253     Decompress compressed source `cSrc` of size `cSrcSize` using `dt`
256               or an errorCode, which can be tested using FSE_isError() */
267 This can be performed by FSE_readNCount() if it was saved using FSE_writeNCount().
274 If there is an error, the function will return an error code, which can be tested using FSE_isError…
278 The space required by 'FSE_DTable' must be already allocated using FSE_createDTable().
279 If there is an error, the function will return an error code, which can be tested using FSE_isError…
284 If there is an error, the function will return an error code, which can be tested using FSE_isError…
304 … to statically allocate FSE CTable/DTable as a table of FSE_CTable/FSE_DTable using below macros */
321  * Same as FSE_compress2(), but using an externally allocated scratch buffer (`workSpace`).
334  * Same as FSE_buildCTable(), but using an externally allocated scratch buffer (`workSpace`).
345 /*< Same as FSE_buildDTable(), using an externally allocated `workspace` produced with `FSE_BUILD_D…
356 /*< same as FSE_decompress(), using an externally allocated `workSpace` produced with `FSE_DECOMPRE…
405 Note that BIT_initCStream() can produce an error code, so its result should be tested, using FSE_is…
426 If there is an error, it returns an errorCode (which can be tested using FSE_isError()).
485 After each decoded symbol, check if DStream is fully consumed using this simple test :
565 …* Approximate symbol cost, as fractional value, using fixed-point format (accuracyLog fractional b…