Lines Matching full:note
142 * note 1 : a 0 return value means the frame is valid but "empty".
143 …* note 2 : decompressed size is an optional field, it may not be present, typically in streaming…
149 …* note 3 : decompressed size is always present when compression is completed using single-pass f…
151 * note 4 : decompressed size can be very large (64-bits value),
154 * note 5 : If source is untrusted, decompressed size could be wrong or intentionally modified.
157 * note 6 : This function replaces ZSTD_getDecompressedSize() */
163 * NOTE: This function is now obsolete, in favor of ZSTD_getFrameContentSize().
197 * Note : re-using context is just a speed / resource optimization.
199 * Note 2 : In multi-threaded environments,
267 /* note : new strategies _might_ be added in the future.
274 * Note: When compressing with a ZSTD_CDict these parameters are superseded
278 * Note that exact compression parameters are dynamically determined,
282 * Note 1 : it's possible to pass a negative compression level.
283 … * Note 2 : setting a level does not automatically set all other compression parameters
296 * Note: Using a windowLog greater than ZSTD_WINDOWLOG_LIMIT_DEFAULT
317 * Note that Zstandard can still find matches of smaller size,
321 … * Note that currently, for all strategies < btopt, effective minimum is 4.
341 … * Note: enabling this parameter increases default ZSTD_c_windowLog to 128 MB
343 … * Note: will be enabled by default if ZSTD_c_windowLog >= 128 MB and
384 …* (note : a strong exception to this rule is when first invocation of ZSTD_compressStream2() sets …
407 /* note : additional experimental parameters are also available
425 * note : never ever use experimentalParam? names directly;
478 * Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame.
481 * Note 2 : pledgedSrcSize is only valid once, for the next frame.
483 * Note 3 : Whenever all input data is provided and consumed in a single round,
535 * Note : This API is compatible with existing ZSTD_decompressDCtx() and ZSTD_decompressStream().
548 /* note : additional experimental parameters are also available
556 * note : never ever use experimentalParam? names directly
620 * note : since v1.3.0, ZSTD_CStream and ZSTD_CCtx are the same thing.
632 * Note that the function may not consume the entire input, for example, because
637 * note: ZSTD_e_continue is guaranteed to make some forward progress when called,
647 * Note that, if `output->size` is too small, a single invocation with ZSTD_e_flush might not be en…
651 * note: ZSTD_e_flush will flush as much output as possible, meaning when compressing with multiple…
663 * note: ZSTD_e_end will flush as much output as possible, meaning when compressing with multiple t…
683 … * note : multithreaded compression will block to flush as much output as possible. */
685 … * note that frame is only closed after compressed data is fully flushed (return value == 0).
687 … * note : each frame is independent (does not reference any content from previous frame).
688 … : note : multithreaded compression will block to flush as much output as possible. */
724 * However, note that these recommendations are from the perspective of a C caller program.
754 * NOTE: The return value is different. ZSTD_compressStream() returns a hint for
784 * Note : with no additional input provided, amount of data flushed is necessarily <= ZSTD_BLOCKSIZ…
820 * Note : This function loads the dictionary, resulting in significant startup delay.
822 * Note 2 : When `dict == NULL || dictSize < 8` no dictionary is used. */
832 * Note : This function loads the dictionary, resulting in significant startup delay.
834 * Note : When `dict == NULL || dictSize < 8` no dictionary is used. */
853 …* Note 1 : Consider experimental function `ZSTD_createCDict_byReference()` if you prefer to not d…
854 * Note 2 : A ZSTD_CDict can be created from an empty @dictBuffer,
869 * Note : compression level is _decided at dictionary creation time_,
926 * Note : this use case also happens when using a non-conformant dictionary.
949 * Note 1 : Dictionary is sticky, it will be used for all future compressed frames.
951 * Note 2 : Loading a dictionary involves building tables.
955 * Note 3 :`dict` content will be copied internally.
958 * Note 4 : Use ZSTD_CCtx_loadDictionary_advanced()
964 * Note that compression parameters are enforced from within CDict,
971 * Note 1 : Currently, only one dictionary can be managed.
973 * Note 2 : CDict is just referenced, its lifetime must outlive its usage within CCtx. */
984 * Note 1 : Prefix buffer is referenced. It **must** outlive compression.
986 * Note 2 : If the intention is to diff some large src data blob with some prior version of itself,
989 …* Note 3 : Referencing a prefix involves building tables, which are dependent on compression para…
992 * Note 4 : By default, the prefix is interpreted as raw content (ZSTD_dct_rawContent).
1004 * Note 1 : Loading a dictionary involves building tables,
1007 * Note 2 :`dict` content will be copied internally, so `dict` can be released after loading.
1009 * Note 3 : Use ZSTD_DCtx_loadDictionary_advanced() to take control of
1025 * Note 1 : Currently, only one dictionary can be managed.
1028 * Note 2 : DDict is just referenced, its lifetime must outlive its usage from DCtx.
1039 * Note 1 : Adding any prefix (including NULL) invalidates any previously set prefix or dictionary
1040 * Note 2 : Prefix buffer is referenced. It **must** outlive decompression.
1043 * Note 3 : By default, the prefix is treated as raw content (ZSTD_dct_rawContent).
1045 * Note 4 : Referencing a raw content prefix has almost no cpu nor memory cost.
1055 * Note that object memory usage can evolve (increase or decrease) over time. */
1142 #define ZSTD_TARGETLENGTH_MIN 0 /* note : comparing this constant to an unsigned results in a…
1187 … /* Note: Users of this API may provide a sequence with matchLength == litLength == offset == 0.
1208 … * Note: This field is optional. ZSTD_generateSequences() will calculate the value of
1255 /* Note: this enum controls ZSTD_d_forceIgnoreChecksum */
1261 /* Note: this enum controls ZSTD_d_refMultipleDDicts */
1267 /* Note: this enum and the behavior it controls are effectively internal
1315 …/* Note: This enum controls features which are conditionally beneficial. Zstd typically will make …
1336 …* note 1 : decompressed size is an optional field, that may not be present, especially in stream…
1339 * note 2 : decompressed size is always present when compression is done with ZSTD_compress()
1340 * note 3 : decompressed size can be very large (64-bits value),
1343 * note 4 : If source is untrusted, decompressed size could be wrong or intentionally modified.
1346 …* note 5 : ZSTD_findDecompressedSize handles multiple frames, and so it must traverse the input …
1358 * note 1 : an error can occur if `src` contains an invalid or incorrectly formatted frame.
1359 …* note 2 : the upper-bound is exact when the decompressed size field is available in every ZSTD …
1361 …* note 3 : when the decompressed size field isn't available, the upper-bound for that frame is c…
1432 …* Note: Repcodes are, as of now, always re-calculated within this function, so ZSTD_Sequence::rep …
1433 …* Note 2: Once we integrate ability to ingest repcodes, the explicit block delims mode must respec…
1489 * Note : Unlike ZSTD_estimateCStreamSize*(), this estimate
1503 * Note 2 : only single-threaded compression is supported.
1517 * Note : CStream size estimation is only correct for single-threaded compression.
1521 * Note : if streaming is init with function ZSTD_init?Stream_usingDict(),
1533 * Note : dictionaries created by reference (`ZSTD_dlm_byRef`) are logically smaller.
1548 * Note : zstd will never resize nor malloc() when using a static buffer.
1551 * Note 2 : there is no corresponding "free" function.
1553 * Note 3 : cParams : use ZSTD_getCParams() to convert a compression level
1610 * Note that the lifetime of such pool must exist while being used.
1647 * note: equivalent to ZSTD_createCDict_advanced(), with dictLoadMethod==ZSTD_dlm_byRef */
1674 * Note : this function is now DEPRECATED.
1685 * Note : this function is now DEPRECATED.
1724 * NOTE 1: rsyncable mode only works when multithreading is enabled.
1725 * NOTE 2: rsyncable performs poorly in combination with long range mode,
1728 * NOTE 3: Rsyncable mode limits maximum compression speed to ~400 MB/s.
1752 * Set to ZSTD_ps_enable to always compress literals. (Note: uncompressed literals
1806 * Note that some of the members of the ZSTD_compressionParameters struct have
1818 * Note that this means that the CDict tables can no longer be copied into the
1846 * NOTE: ZSTD_compressStream2() will error if ZSTD_e_end is not used.
1849 * NOTE: So long as the ZSTD_inBuffer always points to valid memory, using
1928 * Note that this only pertains to compression strategies: greedy, lazy, and lazy2
2043 * Note : Frame Identifier is 4 bytes. If `size < 4`, @return will always be 0.
2044 * Note 2 : Legacy Frame Identifiers are considered valid only if Legacy Support is enabled.
2045 * Note 3 : Skippable Frame Identifiers are considered valid. */
2115 * NOTE: So long as the ZSTD_outBuffer always points to valid memory, using
2200 * ZSTD_CONTENTSIZE_UNKNOWN. Note that, for compatibility with older programs,
2217 * Note: dict is loaded with ZSTD_dct_auto (treated as a full zstd dictionary if
2252 * note : cdict will just be referenced, and must outlive compression session
2283 * Note: ZSTD_resetCStream() interprets pledgedSrcSize == 0 as ZSTD_CONTENTSIZE_UNKNOWN, but
2289 * Note that zcs must be init at least once before using ZSTD_resetCStream().
2313 * Note : (ingested - consumed) is amount of input data buffered internally, not yet compressed.
2342 * note: no dictionary will be used if dict == NULL or dictSize < 8
2343 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2353 * note : ddict is referenced, it must outlive decompression session
2354 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2364 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2410 …_compressBegin_usingCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict); /**< note: fails if cdict==NU…
2411 … const ZSTD_CCtx* preparedCCtx, unsigned long long pledgedSrcSize); /**< note: if pledgedSrcSize …
2438 …Note that these values could be wrong, either because of data corruption, or because a 3rd party d…
2457 Note that already decoded data stored in the buffer should be flushed before being overwritten.
2479 …Note : it's possible to know if next input to present is a header or a block, using ZSTD_nextInput…