Runtime dispatcher interface for probability model definitions. More...

#include <CodingModelDispatcher.h>

Classes
class	addWeightFctr
	functor to add weight to probability model at runtime container level More...

class	decodeFctr
	Functor to execute decoding on runtime container level. More...

class	encodeFctr
	functor to execute encoding on runtime container level More...

class	generateFctr

class	getCodingDirectionFctr

class	initFctr

class	readFctr
	read functor More...

class	writeFctr
	write functor More...

Public Types
using	self_type = CodingModelDispatcher< ModelDefinition >

using	definition_type = typename mpl::make_mpl_vector< ModelDefinition >::type

using	container_type = typename create_rtc< definition_type, RuntimeContainer<> >::type

using	code_type = typename container_type::wrapped_type::code_type

Public Member Functions
	CodingModelDispatcher ()

	~CodingModelDispatcher ()=default

container_type &	operator* ()
	return highest stage of runtime container

template<typename ValueType , typename WeightType >
bool	addWeight (ValueType v, WeightType w, bool switchToNextModel=true)

int	init ()

int	generate ()

template<typename CodeType , typename ValueType >
bool	encode (ValueType v, CodeType &code, uint16_t &codeLength, bool switchToNextModel=true)

template<typename ValueType , typename CodeType >
bool	decode (ValueType &v, CodeType code, uint16_t &codeLength, bool switchToNextModel=true)

bool	getCodingDirection ()

int	write (const char *filename=nullptr)

int	read (const char *filename)

Static Public Member Functions
static int	getNumberOfModels ()
	get the number of models in the definition

Detailed Description

template<typename ModelDefinition>
class o2::data_compression::CodingModelDispatcher< ModelDefinition >

Runtime dispatcher interface for probability model definitions.

interface

ModelDefinition single coding model or mpl sequence of models

TODO:

consistency check for coding direction, all model definitions have to obey same direction
probably one should also require the same code type for all definitions, at least in the codec. Multiple code types do not make much sense in the codec

Definition at line 51 of file CodingModelDispatcher.h.

Member Typedef Documentation

◆ code_type

template<typename ModelDefinition >

using o2::data_compression::CodingModelDispatcher< ModelDefinition >::code_type = typename container_type::wrapped_type::code_type

Definition at line 68 of file CodingModelDispatcher.h.

◆ container_type

template<typename ModelDefinition >

using o2::data_compression::CodingModelDispatcher< ModelDefinition >::container_type = typename create_rtc<definition_type, RuntimeContainer<> >::type

Definition at line 66 of file CodingModelDispatcher.h.

◆ definition_type

template<typename ModelDefinition >

using o2::data_compression::CodingModelDispatcher< ModelDefinition >::definition_type = typename mpl::make_mpl_vector<ModelDefinition>::type

Definition at line 62 of file CodingModelDispatcher.h.

◆ self_type

template<typename ModelDefinition >

using o2::data_compression::CodingModelDispatcher< ModelDefinition >::self_type = CodingModelDispatcher<ModelDefinition>

Definition at line 57 of file CodingModelDispatcher.h.

Constructor & Destructor Documentation

◆ CodingModelDispatcher()

template<typename ModelDefinition >

o2::data_compression::CodingModelDispatcher< ModelDefinition >::CodingModelDispatcher ( )

inline

Definition at line 54 of file CodingModelDispatcher.h.

◆ ~CodingModelDispatcher()

template<typename ModelDefinition >

o2::data_compression::CodingModelDispatcher< ModelDefinition >::~CodingModelDispatcher ( )

default

Member Function Documentation

◆ addWeight()

template<typename ModelDefinition >

template<typename ValueType , typename WeightType >

bool o2::data_compression::CodingModelDispatcher< ModelDefinition >::addWeight	(	ValueType	v,
		WeightType	w,
		bool	switchToNextModel = `true`
	)

inline

add weight to current model

Dispatcher increments to the next model definition after decoding if parameter switchToNextModel is true.

Definition at line 107 of file CodingModelDispatcher.h.

◆ decode()

template<typename ModelDefinition >

template<typename ValueType , typename CodeType >

bool o2::data_compression::CodingModelDispatcher< ModelDefinition >::decode	(	ValueType &	v,
		CodeType	code,
		uint16_t &	codeLength,
		bool	switchToNextModel = `true`
	)

inline

Decode a code sequence Code direction can be either from MSB to LSB or LSB to MSB, controlled by template parameter orderMSB of the probability model.

Dispatcher increments to the next model definition after decoding if parameter switchToNextModel is true.

Definition at line 255 of file CodingModelDispatcher.h.

◆ encode()

template<typename ModelDefinition >

template<typename CodeType , typename ValueType >

bool o2::data_compression::CodingModelDispatcher< ModelDefinition >::encode	(	ValueType	v,
		CodeType &	code,
		uint16_t &	codeLength,
		bool	switchToNextModel = `true`
	)

inline

Encode a value

Dispatcher increments to the next model definition after decoding if parameter switchToNextModel is true.

Definition at line 212 of file CodingModelDispatcher.h.

◆ generate()

template<typename ModelDefinition >

int o2::data_compression::CodingModelDispatcher< ModelDefinition >::generate ( )

inline

TODO: maybe 'generate' is not the appropriate name

Definition at line 174 of file CodingModelDispatcher.h.

◆ getCodingDirection()

template<typename ModelDefinition >

bool o2::data_compression::CodingModelDispatcher< ModelDefinition >::getCodingDirection ( )

inline

Get coding direction for model at current position

Definition at line 278 of file CodingModelDispatcher.h.

◆ getNumberOfModels()

template<typename ModelDefinition >

static int o2::data_compression::CodingModelDispatcher< ModelDefinition >::getNumberOfModels ( )

inlinestatic

get the number of models in the definition

Definition at line 71 of file CodingModelDispatcher.h.

◆ init()

template<typename ModelDefinition >

int o2::data_compression::CodingModelDispatcher< ModelDefinition >::init ( )

inline

init dispatcher and models

Definition at line 141 of file CodingModelDispatcher.h.

◆ operator*()

template<typename ModelDefinition >

container_type & o2::data_compression::CodingModelDispatcher< ModelDefinition >::operator* ( )

inline

return highest stage of runtime container

Definition at line 74 of file CodingModelDispatcher.h.

◆ read()

template<typename ModelDefinition >

int o2::data_compression::CodingModelDispatcher< ModelDefinition >::read ( const char * filename )

inline

Read configuration

TODO: introduce a general storage policy, a text file is used for now

Definition at line 359 of file CodingModelDispatcher.h.

◆ write()

template<typename ModelDefinition >

int o2::data_compression::CodingModelDispatcher< ModelDefinition >::write ( const char * filename = nullptr )

inline

Write configuration

TODO: introduce a general storage policy, a text file is used for now

Definition at line 311 of file CodingModelDispatcher.h.

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

/home/runner/work/AliceO2/AliceO2/Utilities/DataCompression/include/DataCompression/CodingModelDispatcher.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ code_type

◆ container_type

◆ definition_type

◆ self_type

Constructor & Destructor Documentation

◆ CodingModelDispatcher()

◆ ~CodingModelDispatcher()

Member Function Documentation

◆ addWeight()

◆ decode()

◆ encode()

◆ generate()

◆ getCodingDirection()

◆ getNumberOfModels()

◆ init()

◆ operator*()

◆ read()

◆ write()