– The TU Dortmund Compression Framework
tdc::Registry< algorithm_t > Class Template Reference

A registry for algorithms to be made available in the driver application. More...

#include <Registry.hpp>

Public Member Functions

 Registry (const std::string &root_type="any")
template<typename T >
void register_algorithm ()
 Registers an tdc::Algorithm. More...
eval::AlgorithmTypes & algorithm_map ()
const eval::AlgorithmTypes & algorithm_map () const

Detailed Description

template<typename algorithm_t>
class tdc::Registry< algorithm_t >

A registry for algorithms to be made available in the driver application.

For algorithms to be made available in the driver application, they need to be registered in the application's main registry. This is done in the register_algorithm step. Any registered algorithm will also be listed in the utility's help message.

Definition at line 29 of file pre_header/Registry.hpp.

Constructor & Destructor Documentation

◆ Registry()

template<typename algorithm_t>
tdc::Registry< algorithm_t >::Registry ( const std::string &  root_type = "any")

Definition at line 46 of file pre_header/Registry.hpp.

Member Function Documentation

◆ algorithm_map() [1/2]

template<typename algorithm_t>
eval::AlgorithmTypes& tdc::Registry< algorithm_t >::algorithm_map ( )

◆ algorithm_map() [2/2]

template<typename algorithm_t>
const eval::AlgorithmTypes& tdc::Registry< algorithm_t >::algorithm_map ( ) const

◆ register_algorithm()

template<typename algorithm_t>
template<typename T >
void tdc::Registry< algorithm_t >::register_algorithm ( )

Registers an tdc::Algorithm.

Note that the algorithm type T needs to implement a static function called meta() that returns a tdc::Meta information object. This meta information is used to automatically generate the documentation for the driver application's help message.

Template Parameters
TThe algorithm to register.

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