textwolf: textwolf::CharMap< RESTYPE, nullvalue_, RANGE > Class Template Reference

textwolf 0.2

Character map for fast typing of a character byte. More...

#include <char.hpp>

Inheritance diagram for textwolf::CharMap< RESTYPE, nullvalue_, RANGE >:

Public Types
enum	Constant { nullvalue =nullvalue_ }

typedef RESTYPE	valuetype

Public Member Functions
	CharMap ()
	Constructor. More...

CharMap &	operator() (unsigned char from, unsigned char to, valuetype value)
	Define the values of the elements in the interval [from,to]. More...

CharMap &	operator() (unsigned char at, valuetype value)
	Define the values of the single element at 'at'. More...

valuetype	operator[] (unsigned char ii) const
	Read the element assigned to 'ii'. More...

Detailed Description

template<typename RESTYPE, RESTYPE nullvalue_, int RANGE = 256>
class textwolf::CharMap< RESTYPE, nullvalue_, RANGE >

Character map for fast typing of a character byte.

Template Parameters

RESTYPE	result type of the map
nullvalue_	default intitialization value of the map
RANGE	domain of the input values of the map

Member Typedef Documentation

template<typename RESTYPE, RESTYPE nullvalue_, int RANGE = 256>

typedef RESTYPE textwolf::CharMap< RESTYPE, nullvalue_, RANGE >::valuetype

Member Enumeration Documentation

template<typename RESTYPE, RESTYPE nullvalue_, int RANGE = 256>

enum textwolf::CharMap::Constant

Enumerator
nullvalue

Constructor & Destructor Documentation

template<typename RESTYPE, RESTYPE nullvalue_, int RANGE = 256>

textwolf::CharMap< RESTYPE, nullvalue_, RANGE >::CharMap ( )

inline

Constructor.

Member Function Documentation

template<typename RESTYPE, RESTYPE nullvalue_, int RANGE = 256>

CharMap& textwolf::CharMap< RESTYPE, nullvalue_, RANGE >::operator()	(	unsigned char	from,
		unsigned char	to,
		valuetype	value
	)

inline

Define the values of the elements in the interval [from,to].

Parameters

[in]	from	start of the input intervall (belongs also to the input)
[in]	to	end of the input intervall (belongs also to the input)
[in]	value	value assigned to all elements in [from,to]

template<typename RESTYPE, RESTYPE nullvalue_, int RANGE = 256>

CharMap& textwolf::CharMap< RESTYPE, nullvalue_, RANGE >::operator()	(	unsigned char	at,
		valuetype	value
	)

inline

Define the values of the single element at 'at'.

Parameters

[in]	at	the input element
[in]	value	value assigned to the element 'at'

template<typename RESTYPE, RESTYPE nullvalue_, int RANGE = 256>

valuetype textwolf::CharMap< RESTYPE, nullvalue_, RANGE >::operator[] ( unsigned char ii ) const

inline

Read the element assigned to 'ii'.

Parameters

[in] ii the input element queried

Returns: the element at 'ii'

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

/home/patrick/Projects/github/textwolf/include/textwolf/char.hpp