claw::rle_encoder< OutputBuffer > Class Template Reference

A class to help run-length encoding (RLE) streams. More...

#include <rle_encoder.hpp>

Public Types
typedef OutputBuffer	output_buffer_type
	The type of the output buffer.
typedef output_buffer_type::pattern_type	pattern_type
	The type of the stored data.

Public Member Functions
template<typename Iterator >
void	encode (Iterator first, Iterator last, output_buffer_type &output) const
	Encode a range of datas.

Detailed Description

template<typename OutputBuffer>
class claw::rle_encoder< OutputBuffer >

A class to help run-length encoding (RLE) streams.

Template parameters :

• OutputBuffer The type of the output buffer.

The OutputBuffer type must have the following typedefs :

• pattern_type, the type of the stored data.

The OutputBuffer type must have the following methods :

• encode( unsigned int n, pattern_type pattern ), code n times the pattern ;
• template<typename Iterator> raw( Iterator first, Iterator last ) ;
• unsigned int min_interesting() returns the minimum number of time we must have the same value before compressing it ;
• unsigned int max_encodable() return the maximum number of time we can have the same value before compressing it.

Author

Julien Jorge

Definition at line 58 of file rle_encoder.hpp.

Member Function Documentation

template<typename OutputBuffer >

template<typename Iterator >

void claw::rle_encoder< OutputBuffer >::encode	(	Iterator	first,
		Iterator	last,
		output_buffer_type &	output
	)		const

Encode a range of datas.

Parameters

first	Iterator on the first data.
last	Iterator past the last data.
output	The buffer on which we write the compressed data.

Precondition

Iterator::value_type must be castable to pattern_type.

Definition at line 43 of file rle_encoder.tpp.

---

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

• rle_encoder.hpp
• impl/rle_encoder.tpp