CMSIS2000  0.0.7
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Utils/compress/lz4/lz4_format_description.txt File Reference

Functions

LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for and speed There
is no entropy encoder backend
nor framing layer The latter
is assumed to be handled by
other parts of the system This
document only describes the
not how the LZ4 compressor nor
decompressor actually work The
correctness of the
decompressor should not depend
on implementation details of
the and vice versa Compressed
stream format An LZ4
compressed stream is composed
of sequences a sequence is a
suite of followed by a match
copy Each sequence starts with
a token The token is a one
byte separated into two bits
fields Therefore each field
ranges from to The first field
uses the high bits of the
token It provides the length
of literals to 
follow (Note:a literal is a not-compressed byte).If the field value is 0

Variables

LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for 
compactness
LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for and speed There
is no entropy encoder backend
nor framing layer The latter
is assumed to be handled by
other parts of the system This
document only describes the
not how the LZ4 compressor nor
decompressor actually work The
correctness of the
decompressor should not depend
on implementation details of
the 
compressor
LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for and speed There
is no entropy encoder backend
nor framing layer The latter
is assumed to be handled by
other parts of the system This
document only describes the 
format
LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for and speed There
is no entropy encoder backend
nor framing layer The latter
is assumed to be handled by
other parts of the system This
document only describes the
not how the LZ4 compressor nor
decompressor actually work The
correctness of the
decompressor should not depend
on implementation details of
the and vice versa Compressed
stream format An LZ4
compressed stream is composed
of sequences a sequence is a
suite of followed by a match
copy Each sequence starts with
a token The token is a one
byte separated into two bits
fields Therefore each field
ranges from to The first field
uses the high bits of the
token It provides the length
of literals to then there is
no literal If it 
is
LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for and speed There
is no entropy encoder backend
nor framing layer The latter
is assumed to be handled by
other parts of the system This
document only describes the
not how the LZ4 compressor nor
decompressor actually work The
correctness of the
decompressor should not depend
on implementation details of
the and vice versa Compressed
stream format An LZ4
compressed stream is composed
of sequences a sequence is a
suite of 
literals
LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for 
optimisations
LZ4 Format Description Last revised
LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for and speed There
is no entropy encoder backend
nor framing layer The latter
is assumed to be handled by
other parts of the system This
document only describes the
not how the LZ4 compressor nor
decompressor actually work The
correctness of the
decompressor should not depend
on implementation details of
the and vice versa Compressed
stream format An LZ4
compressed stream is composed
of sequences 
Schematically
LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for and speed There
is no entropy encoder backend
nor framing layer The latter
is assumed to be handled by
other parts of the system This
document only describes the
not how the LZ4 compressor nor
decompressor actually work The
correctness of the
decompressor should not depend
on implementation details of
the and vice versa Compressed
stream format An LZ4
compressed stream is composed
of sequences a sequence is a
suite of followed by a match
copy Each sequence starts with
a token The token is a one
byte separated into two bits
fields Therefore each field
ranges from to The first field
uses the high bits of the
token It provides the length
of literals to then there is
no literal If it then we need
to add some more bytes to
indicate the full length Each
additionnal byte then
represent a value from 
to
LZ4 Format Description Last
byte oriented encoding The
most important design
principle behind LZ4 is
simplicity It helps to create
an easy to read and maintain
source code It also helps
later on for and speed There
is no entropy encoder backend
nor framing layer The latter
is assumed to be handled by
other parts of the system This
document only describes the
not how the LZ4 compressor nor
decompressor actually work The
correctness of the
decompressor should not depend
on implementation details of
the and vice versa Compressed
stream format An LZ4
compressed stream is composed
of sequences a sequence is a
suite of followed by a match
copy Each sequence starts with
a token The token is a one
byte 
value

Function Documentation

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for and speed There is no entropy encoder backend nor framing layer The latter is assumed to be handled by other parts of the system This document only describes the not how the LZ4 compressor nor decompressor actually work The correctness of the decompressor should not depend on implementation details of the and vice versa Compressed stream format An LZ4 compressed stream is composed of sequences a sequence is a suite of followed by a match copy Each sequence starts with a token The token is a one byte separated into two bits fields Therefore each field ranges from to The first field uses the high bits of the token It provides the length of literals to follow ( Note:a literal is a not-compressed  byte)

Variable Documentation

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for compactness

Definition at line 11 of file lz4_format_description.txt.

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for and speed There is no entropy encoder backend nor framing layer The latter is assumed to be handled by other parts of the system This document only describes the not how the LZ4 compressor nor decompressor actually work The correctness of the decompressor should not depend on implementation details of the compressor

Definition at line 11 of file lz4_format_description.txt.

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for and speed There is no entropy encoder backend nor framing layer The latter is assumed to be handled by other parts of the system This document only describes the format

Definition at line 11 of file lz4_format_description.txt.

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for and speed There is no entropy encoder backend nor framing layer The latter is assumed to be handled by other parts of the system This document only describes the not how the LZ4 compressor nor decompressor actually work The correctness of the decompressor should not depend on implementation details of the and vice versa Compressed stream format An LZ4 compressed stream is composed of sequences a sequence is a suite of followed by a match copy Each sequence starts with a token The token is a one byte separated into two bits fields Therefore each field ranges from to The first field uses the high bits of the token It provides the length of literals to then there is no literal If it then we need to add some more bytes to indicate the full length Each additionnal byte then represent a value from which is added to the previous value to produce a total length When the byte value is

Definition at line 39 of file lz4_format_description.txt.

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for and speed There is no entropy encoder backend nor framing layer The latter is assumed to be handled by other parts of the system This document only describes the not how the LZ4 compressor nor decompressor actually work The correctness of the decompressor should not depend on implementation details of the and vice versa Compressed stream format An LZ4 compressed stream is composed of sequences a sequence is a suite of literals

Definition at line 11 of file lz4_format_description.txt.

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for optimisations

Definition at line 11 of file lz4_format_description.txt.

LZ4 Format Description Last revised

Definition at line 11 of file lz4_format_description.txt.

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for and speed There is no entropy encoder backend nor framing layer The latter is assumed to be handled by other parts of the system This document only describes the not how the LZ4 compressor nor decompressor actually work The correctness of the decompressor should not depend on implementation details of the and vice versa Compressed stream format An LZ4 compressed stream is composed of sequences Schematically

Definition at line 11 of file lz4_format_description.txt.

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for and speed There is no entropy encoder backend nor framing layer The latter is assumed to be handled by other parts of the system This document only describes the not how the LZ4 compressor nor decompressor actually work The correctness of the decompressor should not depend on implementation details of the and vice versa Compressed stream format An LZ4 compressed stream is composed of sequences a sequence is a suite of followed by a match copy Each sequence starts with a token The token is a one byte separated into two bits fields Therefore each field ranges from to The first field uses the high bits of the token It provides the length of literals to then there is no literal If it then we need to add some more bytes to indicate the full length Each additionnal byte then represent a value from to

Definition at line 39 of file lz4_format_description.txt.

LZ4 Format Description Last byte oriented encoding The most important design principle behind LZ4 is simplicity It helps to create an easy to read and maintain source code It also helps later on for and speed There is no entropy encoder backend nor framing layer The latter is assumed to be handled by other parts of the system This document only describes the not how the LZ4 compressor nor decompressor actually work The correctness of the decompressor should not depend on implementation details of the and vice versa Compressed stream format An LZ4 compressed stream is composed of sequences a sequence is a suite of followed by a match copy Each sequence starts with a token The token is a one byte value

Definition at line 11 of file lz4_format_description.txt.