tudocomp
– The TU Dortmund Compression Framework
tdc::HuffmanCoder::Encoder Class Reference

#include <HuffmanCoder.hpp>

Inheritance diagram for tdc::HuffmanCoder::Encoder:
tdc::Encoder tdc::Algorithm

Public Member Functions

template<typename literals_t >
 Encoder (Env &&env, std::shared_ptr< BitOStream > out, literals_t &&literals)
 
 ~Encoder ()
 
template<typename literals_t >
 Encoder (Env &&env, Output &out, literals_t &&literals)
 
template<typename value_t >
void encode (value_t v, const LiteralRange &)
 
- Public Member Functions inherited from tdc::Encoder
template<typename literals_t >
 Encoder (Env &&env, std::shared_ptr< BitOStream > out, literals_t &&literals)
 Constructor. More...
 
template<typename literals_t >
 Encoder (Env &&env, Output &out, literals_t &&literals)
 Convenience constructor. More...
 
template<typename value_t >
void encode (value_t v, const Range &r)
 Encodes an arbitrary-range integer value. More...
 
template<typename value_t >
void encode (value_t v, const BitRange &r)
 Encodes a bit. More...
 
const std::shared_ptr< BitOStream > & stream ()
 
- 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
 

Additional Inherited Members

- Protected Attributes inherited from tdc::Encoder
std::shared_ptr< BitOStreamm_out
 The underlying bit output stream. More...
 

Detailed Description

Definition at line 521 of file coders/HuffmanCoder.hpp.

Constructor & Destructor Documentation

◆ Encoder() [1/2]

template<typename literals_t >
tdc::HuffmanCoder::Encoder::Encoder ( Env &&  env,
std::shared_ptr< BitOStream out,
literals_t &&  literals 
)
inline

Definition at line 526 of file coders/HuffmanCoder.hpp.

◆ ~Encoder()

tdc::HuffmanCoder::Encoder::~Encoder ( )
inline

Definition at line 549 of file coders/HuffmanCoder.hpp.

◆ Encoder() [2/2]

template<typename literals_t >
tdc::HuffmanCoder::Encoder::Encoder ( Env &&  env,
Output out,
literals_t &&  literals 
)
inline

Definition at line 556 of file coders/HuffmanCoder.hpp.

Member Function Documentation

◆ encode()

template<typename value_t >
void tdc::HuffmanCoder::Encoder::encode ( value_t  v,
const LiteralRange  
)
inline

Definition at line 563 of file coders/HuffmanCoder.hpp.


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