Compression

Compressors that can be used to compress data before writing. More...

Detailed Description

Files
file	/__w/gridformat/gridformat/gridformat/compression/common.hpp
	Common classes used in the context of data compression.
file	/__w/gridformat/gridformat/gridformat/compression/concepts.hpp
	Concepts related to data compression.
file	/__w/gridformat/gridformat/gridformat/compression/decompress.hpp
	Decompress compressed data.
file	/__w/gridformat/gridformat/gridformat/compression/lz4.hpp
	Compressor using the LZ4 library.
file	/__w/gridformat/gridformat/gridformat/compression/lzma.hpp
	Compressor using the LZMA library.
file	/__w/gridformat/gridformat/gridformat/compression/zlib.hpp
	Compressor using the ZLIB library.

Concepts
concept	GridFormat::Concepts::Compressor
	Concept that compressors must fulfill.
concept	GridFormat::Concepts::Decompressor
	Concept that decompressors must fulfill.
concept	GridFormat::Concepts::BlockDecompressor
	Concept that block decompressors must fulfill.

Classes
struct	GridFormat::Compression::Blocks< HeaderType >
	Stores the block sizes used for compressing the given amount of bytes. More...
struct	GridFormat::Compression::CompressedBlocks< HeaderType >
	Stores the uncompressed/compressed block sizes after completion of a compression. More...
struct	GridFormat::Compression::LZ4Options
	Options for the lz4 compressor. More...
class	GridFormat::Compression::LZ4
	Compressor using the lz4 compression library. More...
struct	GridFormat::Compression::LZMAOptions
	Options for the lzma compressor. More...
class	GridFormat::Compression::LZMA
	Compressor using the lzma library. More...
struct	GridFormat::Compression::ZLIBOptions
	Options for the zlib compressor. More...
class	GridFormat::Compression::ZLIB
	Compressor using the zlib library. More...

Functions
template<std::integral HeaderType, Concepts::BlockDecompressor Decompressor>
void	GridFormat::Compression::decompress (Serialization &in, const CompressedBlocks< HeaderType > &blocks, const Decompressor &block_decompressor)
	Decompress compressed data.

Variables
constexpr std::size_t	GridFormat::Compression::default_block_size = (1 << 15)
	as in VTK (https://gitlab.kitware.com/vtk/vtk/-/blob/65fc526a83ac829628a9462f61fa57f1801e2c7e/IO/XML/vtkXMLWriterBase.cxx#L44)
constexpr LZ4	GridFormat::Compression::lz4
	Instance of the lz4 compressor.
constexpr LZMA	GridFormat::Compression::lzma
	Instance of the lzma compressor.
constexpr ZLIB	GridFormat::Compression::zlib
	Instance of the zlib compressor.