o2::data_compression::ExampleAlphabet< T > Class Template Reference

#include <dc_primitives.h>

Classes
class	Iterator
	a forward iterator to access the list of elements More...

Public Types
using	value_type = T
using	iterator = Iterator< value_type >
using	const_iterator = Iterator< const value_type >

Public Member Functions
	ExampleAlphabet ()
	~ExampleAlphabet ()
constexpr unsigned	getIndexRange ()
	get the range of indices aka number of indices
const_iterator	begin () const
	return forward iterator to begin of element list
const_iterator	end () const
	the end of element list
iterator	begin ()
	return forward iterator to begin of element list
iterator	end ()
	the end of element list

Static Public Member Functions
static bool	isValid (value_type v)
	check for valid value within range
static unsigned	getIndex (value_type symbol)
	get index of value
static value_type	getSymbol (unsigned index)
	get symbol from index

Detailed Description

template<typename T>
class o2::data_compression::ExampleAlphabet< T >

Definition at line 128 of file dc_primitives.h.

Member Typedef Documentation

const_iterator

template<typename T >

using o2::data_compression::ExampleAlphabet< T >::const_iterator = Iterator<const value_type>

Definition at line 181 of file dc_primitives.h.

iterator

template<typename T >

using o2::data_compression::ExampleAlphabet< T >::iterator = Iterator<value_type>

Definition at line 180 of file dc_primitives.h.

value_type

template<typename T >

using o2::data_compression::ExampleAlphabet< T >::value_type = T

Definition at line 134 of file dc_primitives.h.

Constructor & Destructor Documentation

ExampleAlphabet()

template<typename T >

o2::data_compression::ExampleAlphabet< T >::ExampleAlphabet

(

)

~ExampleAlphabet()

template<typename T >

o2::data_compression::ExampleAlphabet< T >::~ExampleAlphabet

(

)

Member Function Documentation

begin() [1/2]

template<typename T >

iterator o2::data_compression::ExampleAlphabet< T >::begin

(

)

return forward iterator to begin of element list

begin() [2/2]

template<typename T >

const_iterator o2::data_compression::ExampleAlphabet< T >::begin

(

)

const

return forward iterator to begin of element list

end() [1/2]

template<typename T >

iterator o2::data_compression::ExampleAlphabet< T >::end

(

)

the end of element list

end() [2/2]

template<typename T >

const_iterator o2::data_compression::ExampleAlphabet< T >::end

(

)

const

the end of element list

getIndex()

template<typename T >

static unsigned o2::data_compression::ExampleAlphabet< T >::getIndex ( value_type  symbol )

static

get index of value

getIndexRange()

template<typename T >

constexpr unsigned o2::data_compression::ExampleAlphabet< T >::getIndexRange ( )

constexpr

get the range of indices aka number of indices

getSymbol()

template<typename T >

static value_type o2::data_compression::ExampleAlphabet< T >::getSymbol ( unsigned  index )

static

get symbol from index

isValid()

template<typename T >

static bool o2::data_compression::ExampleAlphabet< T >::isValid ( value_type  v )

static

check for valid value within range

---

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

• /home/runner/work/AliceO2/AliceO2/Utilities/DataCompression/include/DataCompression/dc_primitives.h