tudocomp
– The TU Dortmund Compression Framework
tdc::Compressor Class Referenceabstract

Base for data compressors. More...

#include <Compressor.hpp>

Inheritance diagram for tdc::Compressor:
tdc::Algorithm tdc::BWTCompressor< text_t > tdc::ChainCompressor tdc::EspCompressor< slp_coder_t, ipd_t > tdc::LCPCompressor< coder_t, strategy_t, dec_t, text_t > tdc::lfs::LFS2BSTCompressor< literal_coder_t, len_coder_t > tdc::lfs::LFS2Compressor< literal_coder_t, len_coder_t > tdc::lfs::LFSCompressor< comp_strategy_t, coding_strat_t > tdc::LiteralEncoder< coder_t > tdc::LZ78Compressor< coder_t, dict_t > tdc::LZ78UCompressor< strategy_t, ref_coder_t > tdc::LZSSLCPCompressor< coder_t, text_t > tdc::LZSSSlidingWindowCompressor< coder_t > tdc::LZWCompressor< coder_t, dict_t > tdc::MTFCompressor tdc::NoopCompressor tdc::RePairCompressor< coder_t > tdc::RunLengthEncoder

Public Member Functions

virtual ~Compressor ()=default
 
 Compressor (Compressor const &)=default
 
 Compressor (Compressor &&)=default
 
Compressor & operator= (Compressor const &)=default
 
Compressor & operator= (Compressor &&)=default
 
 Compressor (Env &&env)
 Construct the compressor with an environment. More...
 
virtual void compress (Input &input, Output &output)=0
 Compress the given input to the given output. More...
 
virtual void decompress (Input &input, Output &output)=0
 Decompress the given input to the given output. More...
 
- Public Member Functions inherited from tdc::Algorithm
virtual ~Algorithm ()=default
 
 Algorithm (Algorithm const &)=default
 
 Algorithm (Algorithm &&)=default
 
Algorithm & operator= (Algorithm const &)=default
 
Algorithm & operator= (Algorithm &&)=default
 
 Algorithm (Env &&env)
 Instantiates an algorithm in the specified environment. More...
 
Env & env ()
 Provides access to the environment that the algorithm works in. More...
 
const Env & env () const
 

Detailed Description

Base for data compressors.

A compressor defines the two operations compress and decompress. The compress operation transforms an input into a different representation with the goal of reducing the required memory. The decompress operation restores the original input from such a representation.

Definition at line 19 of file Compressor.hpp.

Constructor & Destructor Documentation

◆ ~Compressor()

virtual tdc::Compressor::~Compressor ( )
virtualdefault

◆ Compressor() [1/3]

tdc::Compressor::Compressor ( Compressor const &  )
default

◆ Compressor() [2/3]

tdc::Compressor::Compressor ( Compressor &&  )
default

◆ Compressor() [3/3]

tdc::Compressor::Compressor ( Env &&  env)
inline

Construct the compressor with an environment.

Parameters
envThe algorithm's environment.

Definition at line 30 of file Compressor.hpp.

Member Function Documentation

◆ compress()

◆ decompress()

◆ operator=() [1/2]

Compressor& tdc::Compressor::operator= ( Compressor const &  )
default

◆ operator=() [2/2]

Compressor& tdc::Compressor::operator= ( Compressor &&  )
default

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