#include <AlgorithmFactory.h>

Inheritance diagram for QUESO::AlgorithmFactory:

Public Member Functions
	AlgorithmFactory (const std::string &name)

virtual	~AlgorithmFactory ()

Public Member Functions inherited from QUESO::Factory< Algorithm< GslVector, GslMatrix > >
virtual	~Factory ()

Static Public Member Functions
static void	set_environment (const BaseEnvironment &env)

static void	set_tk (const BaseTKGroup< GslVector, GslMatrix > &tk)

Static Public Member Functions inherited from QUESO::Factory< Algorithm< GslVector, GslMatrix > >
static SharedPtr< Algorithm < GslVector, GslMatrix > >::Type	build (const std::string &name)

Protected Member Functions
virtual SharedPtr< Algorithm < GslVector, GslMatrix > >::Type	build_algorithm ()=0

Protected Member Functions inherited from QUESO::Factory< Algorithm< GslVector, GslMatrix > >
	Factory (const std::string &name)

Static Protected Attributes
static const BaseEnvironment *	m_env = NULL

static const BaseTKGroup < GslVector, GslMatrix > *	m_tk = NULL

Private Member Functions
virtual SharedPtr< Algorithm < GslVector, GslMatrix > >::Type	create ()

Additional Inherited Members
Static Protected Member Functions inherited from QUESO::Factory< Algorithm< GslVector, GslMatrix > >
static std::map< std::string, Factory< Algorithm< GslVector, GslMatrix > > * > &	factory_map ()

Detailed Description

AlgorithmFactory class defintion. Clients subclassing this for their own algorithm (aka Metropolis-Hastings acceptance ratio) should implement build_algorithm.

Definition at line 42 of file AlgorithmFactory.h.

Constructor & Destructor Documentation

QUESO::AlgorithmFactory::AlgorithmFactory ( const std::string & name )

inline

Constructor. Takes the name to be mapped.

Definition at line 48 of file AlgorithmFactory.h.

49 : Factory<Algorithm<GslVector, GslMatrix> >(name)

50 {}

virtual QUESO::AlgorithmFactory::~AlgorithmFactory ( )

inlinevirtual

Destructor. (Empty.)

Definition at line 55 of file AlgorithmFactory.h.

55 {}

Member Function Documentation

virtual SharedPtr<Algorithm<GslVector, GslMatrix> >::Type QUESO::AlgorithmFactory::build_algorithm ( )

protectedpure virtual

Implemented in QUESO::AlgorithmFactoryImp< DerivedAlgorithm >.

Referenced by create().

SharedPtr< Algorithm< GslVector, GslMatrix > >::Type QUESO::AlgorithmFactory::create ( )

inlineprivatevirtual

Create a Base class. Force this to be implemented later.

Implements QUESO::Factory< Algorithm< GslVector, GslMatrix > >.

Definition at line 83 of file AlgorithmFactory.h.

References build_algorithm(), m_env, and m_tk.

 {
   queso_require_msg(m_env, "ERROR: must call set_environment() before building alg!");
   queso_require_msg(m_tk, "ERROR: must call set_tk() before building alg!");
 
   SharedPtr<Algorithm<GslVector, GslMatrix> >::Type new_alg = this->build_algorithm();
 
   queso_assert(new_alg);
 
   return new_alg;
 }