TPIE

2362a60
tpie::compression_scheme Class Referenceabstract

Abstract virtual base class for each compression scheme. More...

#include <tpie/compressed/scheme.h>

Public Types

enum  type { none = 0, snappy = 1 }
 

Public Member Functions

virtual size_t max_compressed_length (size_t srcSize) const =0
 An upper bound on the size of a compressed block corresponding to an uncompressed input of size srcSize. More...
 
virtual void compress (char *dest, const char *src, size_t srcSize, size_t *destSize) const =0
 Compress data from src into dest, returning its size in destSize. More...
 
virtual size_t uncompressed_length (const char *src, size_t srcSize) const =0
 Get the uncompressed size of the compressed block at src. More...
 
virtual void uncompress (char *dest, const char *src, size_t srcSize) const =0
 Uncompress a compressed block at src into dest. More...
 

Detailed Description

Abstract virtual base class for each compression scheme.

Definition at line 50 of file scheme.h.

Member Function Documentation

virtual void tpie::compression_scheme::compress ( char *  dest,
const char *  src,
size_t  srcSize,
size_t *  destSize 
) const
pure virtual

Compress data from src into dest, returning its size in destSize.

virtual size_t tpie::compression_scheme::max_compressed_length ( size_t  srcSize) const
pure virtual

An upper bound on the size of a compressed block corresponding to an uncompressed input of size srcSize.

By the pigeonhole principle, the upper bound for a given srcSize must be greater than or equal to srcSize.

virtual void tpie::compression_scheme::uncompress ( char *  dest,
const char *  src,
size_t  srcSize 
) const
pure virtual

Uncompress a compressed block at src into dest.

virtual size_t tpie::compression_scheme::uncompressed_length ( const char *  src,
size_t  srcSize 
) const
pure virtual

Get the uncompressed size of the compressed block at src.


The documentation for this class was generated from the following file: