Improve documentation of seqStore_t

This commit is contained in:
senhuang42
2020-10-27 10:50:22 -04:00
parent 96b0ff7886
commit 9171f920cd
3 changed files with 23 additions and 22 deletions
+13 -13
View File
@@ -1115,24 +1115,24 @@ typedef struct ZSTD_CCtx_params_s ZSTD_CCtx_params;
typedef struct {
unsigned int offset; /* The offset of the match.
* If == 0, then represents a block of literals, determined by litLength
*/
* If == 0, then represents a block of literals, determined by litLength
*/
unsigned int litLength; /* Literal length */
unsigned int matchLength; /* Match length. */
unsigned int rep; /* Represents which repeat offset is used. Ranges from [0, 3].
* If rep == 0, then this sequence does not contain a repeat offset.
* Otherwise:
* 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
*/
* If rep == 0, then this sequence does not contain a repeat offset.
* Otherwise:
* 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
*/
} ZSTD_Sequence;
typedef struct {