class Gambit::Scanner::Function_Base< ret(args…)> #

Base function for the object that is upputed by “set_purpose”. More…

#include <factory_defs.hpp>

Inherits from boost::enable_shared_from_this< Function_Base< ret(args…)> >

Inherited by Gambit::Scanner::Multi_Scanner_Plugin_Function< ret(args…)>, Gambit::Scanner::Scanner_Plugin_Function< ret(args…)>

Public Functions #

Friends #

Detailed Description #

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

Base function for the object that is upputed by “set_purpose”.

Public Functions Documentation #

function Function_Base #

inline Function_Base(
    double offset =0.
)

function purposeModifier #

inline virtual double purposeModifier(
    double ret_val
)

function main #

virtual ret main(
    const args & ...
) =0

function ~Function_Base #

inline virtual ~Function_Base()

function operator() #

inline ret operator()(
    const args &... params
)

function setPurpose #

inline void setPurpose(
    const std::string p
)

function setPrinter #

inline void setPrinter(
    printer * p
)

function setPrior #

inline void setPrior(
    Priors::BasePrior * p
)

function getPrinter #

inline printer & getPrinter()

function getPrinter #

inline printer & getPrinter() const

function getPrior #

inline Priors::BasePrior & getPrior()

function getParameters #

inline std::vector< std::string > getParameters()

function getShownParameters #

inline std::vector< std::string > getShownParameters()

function getPurpose #

inline std::string getPurpose() const

function getRank #

inline int getRank() const

function setRank #

inline void setRank(
    int r
)

function getPurposeOffset #

inline double getPurposeOffset() const

function setPurposeOffset #

inline void setPurposeOffset(
    double os
)

function getPtID #

inline unsigned long long int getPtID() const

function setPtID #

inline void setPtID(
    unsigned long long int pID
)

function getNextPtID #

inline unsigned long long int getNextPtID() const

function tell_scanner_early_shutdown_in_progress #

inline void tell_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.

function disable_external_shutdown #

inline void disable_external_shutdown()

Tells log-likelihood function (defined by driver code) not to use its own shutdown system (e.g the GAMBIT soft shutdown procedure) and instead to trust that the scanner plugin will safely terminate executions upon checking that shutdown is in progress (via the shutdown_in_progress flag set in plugin_info)

function scanner_can_quit #

inline bool scanner_can_quit()

Check whether likelihood container is supposed to control early shutdown of scan.

function switch_to_alternate_min_LogL #

inline void switch_to_alternate_min_LogL()

Tell log-likelihood function (defined by driver code) to switch to an alternate value for the minimum log-likelihood. Called by e.g. MultiNest scanner plugin.

function check_for_switch_to_alternate_min_LogL #

inline bool check_for_switch_to_alternate_min_LogL()

Checks if some process has triggered the ‘switch_to_alternate_min_LogL’ function.

Friends #

friend Function_Deleter< ret(args…)> #

friend class Function_Deleter< ret(args...)>(
    Function_Deleter< ret(args...)> 
);

friend scan_ptr< ret(args…)> #

friend class scan_ptr< ret(args...)>(
    scan_ptr< ret(args...)> 
);

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