Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the snappy Reference Manual, version 0.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 06:11:07 2022 GMT+0.
Next: Systems, Previous: The snappy Reference Manual, Up: The snappy Reference Manual [Contents][Index]
A Common Lisp implementation of Google's Snappy data compression library. The original name for Google's Snappy compression library was Zippy.
Compresses the contents of BUFFER, a vector of (UNSIGNED-BYTE 8), from position
INDEX to position LIMIT. Returns two values, a vector of type (UNSIGNED-BYTE 8)
holding the compressed data and an integer indicating the number of
compressed octets in the vector.
Returns the maximum size a vector of length UNCOMPRESSED-LENGTH may take up
after it is compressed.
Uncompresses BUFFER, a vector of (UNSIGNED-BYTE 8), from position INDEX to
LIMIT. Returns the uncompressed data as a vector of (UNSIGNED-BYTE 8).
Returns the uncompressed length of the compressed data stored in BUFFER from
position INDEX to LIMIT.
For more information, see the documentation strings in snappy.lisp, the example code in snappy-test.lisp, and Google's GitHub Snappy page.
Next: Files, Previous: Introduction, Up: The snappy Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
An implementation of Snappy compression.
Robert Brown <robert.brown@gmail.com>
New BSD license. See the copyright messages in individual files.
An implementation of Google’s Snappy compression algorithm, which is designed for speed of compression and decompression.
0.3
com.google.base (system).
Next: Packages, Previous: Systems, Up: The snappy Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: snappy/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
snappy (system).
Next: snappy/snappy.lisp, Previous: snappy/snappy.asd, Up: Lisp [Contents][Index]
snappy (system).
Previous: snappy/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
snappy (system).
Next: Definitions, Previous: Files, Up: The snappy Reference Manual [Contents][Index]
Packages are listed by definition order.
An implementation of Google’s Snappy compression algorithm, which is designed for speed of compression and decompression.
Next: Indexes, Previous: Packages, Up: The snappy Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Previous: Public Interface, Up: Public Interface [Contents][Index]
Compresses the contents of BUFFER, a vector of (UNSIGNED-BYTE 8), from
position INDEX to position LIMIT. Returns two values, a vector of
type (UNSIGNED-BYTE 8) holding the compressed data and an integer indicating
the number of compressed octets in the vector.
Returns the maximum size a vector of length UNCOMPRESSED-LENGTH may take up after it is compressed.
Uncompresses BUFFER, a vector of (UNSIGNED-BYTE 8), from position INDEX to LIMIT. Returns the uncompressed data as a vector of (UNSIGNED-BYTE 8).
Returns the uncompressed length of the compressed data stored in BUFFER from position INDEX to LIMIT.
Previous: Public Interface, Up: Definitions [Contents][Index]
Data stored per entry in lookup table:
Range Bits-used Description
————————————
1..64 0..7 Literal/copy length encoded in opcode byte
0..7 8..10 Copy offset encoded in opcode byte / 256
0..4 11..13 Extra bytes after opcode
We use eight bits for the length even though 7 would have sufficed
because of efficiency reasons:
(1) Extracting a byte is faster than a bit field
(2) It properly aligns copy offset so we do not need a <<8
Mapping from i in range [0,4] to a mask to extract the bottom 8*i bits.
Next: Ordinary functions, Previous: Constants, Up: Internals [Contents][Index]
Previous: Definitions, Up: The snappy Reference Manual [Contents][Index]
| Jump to: | C E F H M P R U |
|---|
| Jump to: | C E F H M P R U |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | +
C |
|---|
| Jump to: | +
C |
|---|
| Jump to: | D F H P S T |
|---|
| Jump to: | D F H P S T |
|---|