bdm::experimental::AlgorithmRegistry Struct Reference

Registry of all optimization algorithms. More...

#include <algorithm_registry.h>

Public Member Functions
Algorithm *	GetAlgorithm (const std::string &algo_name)
bool	AddAlgorithm (const std::string &algo_name, Algorithm *algo)

Static Public Member Functions
static AlgorithmRegistry *	GetInstance ()
	Singleton class - returns the static instance. More...

Private Member Functions
	AlgorithmRegistry ()
	~AlgorithmRegistry ()

Private Attributes
std::unordered_map< std::string, Algorithm * >	algorithms_
	The map containing the algorithms; accessible by their name. More...

Detailed Description

Registry of all optimization algorithms.

Definition at line 30 of file algorithm_registry.h.

Constructor & Destructor Documentation

AlgorithmRegistry()

bdm::experimental::AlgorithmRegistry::AlgorithmRegistry ( )

privatedefault

~AlgorithmRegistry()

bdm::experimental::AlgorithmRegistry::~AlgorithmRegistry ( )

private

Definition at line 21 of file algorithm_registry.cc.

Member Function Documentation

AddAlgorithm()

bool bdm::experimental::AlgorithmRegistry::AddAlgorithm	(	const std::string &	algo_name,
		Algorithm *	algo
	)

Adds an algorithm to the registry

Parameters

[in]	algo_name	The algorithm's name
	algo	The algorithm

Returns

Returns true when the algorithm is successfully added to registry

Definition at line 46 of file algorithm_registry.cc.

GetAlgorithm()

Algorithm * bdm::experimental::AlgorithmRegistry::GetAlgorithm

(

const std::string &

algo_name

)

Gets the algorithm

Parameters

[in]

algo_name

The algorithm's name

Returns

The algorithm pointer

Definition at line 32 of file algorithm_registry.cc.

GetInstance()

AlgorithmRegistry * bdm::experimental::AlgorithmRegistry::GetInstance ( )

static

Singleton class - returns the static instance.

Definition at line 27 of file algorithm_registry.cc.

Member Data Documentation

algorithms_

std::unordered_map<std::string, Algorithm *> bdm::experimental::AlgorithmRegistry::algorithms_

private

The map containing the algorithms; accessible by their name.

Definition at line 54 of file algorithm_registry.h.

---

The documentation for this struct was generated from the following files:

• core/multi_simulation/algorithm/algorithm_registry.h
• core/multi_simulation/algorithm/algorithm_registry.cc