ABCSMCController Class Reference

#include <ABCSMCController.h>

Inheritance diagram for ABCSMCController:

Collaboration diagram for ABCSMCController:

Classes
struct	Input

Public Member Functions
	ABCSMCController (const Input &input_obj)
virtual	~ABCSMCController () override=default
virtual void	iterate () override
virtual Command	getSimulator () const override
Public Member Functions inherited from AbstractController
	AbstractController ()=default
virtual	~AbstractController ()=default
void	assignMaster (std::shared_ptr< AbstractMaster > p_master)

Static Public Member Functions
static std::string	help ()
static void	addLongOptions (LongOptions &lopts)
static ABCSMCController *	makeController (const Arguments &args)
Static Public Member Functions inherited from AbstractController
static controller_t	getController (const std::string &arg)
static std::string	help (controller_t controller)
static void	addLongOptions (controller_t controller, LongOptions &lopts)
static AbstractController *	makeController (controller_t controller, const Arguments &args)

Additional Inherited Members
Protected Attributes inherited from AbstractController
std::shared_ptr< AbstractMaster >	m_p_master

Detailed Description

A Controller class implementing the ABC SMC algorithm.

The ABCSMCController class implements the ABC SMC algorithm, which is detailed in the following paper:

Toni, Tina, David Welch, Natalja Strelkowa, Andreas Ipsen, and Michael

P.H. > Stumpf. 2009. “Approximate Bayesian computation scheme for parameter > inference and model selection in dynamical systems.” J. R. Soc. Interface 6 > (31): 187–202. doi:10.1098/rsif.2008.0172.

For instructions on how to use Pakman with the ABC SMC controller, execute the following command

$ pakman smc --help

Definition at line 35 of file ABCSMCController.h.

Constructor & Destructor Documentation

ABCSMCController()

ABCSMCController::ABCSMCController

(

const Input &

input_obj

)

Construct from Input object and pointer to random number engine.

The random number engine is used to choose a parameter from the parameter population.

Parameters

input_obj	Input object.
p_generator	pointer to random number engine.

Definition at line 24 of file ABCSMCController.cc.

~ABCSMCController()

virtual ABCSMCController::~ABCSMCController ( )

overridevirtualdefault

Default destructor does nothing.

Member Function Documentation

addLongOptions()

void ABCSMCController::addLongOptions ( LongOptions &  lopts )

static

Add long command-line options.

Parameters

lopts

long command-line options that the ABCSMCController needs.

Definition at line 81 of file ABCSMCControllerStatic.cc.

getSimulator()

Command ABCSMCController::getSimulator ( ) const

overridevirtual

Returns

simulator command.

Implements AbstractController.

Definition at line 187 of file ABCSMCController.cc.

help()

std::string ABCSMCController::help ( )

static

Returns

help message string.

Definition at line 14 of file ABCSMCControllerStatic.cc.

iterate()

void ABCSMCController::iterate ( )

overridevirtual

Iterates the ABCSMCController. Should be called by a Master.

Implements AbstractController.

Definition at line 41 of file ABCSMCController.cc.

makeController()

ABCSMCController * ABCSMCController::makeController ( const Arguments &  args )

static

Create ABCSMCController instance.

Parameters

args	command-line arguments.

Returns

pointer to created ABCSMCController instance.

Definition at line 95 of file ABCSMCControllerStatic.cc.

---

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

• src/controller/ABCSMCController.h
• src/controller/ABCSMCController.cc
• src/controller/ABCSMCControllerStatic.cc