This class stores additional context for creating Ginkgo objects from configuration files.
More...
#include <ginkgo/core/config/registry.hpp>
|
| | registry (const configuration_map &additional_map={}) |
| | registry constructor
|
| |
| | registry (const std::unordered_map< std::string, detail::allowed_ptr > &stored_map, const configuration_map &additional_map={}) |
| | registry constructor
|
| |
| template<typename T> |
| bool | emplace (std::string key, std::shared_ptr< T > data) |
| | Store the data with the key.
|
| |
This class stores additional context for creating Ginkgo objects from configuration files.
The context can contain user-provided objects that derive from the following base types:
Additionally, users can provide mappings from a configuration (provided as a pnode) to user-defined types that are derived from LinOpFactory
◆ registry() [1/2]
| gko::config::registry::registry |
( |
const configuration_map & | additional_map = {} | ) |
|
registry constructor
- Parameters
-
| additional_map | the additional map to dispatch the class base. Users can extend the map to fit their own LinOpFactory. We suggest using "usr::" as the prefix in the key to simply avoid conflict with ginkgo's map. |
◆ registry() [2/2]
| gko::config::registry::registry |
( |
const std::unordered_map< std::string, detail::allowed_ptr > & | stored_map, |
|
|
const configuration_map & | additional_map = {} ) |
registry constructor
- Parameters
-
| stored_map | the map stores the shared pointer of users' objects. It can hold any type whose base type is LinOp/LinOpFactory/CriterionFactory. |
| additional_map | the additional map to dispatch the class base. Users can extend the map to fit their own LinOpFactory. We suggest using "usr::" as the prefix in the key to simply avoid conflict with ginkgo's map. |
◆ emplace()
template<typename T>
| bool gko::config::registry::emplace |
( |
std::string | key, |
|
|
std::shared_ptr< T > | data ) |
|
inline |
Store the data with the key.
- Template Parameters
-
- Parameters
-
| key | the unique key string |
| data | the shared pointer of the object |
The documentation for this class was generated from the following file: