class Gambit::Scanner::Scanner_Plugin_Function< ret(args…)>

Objective functor made up a single plugin. More…

#include <plugin_factory.hpp>

Inherits from Gambit::Scanner::Plugins::Plugin_Interface< ret(args…)>, Gambit::Scanner::Function_Base< ret(args…)>, Gambit::Scanner::Plugins::Plugin_Interface_Base, Gambit::Scanner::Plugins::Plugin_Main_Interface_Base< ret(args…)>, boost::enable_shared_from_this< Function_Base< ret(args…)> >

Public Functions

Name
Scanner_Plugin_Function(const std::vector< std::string > & params, const std::string & name)
retmain(const args &… in)

Additional inherited members

Public Functions inherited from Gambit::Scanner::Plugins::Plugin_Interface< ret(args…)>

Name
template <typename… plug_args>
Plugin_Interface(const std::string & type, const std::string & name, const plug_args &… inputs)
retoperator()(const args &… params)

Public Functions inherited from Gambit::Scanner::Function_Base< ret(args…)>

Name
Function_Base(double offset =0.)
virtual doublepurposeModifier(double ret_val)
virtual~Function_Base()
retoperator()(const args &… params)
voidsetPurpose(const std::string p)
voidsetPrinter(printer * p)
voidsetPrior(Priors::BasePrior * p)
printer &getPrinter()
printer &getPrinter() const
Priors::BasePrior &getPrior()
std::vector< std::string >getParameters()
std::vector< std::string >getShownParameters()
std::stringgetPurpose() const
intgetRank() const
voidsetRank(int r)
doublegetPurposeOffset() const
voidsetPurposeOffset(double os)
unsigned long long intgetPtID() const
voidsetPtID(unsigned long long int pID)
unsigned long long intgetNextPtID() const
voidtell_scanner_early_shutdown_in_progress()
Tell ScannerBit that we are aborting the scan and it should tell the scanner plugin to stop, and return control to the calling code.
voiddisable_external_shutdown()
boolscanner_can_quit()
Check whether likelihood container is supposed to control early shutdown of scan.
voidswitch_to_alternate_min_LogL()
boolcheck_for_switch_to_alternate_min_LogL()
Checks if some process has triggered the ‘switch_to_alternate_min_LogL’ function.

Friends inherited from Gambit::Scanner::Function_Base< ret(args…)>

Name
classFunction_Deleter< ret(args…)>
classscan_ptr< ret(args…)>

Public Functions inherited from Gambit::Scanner::Plugins::Plugin_Interface_Base

Name
Plugin_Interface_Base()
YAML::Nodeoperator[](const std::string & key)
~Plugin_Interface_Base()

Protected Functions inherited from Gambit::Scanner::Plugins::Plugin_Interface_Base

Name
template <typename… plug_args>
const std::map< type_index, void * > &
initPlugin(const std::string & type, const std::string & name, const plug_args &… inputs)

Public Functions inherited from Gambit::Scanner::Plugins::Plugin_Main_Interface_Base< ret(args…)>

Name
Plugin_Main_Interface_Base()
intenterMain(const std::string & name, const std::map< type_index, void * > & index_map)
retoperator()(const args &… params)

Detailed Description

template <typename ret ,
typename... args>
class Gambit::Scanner::Scanner_Plugin_Function< ret(args...)>;

Objective functor made up a single plugin.

Public Functions Documentation

function Scanner_Plugin_Function

inline Scanner_Plugin_Function(
    const std::vector< std::string > & params,
    const std::string & name
)

function main

inline ret main(
    const args &... in
)

Updated on 2023-06-26 at 21:36:52 +0000