tudocomp
– The TU Dortmund Compression Framework
tdc::LZWCompressor< coder_t, dict_t > Class Template Reference

#include <LZWCompressor.hpp>

Inheritance diagram for tdc::LZWCompressor< coder_t, dict_t >:
tdc::Compressor tdc::Algorithm

Public Member Functions

 LZWCompressor (Env &&env)
 Maximum dictionary size before reset, 0 == unlimited. More...
 
virtual void compress (Input &input, Output &out) override
 Compress the given input to the given output. More...
 
virtual void decompress (Input &input, Output &output) override final
 Decompress the given input to the given output. More...
 
- Public Member Functions inherited from tdc::Compressor
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...
 
- 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
 

Static Public Member Functions

static Meta meta ()
 

Detailed Description

template<typename coder_t, typename dict_t>
class tdc::LZWCompressor< coder_t, dict_t >

Definition at line 20 of file LZWCompressor.hpp.

Constructor & Destructor Documentation

◆ LZWCompressor()

template<typename coder_t , typename dict_t >
tdc::LZWCompressor< coder_t, dict_t >::LZWCompressor ( Env &&  env)
inline

Maximum dictionary size before reset, 0 == unlimited.

Definition at line 26 of file LZWCompressor.hpp.

Member Function Documentation

◆ compress()

template<typename coder_t , typename dict_t >
virtual void tdc::LZWCompressor< coder_t, dict_t >::compress ( Input &  input,
Output &  output 
)
inlineoverridevirtual

Compress the given input to the given output.

Parameters
inputThe input.
outputThe output.

Implements tdc::Compressor.

Definition at line 39 of file LZWCompressor.hpp.

◆ decompress()

template<typename coder_t , typename dict_t >
virtual void tdc::LZWCompressor< coder_t, dict_t >::decompress ( Input &  input,
Output &  output 
)
inlinefinaloverridevirtual

Decompress the given input to the given output.

Parameters
inputThe input.
outputThe output.

Implements tdc::Compressor.

Definition at line 110 of file LZWCompressor.hpp.

◆ meta()

template<typename coder_t , typename dict_t >
static Meta tdc::LZWCompressor< coder_t, dict_t >::meta ( )
inlinestatic

Definition at line 31 of file LZWCompressor.hpp.


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