tudocomp
– The TU Dortmund Compression Framework
tdc::Builder< T, registry_root_t > Class Template Reference

#include <CreateAlgorithm.hpp>

Public Member Functions

 Builder ()
 
Builderoptions (const std::string &options)
 Sets an options string for the created environment. More...
 
Builderregistry (const Registry< registry_root_t > &reg)
 Sets a registry to be used for dynamic type lookups during instantiation. More...
 
Env env ()
 Creates the Env instance needed for instantiating T. More...
 
template<typename... Args>
instance (Args &&... args)
 Instances T by creating the right Env instance, and passing any extra arguments to the constructor of T. More...
 

Detailed Description

template<typename T, typename registry_root_t = T>
class tdc::Builder< T, registry_root_t >

Definition at line 11 of file CreateAlgorithm.hpp.

Constructor & Destructor Documentation

◆ Builder()

template<typename T , typename registry_root_t = T>
tdc::Builder< T, registry_root_t >::Builder ( )
inline

Definition at line 15 of file CreateAlgorithm.hpp.

Member Function Documentation

◆ env()

template<typename T , typename registry_root_t = T>
Env tdc::Builder< T, registry_root_t >::env ( )
inline

Creates the Env instance needed for instantiating T.

Definition at line 31 of file CreateAlgorithm.hpp.

◆ instance()

template<typename T , typename registry_root_t = T>
template<typename... Args>
T tdc::Builder< T, registry_root_t >::instance ( Args &&...  args)
inline

Instances T by creating the right Env instance, and passing any extra arguments to the constructor of T.

Template Parameters
ArgsThe constructor's argument types (typically inferred).
Parameters
argsAdditional arguments passed to the algorithm's constructor.

Definition at line 66 of file CreateAlgorithm.hpp.

◆ options()

template<typename T , typename registry_root_t = T>
Builder& tdc::Builder< T, registry_root_t >::options ( const std::string &  options)
inline

Sets an options string for the created environment.

Definition at line 18 of file CreateAlgorithm.hpp.

◆ registry()

template<typename T , typename registry_root_t = T>
Builder& tdc::Builder< T, registry_root_t >::registry ( const Registry< registry_root_t > &  reg)
inline

Sets a registry to be used for dynamic type lookups during instantiation.

Definition at line 25 of file CreateAlgorithm.hpp.


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