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
 
Compressoroperator= (Compressor const &)=default
 
Compressoroperator= (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
 
Algorithmoperator= (Algorithm const &)=default
 
Algorithmoperator= (Algorithm &&)=default
 
 Algorithm (Env &&env)
 Instantiates an algorithm in the specified environment. More...
 
Envenv ()
 Provides access to the environment that the algorithm works in. More...
 
const Envenv () 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

virtual tdc::Compressor::~Compressor ( )
virtualdefault
tdc::Compressor::Compressor ( Compressor const &  )
default
tdc::Compressor::Compressor ( Compressor &&  )
default
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

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

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