tudocomp
– The TU Dortmund Compression Framework
tdc::ChainCompressor Class Reference

#include <ChainCompressor.hpp>

Inheritance diagram for tdc::ChainCompressor:
tdc::Compressor tdc::Algorithm

Public Member Functions

 ChainCompressor ()=delete
 No default construction allowed. More...
 
 ChainCompressor (Env &&env)
 Construct the class with an environment and the algorithms to chain. More...
 
template<class F >
void chain (Input &input, Output &output, bool reverse, F f)
 
virtual void compress (Input &input, Output &output) overridefinal
 Compress inp into out. More...
 
virtual void decompress (Input &input, Output &output) overridefinal
 Decompress inp into out. More...
 
- Public Member Functions inherited from tdc::Compressor
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...
 
- 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
 

Static Public Member Functions

static Meta meta ()
 

Detailed Description

Definition at line 14 of file ChainCompressor.hpp.

Constructor & Destructor Documentation

tdc::ChainCompressor::ChainCompressor ( )
inlinedelete

No default construction allowed.

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

Construct the class with an environment and the algorithms to chain.

Definition at line 27 of file ChainCompressor.hpp.

Member Function Documentation

template<class F >
void tdc::ChainCompressor::chain ( Input input,
Output output,
bool  reverse,
f 
)
inline

Definition at line 31 of file ChainCompressor.hpp.

virtual void tdc::ChainCompressor::compress ( Input input,
Output output 
)
inlinefinaloverridevirtual

Compress inp into out.

Parameters
inputThe input stream.
outputThe output stream.

Implements tdc::Compressor.

Definition at line 69 of file ChainCompressor.hpp.

virtual void tdc::ChainCompressor::decompress ( Input input,
Output output 
)
inlinefinaloverridevirtual

Decompress inp into out.

Parameters
inputThe input stream.
outputThe output stream.

Implements tdc::Compressor.

Definition at line 88 of file ChainCompressor.hpp.

static Meta tdc::ChainCompressor::meta ( )
inlinestatic

Definition at line 16 of file ChainCompressor.hpp.


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