tdc::Encoder Class Reference

Base for data encoders. More...

#include <Coder.hpp>

Inheritance diagram for tdc::Encoder:

Public Member Functions
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
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

Protected Attributes
std::shared_ptr< BitOStream >	m_out
	The underlying bit output stream. More...

Detailed Description

Base for data encoders.

Used for encoding integer values to a certain bit representation.

Definition at line 14 of file Coder.hpp.

Constructor & Destructor Documentation

Encoder() [1/2]

template<typename literals_t >

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

inline

Constructor.

Template Parameters

literals_t

The literal iterator type.

Parameters

env	The algorithm's environment.
out	The bit stream to write to.
literals	The literal iterator.

Definition at line 29 of file Coder.hpp.

Encoder() [2/2]

template<typename literals_t >

tdc::Encoder::Encoder ( Env &&  env, Output &  out, literals_t &&  literals  )

inline

Convenience constructor.

Template Parameters

literals_t

The literal iterator type.

Parameters

env	The algorithm's environment.
out	The output to write to.
literals	The literal iterator.

Definition at line 44 of file Coder.hpp.

Member Function Documentation

encode() [1/2]

template<typename value_t >

void tdc::Encoder::encode ( value_t  v, const Range &  r  )

inline

Encodes an arbitrary-range integer value.

This default implementation computes the amount of bits required to store an integer value of the given range and writes its binary representation to the output.

Template Parameters

value_t

The input value type.

Parameters

v	The integer value to encode.
r	The value range.

Definition at line 61 of file Coder.hpp.

encode() [2/2]

template<typename value_t >

void tdc::Encoder::encode ( value_t  v, const BitRange &  r  )

inline

Encodes a bit.

This default implementation will write exactly one bit to the output. A zero bit is written if the given value is zero, a one bit is written otherwise.

Template Parameters

value_t

The input value type.

Parameters

v	The value to encode.
r	Unused.

Definition at line 75 of file Coder.hpp.

stream()

const std::shared_ptr<BitOStream>& tdc::Encoder::stream ( )

inline

Definition at line 79 of file Coder.hpp.

Member Data Documentation

m_out

std::shared_ptr<BitOStream> tdc::Encoder::m_out

protected

The underlying bit output stream.

Definition at line 18 of file Coder.hpp.

---

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

• Coder.hpp