Gambit::functor Class Reference

Function wrapper (functor) base class. More...

#include <functors.hpp>

Inheritance diagram for Gambit::functor:

Collaboration diagram for Gambit::functor:

Public Member Functions
	functor (str, str, str, str, Models::ModelFunctorClaw &)
	Constructor. More...
virtual	~functor ()
virtual void	calculate ()
	Virtual calculate(); needs to be redefined in daughters. More...
virtual void	reset_and_calculate ()
	Reset-then-recalculate method. More...
void	setStatus (int)
	Setter for status: -6 = required external tool absent (pybind11) -5 = required external tool absent (Mathematica) -4 = required backend absent (backend ini functions) -3 = required classes absent -2 = function absent -1 = origin absent 0 = model incompatibility (default) 1 = available 2 = active. More...
virtual void	setInUse (bool)
	Set the inUse flag (must be overridden in derived class to have any effect). More...
void	setPurpose (str)
	Setter for purpose (relevant only for next-to-output functors) More...
void	setVertexID (int)
	Setter for vertex ID (used in printer system) More...
void	setTimingVertexID (int)
	Set ID for timing 'vertex' (used in printer system) More...
str	name () const
	Getter for the wrapped function's name. More...
str	capability () const
	Getter for the wrapped function's reported capability. More...
str	type () const
	Getter for the wrapped function's reported return type. More...
str	origin () const
	Getter for the wrapped function's origin (module or backend name) More...
str	version () const
	Getter for the version of the wrapped function's origin (module or backend) More...
virtual str	safe_version () const
	Getter for the 'safe' incarnation of the version of the wrapped function's origin (module or backend) More...
int	status () const
	Getter for the wrapped function current status: -4 = required backend absent (backend ini functions) -3 = required classes absent -2 = function absent -1 = origin absent 0 = model incompatibility (default) 1 = available 2 = active. More...
sspair	quantity () const
	Getter for the overall quantity provided by the wrapped function (capability-type pair) More...
str	purpose () const
	Getter for purpose (relevant for output nodes, aka helper structures for the dep. resolution) More...
int	vertexID () const
	Getter for vertex ID. More...
int	timingVertexID () const
	Getter for timing vertex ID. More...
str	label () const
	Getter for string label. More...
str	timingLabel () const
	Getter for the printer timing label. More...
virtual bool	requiresPrinting () const
	Getter indicating if the wrapped function's result should to be printed. More...
virtual bool	requiresTimingPrinting () const
	Getter indicating if the timing data for this function's execution should be printed. More...
virtual void	setPrintRequirement (bool)
	Setter for indicating if the wrapped function's result should to be printed. More...
virtual void	setTimingPrintRequirement (bool)
	Setter for indicating if the timing data for this function's execution should be printed. More...
virtual void	setNestedList (std::vector< functor *> &)
	Set the ordered list of pointers to other functors that should run nested in a loop managed by this one. More...
virtual void	setIteration (long long)
	Set the iteration number in a loop in which this functor runs. More...
virtual bool	canBeLoopManager ()
	Getter for revealing whether this is permitted to be a manager functor. More...
virtual str	loopManagerCapability ()
	Getter for revealing the required capability of the wrapped function's loop manager. More...
virtual str	loopManagerType ()
	Getter for revealing the required type of the wrapped function's loop manager. More...
virtual str	loopManagerName ()
	Getter for revealing the name of the wrapped function's assigned loop manager. More...
virtual str	loopManagerOrigin ()
	Getter for revealing the module of the wrapped function's assigned loop manager. More...
virtual void	breakLoop ()
	Tell the functor that the loop it manages should break now. More...
virtual std::set< sspair >	dependencies ()
	Getter for listing currently activated dependencies. More...
virtual std::set< str >	backendgroups ()
	Getter for listing backend requirement groups. More...
virtual std::set< sspair >	backendreqs ()
	Getter for listing all backend requirements. More...
virtual std::set< sspair >	backendreqs (str)
	Getter for listing backend requirements from a specific group. More...
virtual std::set< sspair >	backendspermitted (sspair)
	Getter for listing permitted backends. More...
virtual std::set< str >	backendreq_tags (sspair)
	Getter for listing tags associated with backend requirements. More...
virtual std::set< sspair >	forcematchingbackend (str)
	Getter for listing backend requirements that must be resolved from the same backend. More...
virtual std::set< sspair >	backend_conditional_dependencies (str, str, str, str)
	Getter for listing backend-specific conditional dependencies (4-string version) More...
virtual std::set< sspair >	backend_conditional_dependencies (str req, str type, str be)
	Getter for backend-specific conditional dependencies (3-string version) More...
virtual std::set< sspair >	backend_conditional_dependencies (functor *)
	Getter for backend-specific conditional dependencies (backend functor pointer version) More...
virtual std::set< sspair >	model_conditional_dependencies (str)
	Getter for listing model-specific conditional dependencies. More...
virtual std::set< sspair >	model_conditional_backend_reqs (str)
	Getter for listing model-specific conditional backend requirements. More...
virtual void	resolveDependency (functor *)
	Resolve a dependency using a pointer to another functor object. More...
virtual void	resolveLoopManager (functor *)
	Set this functor's loop manager (if it has one) More...
virtual void	resolveBackendReq (functor *)
	Resolve a backend requirement using a pointer to another functor object. More...
virtual void	notifyOfModel (str)
	Notify the functor that a certain model is being scanned, so that it can activate itself accordingly. More...
virtual void	notifyOfDependee (functor *)
	Notify the functor that it is being used to fill a dependency of another functor. More...
virtual void	notifyOfBackends (std::map< str, std::set< str > >)
	Indicate to the functor which backends are actually loaded and working. More...
virtual void	print (Printers::BasePrinter *printer, const int pointID, int thread_num)
	Printer function. More...
virtual void	print (Printers::BasePrinter *printer, const int pointID)
	Printer function (no-thread-index short-circuit) More...
virtual invalid_point_exception *	retrieve_invalid_point_exception ()
	Retrieve the previously saved exception generated when this functor invalidated the current point in model space. More...
void	notifyOfIniOptions (const Options &)
	Notify the functor about an instance of the options class that contains information from its corresponding ini-file entry in the auxiliaries or observables section. More...
template<typename TYPE >
void	setOption (const str &key, const TYPE val)
	Set an option for the functor directly (for use in standalone executables). More...
safe_ptr< Options >	getOptions ()
	Return a safe pointer to the options that this functor is supposed to run with (e.g. from the ini file). More...
void	notifyOfSubCaps (const Options &)
	Notify the functor about an instance of the options class that contains sub-capability information. More...
template<typename TYPE >
void	setSubCap (const str &key, const TYPE val)
	Set a sub-capability (subcap)for the functor directly (for use in standalone executables). More...
safe_ptr< Options >	getSubCaps ()
	Return a safe pointer to the subcaps that this functor realises it is supposed to facilitate downstream calculation of. More...
safe_ptr< std::set< sspair > >	getDependees ()
	Return a safe pointer to the vector of all capability,type pairs of functors arranged downstream of this one in the dependency tree. More...
bool	allModelsAllowed ()
	Test whether the functor is allowed to be used with all models. More...
bool	modelAllowed (str model)
	Test whether the functor is always allowed (either explicitly or implicitly) to be used with a given model. More...
bool	modelExplicitlyAllowed (str model)
	Test whether the functor is explictly always allowed to be used with a given model. More...
void	setAllowedModel (str model)
	Add a model to the internal list of models for which this functor is allowed to be used. More...
bool	modelComboAllowed (std::set< str > combo)
	Test whether the functor is allowed (either explicitly or implicitly) to be used with a given combination of models. More...
bool	modelComboExplicitlyAllowed (std::set< str > combo)
	Test whether the functor has been explictly allowed to be used with a given combination of models. More...
void	setModelGroup (str group, str contents)
	Add a model group definition to the internal list of model groups. More...
void	setAllowedModelGroupCombo (str groups)
	Add a combination of model groups to the internal list of combinations for which this functor is allowed to be used. More...
virtual double	getRuntimeAverage ()
	Interfaces for runtime optimization Need to be implemented by daughters. More...
virtual double	getInvalidationRate ()
virtual void	setFadeRate (double)
virtual void	notifyOfInvalidation (const str &)
virtual void	reset ()

Protected Member Functions
bool	allowed_parent_or_friend_exists (str model)
	Test if there is a model in the functor's allowedModels list as which this model can be interpreted. More...
bool	in_allowed_combo (str model)
	Check that a model is actually part of a combination that is allowed to be used with this functor. More...
bool	contains_anything_interpretable_as_member_of (std::set< str > combo, str group)
	Test whether any of the entries in a given model group is a valid interpretation of any members in a given combination. More...
bool	has_common_elements (std::set< str > combo, str group)
	Work out whether a given combination of models and a model group have any elements in common. More...
str	find_friend_or_parent_model_in_map (str model, std::map< str, std::set< sspair > > karta)
	Try to find a parent or friend model in some user-supplied map from models to sspair vectors. More...
virtual void	reset (int)
	Reset functor for one thread only. More...

Static Protected Member Functions
static void	failBigTime (str method)
	Attempt to retrieve a dependency or model parameter that has not been resolved. More...

Protected Attributes
str	myName
	Internal storage of the function name. More...
str	myCapability
	Internal storage of exactly what the function calculates. More...
str	myType
	Internal storage of the type of what the function calculates. More...
str	myOrigin
	Internal storage of the name of the module or backend to which the function belongs. More...
str	myVersion
	Internal storage of the version of the module or backend to which the function belongs. More...
str	myPurpose
	Purpose of the function (relevant for output and next-to-output functors) More...
const Models::ModelFunctorClaw *	myClaw
	Bound model functor claw, for checking relationships between models. More...
const str	myLabel
	String label, used to label functor results for printer system. More...
const str	myTimingLabel
	String label, used to label functor timing data for printer system. More...
int	myStatus
	Status: -4 = required backend absent (backend ini functions) -3 = required classes absent -2 = function absent -1 = origin absent 0 = model incompatibility (default) 1 = available 2 = active. More...
int	myVertexID
	Internal storage of the vertex ID number used by the printer system to identify functors. More...
int	myTimingVertexID
	ID assigned by printers to the timing data output stream. More...
bool	verbose
	Debug flag. More...
Options	myOptions
	Internal storage of function options, as a YAML node. More...
Options	mySubCaps
	Internal storage of function sub-capabilities, as a YAML node. More...
std::set< sspair >	myDependees
	List of all capability,type pairs of functors downstream of this one in the dependency tree. More...
std::set< str >	allowedModels
	List of allowed models. More...
std::set< std::set< str > >	allowedGroupCombos
	List of allowed model group combinations. More...
std::map< str, std::set< str > >	modelGroups
	Map from model group names to group contents. More...

Detailed Description

Function wrapper (functor) base class.

Definition at line 87 of file functors.hpp.

Constructor & Destructor Documentation

functor()

Gambit::functor::functor	(	str	func_name,
		str	func_capability,
		str	result_type,
		str	origin_name,
		Models::ModelFunctorClaw &	claw
	)

Constructor.

Definition at line 57 of file functors.cpp.

                                                    :
     myName          (func_name),
     myCapability    (func_capability),
     myType          (Utils::fix_type(result_type)),
     myOrigin        (origin_name),
     myClaw          (&claw),
     myLabel         ("#"+func_capability+" @"+origin_name+"::"+func_name),
     myTimingLabel   ("Runtime(ns) for "+myLabel),
     myStatus        (0),
     myVertexID      (-1),       // (Note: myVertexID = -1 is intended to mean that no vertexID has been assigned)
     myTimingVertexID(-1),       // Not actually a graph vertex; ID assigned by "get_main_param_id" function.
     verbose         (false)     // For debugging.
    {}

~functor()

virtual Gambit::functor::~functor ( )

inlinevirtual

Definition at line 96 of file functors.hpp.

{}

Member Function Documentation

allModelsAllowed()

bool Gambit::functor::allModelsAllowed

(

)

Test whether the functor is allowed to be used with all models.

Definition at line 444 of file functors.cpp.

References allowedGroupCombos, and allowedModels.

    {
      return allowedModels.empty() and allowedGroupCombos.empty();
    }

allowed_parent_or_friend_exists()

bool Gambit::functor::allowed_parent_or_friend_exists ( str  model )

inlineprotected

Test if there is a model in the functor's allowedModels list as which this model can be interpreted.

Definition at line 534 of file functors.cpp.

References allowedModels, Gambit::Models::ModelFunctorClaw::downstream_of(), Gambit::Models::ModelFunctorClaw::model_exists(), and myClaw.

Referenced by modelAllowed().

    {
      for (std::set<str>::reverse_iterator it = allowedModels.rbegin() ; it != allowedModels.rend(); ++it)
      {
        if (myClaw->model_exists(*it))
        {
          if (myClaw->downstream_of(model, *it)) return true;
        }
      }
      return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

backend_conditional_dependencies() [1/3]

std::set< sspair > Gambit::functor::backend_conditional_dependencies ( str  , str  , str  , str    )

virtual

Getter for listing backend-specific conditional dependencies (4-string version)

Reimplemented in Gambit::module_functor_common.

Definition at line 268 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

Referenced by backend_conditional_dependencies().

    {
      utils_error().raise(LOCAL_INFO,"The backend_conditional_dependencies method has not been defined in this class.");
      std::set<sspair> empty;
      return empty;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

backend_conditional_dependencies() [2/3]

std::set< sspair > Gambit::functor::backend_conditional_dependencies ( str  req, str  type, str  be  )

virtual

Getter for backend-specific conditional dependencies (3-string version)

Reimplemented in Gambit::module_functor_common.

Definition at line 282 of file functors.cpp.

References backend_conditional_dependencies().

    {
      return backend_conditional_dependencies(req, type, be, "any");
    }

Here is the call graph for this function:

backend_conditional_dependencies() [3/3]

std::set< sspair > Gambit::functor::backend_conditional_dependencies ( functor *  be_functor )

virtual

Getter for backend-specific conditional dependencies (backend functor pointer version)

Reimplemented in Gambit::module_functor_common.

Definition at line 288 of file functors.cpp.

References backend_conditional_dependencies(), capability(), origin(), type(), and version().

    {
      return backend_conditional_dependencies (be_functor->capability(), be_functor->type(),
       be_functor->origin(), be_functor->version());
    }

Here is the call graph for this function:

backendgroups()

std::set< str > Gambit::functor::backendgroups ( )

virtual

Getter for listing backend requirement groups.

Reimplemented in Gambit::module_functor_common.

Definition at line 225 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The backendgroups method has not been defined in this class.");
      std::set<str> empty;
      return empty;
    }

Here is the call graph for this function:

backendreq_tags()

std::set< str > Gambit::functor::backendreq_tags ( sspair  )

virtual

Getter for listing tags associated with backend requirements.

Reimplemented in Gambit::module_functor_common.

Definition at line 253 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The backendreq_tags method has not been defined in this class.");
      std::set<str> empty;
      return empty;
    }

Here is the call graph for this function:

backendreqs() [1/2]

std::set< sspair > Gambit::functor::backendreqs ( )

virtual

Getter for listing all backend requirements.

Reimplemented in Gambit::module_functor_common.

Definition at line 232 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

Referenced by Gambit::gambit_core::ff_module_diagnostic().

    {
      utils_error().raise(LOCAL_INFO,"The backendreqs method has not been defined in this class.");
      std::set<sspair> empty;
      return empty;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

backendreqs() [2/2]

std::set< sspair > Gambit::functor::backendreqs ( str  )

virtual

Getter for listing backend requirements from a specific group.

Reimplemented in Gambit::module_functor_common.

Definition at line 239 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The backendreqs method has not been defined in this class.");
      std::set<sspair> empty;
      return empty;
    }

Here is the call graph for this function:

backendspermitted()

std::set< sspair > Gambit::functor::backendspermitted ( sspair  )

virtual

Getter for listing permitted backends.

Reimplemented in Gambit::module_functor_common.

Definition at line 246 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The backendspermitted method has not been defined in this class.");
      std::set<sspair> empty;
      return empty;
    }

Here is the call graph for this function:

breakLoop()

void Gambit::functor::breakLoop ( )

virtual

Tell the functor that the loop it manages should break now.

Reimplemented in Gambit::module_functor_common.

Definition at line 276 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

Referenced by Gambit::module_functor_common::breakLoopFromManagedFunctor().

    {
      utils_error().raise(LOCAL_INFO,"The breakLoop method has not been defined in this class.");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculate()

void Gambit::functor::calculate ( )

virtual

Virtual calculate(); needs to be redefined in daughters.

Reimplemented in Gambit::module_functor< void >, Gambit::module_functor< TYPE >, and Gambit::module_functor< ModelParameters >.

Definition at line 76 of file functors.cpp.

Referenced by reset_and_calculate().

{}

Here is the caller graph for this function:

canBeLoopManager()

bool Gambit::functor::canBeLoopManager ( )

virtual

Getter for revealing whether this is permitted to be a manager functor.

Reimplemented in Gambit::module_functor_common.

Definition at line 183 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

Referenced by Gambit::gambit_core::ff_module_diagnostic(), and Gambit::module_functor_common::resolveLoopManager().

    {
      utils_error().raise(LOCAL_INFO,"The canBeLoopManager method has not been defined in this class.");
      return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

capability()

str Gambit::functor::capability

(

)

const

Getter for the wrapped function's reported capability.

Definition at line 117 of file functors.cpp.

References myCapability.

Referenced by backend_conditional_dependencies(), Gambit::module_functor_common::backend_conditional_dependencies(), Gambit::DRes::backendFuncMatchesIniEntry(), Gambit::gambit_core::capability_diagnostic(), Gambit::gambit_core::check_databases(), Gambit::gambit_core::ff_backend_diagnostic(), Gambit::gambit_core::ff_module_diagnostic(), Gambit::DRes::moduleFuncMatchesIniEntry(), Gambit::gambit_core::registerBackendFunctor(), Gambit::gambit_core::registerModuleFunctor(), Gambit::gambit_core::registerPrimaryModelFunctor(), and Gambit::module_functor_common::resolveLoopManager().

{ return myCapability; }

Here is the caller graph for this function:

contains_anything_interpretable_as_member_of()

bool Gambit::functor::contains_anything_interpretable_as_member_of ( std::set< str >  combo, str  group  )

inlineprotected

Test whether any of the entries in a given model group is a valid interpretation of any members in a given combination.

Definition at line 572 of file functors.cpp.

References Gambit::Models::ModelFunctorClaw::downstream_of(), Gambit::Models::ModelFunctorClaw::model_exists(), modelGroups, Gambit::LogTags::models, and myClaw.

Referenced by modelComboAllowed().

    {
      // Work through the members of the model group
      std::set<str> models = modelGroups.at(group);
      for (std::set<str>::const_iterator it = models.begin() ; it != models.end(); ++it)
      {
        if (myClaw->model_exists(*it))
        {
          // Work through the members of the combination
          for (std::set<str>::const_iterator jt = combo.begin() ; jt != combo.end(); ++jt)
          {
            if (myClaw->model_exists(*jt))
            {
              if (myClaw->downstream_of(*jt, *it)) return true;
            }
          }
        }
      }
      return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

dependencies()

std::set< sspair > Gambit::functor::dependencies ( )

virtual

Getter for listing currently activated dependencies.

Reimplemented in Gambit::module_functor_common.

Definition at line 218 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

Referenced by Gambit::gambit_core::ff_module_diagnostic().

    {
      utils_error().raise(LOCAL_INFO,"The dependencies method has not been defined in this class.");
      std::set<sspair> empty;
      return empty;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

failBigTime()

void Gambit::functor::failBigTime ( str  method )

staticprotected

Attempt to retrieve a dependency or model parameter that has not been resolved.

Definition at line 522 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      str error_msg = "Attempted to use a functor method from a null pointer.";
      error_msg  += "\nProbably you tried to use a conditional dependency that has"
                    "\nnot been activated, or a model parameter that is not defined"
                    "\nin the model for which this function has been invoked."
                    "\nPlease check your module function source code."
                    "\nMethod invoked: " + method + ".";
      utils_error().raise(LOCAL_INFO,error_msg);
    }

Here is the call graph for this function:

find_friend_or_parent_model_in_map()

str Gambit::functor::find_friend_or_parent_model_in_map ( str  model, std::map< str, std::set< sspair > >  karta  )

protected

Try to find a parent or friend model in some user-supplied map from models to sspair vectors.

Try to find a parent or friend model in some user-supplied map from models to sspair vectors Preferentially returns the 'least removed' parent or friend, i.e.

less steps back in the model lineage.

Definition at line 607 of file functors.cpp.

References Gambit::Models::ModelFunctorClaw::downstream_of(), Gambit::Models::ModelFunctorClaw::model_exists(), and myClaw.

Referenced by Gambit::module_functor_common::model_conditional_backend_reqs(), and Gambit::module_functor_common::model_conditional_dependencies().

    {
      std::vector<str> candidates;
      for (std::map< str, std::set<sspair> >::reverse_iterator it = karta.rbegin() ; it != karta.rend(); ++it)
      {
        if (myClaw->model_exists(it->first))
        {
          if (myClaw->downstream_of(model, it->first)) candidates.push_back(it->first);
        }
      }
      // If found no candidates, return the empty string.
      if (candidates.empty()) return "";
      // If found just one, return it with no further questions.
      if (candidates.size() == 1) return candidates[0];
      // If found more than one, choose the one closest to the model passed in.
      str result = candidates.front();
      for (std::vector<str>::iterator it = candidates.begin()+1; it != candidates.end(); ++it)
      {
        if (myClaw->downstream_of(*it, result)) result = *it;
      }
      return result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

forcematchingbackend()

std::set< sspair > Gambit::functor::forcematchingbackend ( str  )

virtual

Getter for listing backend requirements that must be resolved from the same backend.

Reimplemented in Gambit::module_functor_common.

Definition at line 260 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The forcematchingbackend method has not been defined in this class.");
      std::set<sspair> empty;
      return empty;
    }

Here is the call graph for this function:

getDependees()

safe_ptr< std::set< sspair > > Gambit::functor::getDependees

(

)

Return a safe pointer to the vector of all capability,type pairs of functors arranged downstream of this one in the dependency tree.

Definition at line 413 of file functors.cpp.

References myDependees.

Referenced by Gambit::module_functor_common::notifyOfDependee(), and Gambit::register_function().

    {
      return safe_ptr<std::set<sspair>>(&myDependees);
    }

Here is the caller graph for this function:

getInvalidationRate()

double Gambit::functor::getInvalidationRate ( )

virtual

Reimplemented in Gambit::module_functor_common.

Definition at line 82 of file functors.cpp.

{ return 0; }

getOptions()

safe_ptr< Options > Gambit::functor::getOptions

(

)

Return a safe pointer to the options that this functor is supposed to run with (e.g. from the ini file).

Definition at line 375 of file functors.cpp.

References myOptions.

Referenced by Gambit::register_function().

    {
      return safe_ptr<Options>(&myOptions);
    }

Here is the caller graph for this function:

getRuntimeAverage()

double Gambit::functor::getRuntimeAverage ( )

virtual

Interfaces for runtime optimization Need to be implemented by daughters.

Reimplemented in Gambit::module_functor_common.

Definition at line 81 of file functors.cpp.

{ return 0; }

getSubCaps()

safe_ptr< Options > Gambit::functor::getSubCaps

(

)

Return a safe pointer to the subcaps that this functor realises it is supposed to facilitate downstream calculation of.

Definition at line 407 of file functors.cpp.

References mySubCaps.

Referenced by Gambit::module_functor_common::notifyOfDependee(), and Gambit::register_function().

    {
      return safe_ptr<Options>(&mySubCaps);
    }

Here is the caller graph for this function:

has_common_elements()

bool Gambit::functor::has_common_elements ( std::set< str >  combo, str  group  )

inlineprotected

Work out whether a given combination of models and a model group have any elements in common.

Definition at line 594 of file functors.cpp.

References modelGroups, and Gambit::LogTags::models.

Referenced by modelComboExplicitlyAllowed().

    {
      // Work through the members of the model group
      std::set<str> models = modelGroups.at(group);
      for (std::set<str>::reverse_iterator it = models.rbegin() ; it != models.rend(); ++it)
      {
        if ( std::find(combo.begin(), combo.end(), *it) == combo.end() ) return true;
      }
      return false;
    }

Here is the caller graph for this function:

in_allowed_combo()

bool Gambit::functor::in_allowed_combo ( str  model )

inlineprotected

Check that a model is actually part of a combination that is allowed to be used with this functor.

Definition at line 547 of file functors.cpp.

References allowedGroupCombos, Gambit::Models::ModelFunctorClaw::downstream_of(), combine_hdf5::group, Gambit::Models::ModelFunctorClaw::model_exists(), modelAllowed(), modelGroups, Gambit::LogTags::models, and myClaw.

    {
      // If the model is allowed on its own, just give the thumbs up immediately.
      if (modelAllowed(model)) return true;
      // Loop over the allowed combinations, and check if the passed model matches anything in any of them
      for(std::set<std::set<str> >::const_iterator group_combo = allowedGroupCombos.begin(); group_combo != allowedGroupCombos.end(); group_combo++)
      {
        //Loop over each group in the allowed group combination, and check if the model is interpretable as a model in the group.
        for(std::set<str>::const_iterator group = group_combo->begin(); group != group_combo->end(); group++)
        {
          // Work through the members of the model group
          std::set<str> models = modelGroups.at(*group);
          for (std::set<str>::reverse_iterator it = models.rbegin() ; it != models.rend(); ++it)
          {
            if (myClaw->model_exists(*it))
            {
              if (myClaw->downstream_of(model, *it)) return true;
            }
          }
        }
      }
      return false;
    }

Here is the call graph for this function:

label()

str Gambit::functor::label

(

)

const

Getter for string label.

Getter for the printer label.

Definition at line 148 of file functors.cpp.

References myLabel.

{ return myLabel; }

loopManagerCapability()

str Gambit::functor::loopManagerCapability ( )

virtual

Getter for revealing the required capability of the wrapped function's loop manager.

Reimplemented in Gambit::module_functor_common.

Definition at line 190 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

Referenced by Gambit::gambit_core::ff_module_diagnostic().

    {
      utils_error().raise(LOCAL_INFO,"The loopManagerCapability method has not been defined in this class.");
      return "none";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loopManagerName()

str Gambit::functor::loopManagerName ( )

virtual

Getter for revealing the name of the wrapped function's assigned loop manager.

Reimplemented in Gambit::module_functor_common.

Definition at line 204 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The loopManagerName method has not been defined in this class.");
      return "none";
    }

Here is the call graph for this function:

loopManagerOrigin()

str Gambit::functor::loopManagerOrigin ( )

virtual

Getter for revealing the module of the wrapped function's assigned loop manager.

Reimplemented in Gambit::module_functor_common.

Definition at line 211 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The loopManagerOrigin method has not been defined in this class.");
      return "none";
    }

Here is the call graph for this function:

loopManagerType()

str Gambit::functor::loopManagerType ( )

virtual

Getter for revealing the required type of the wrapped function's loop manager.

Reimplemented in Gambit::module_functor_common.

Definition at line 197 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The loopManagerType method has not been defined in this class.");
      return "none";
    }

Here is the call graph for this function:

model_conditional_backend_reqs()

std::set< sspair > Gambit::functor::model_conditional_backend_reqs ( str  )

virtual

Getter for listing model-specific conditional backend requirements.

Reimplemented in Gambit::module_functor_common.

Definition at line 303 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The model_conditional_backend_reqs method has not been defined in this class.");
      std::set<sspair> empty;
      return empty;
    }

Here is the call graph for this function:

model_conditional_dependencies()

std::set< sspair > Gambit::functor::model_conditional_dependencies ( str  )

virtual

Getter for listing model-specific conditional dependencies.

Reimplemented in Gambit::module_functor_common.

Definition at line 295 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The model_conditional_dependencies method has not been defined in this class.");
      std::set<sspair> empty;
      return empty;
    }

Here is the call graph for this function:

modelAllowed()

bool Gambit::functor::modelAllowed

(

str

model

)

Test whether the functor is always allowed (either explicitly or implicitly) to be used with a given model.

Test whether the functor is allowed (either explicitly or implicitly) to be used with a given model.

Definition at line 419 of file functors.cpp.

References allowed_parent_or_friend_exists(), allowedGroupCombos, allowedModels, myLabel, and verbose.

Referenced by in_allowed_combo(), and modelComboAllowed().

    {
      bool allowed = false;
      if (verbose)
      {
        std::cout << "Checking allowedModels set for functor "<<myLabel<<std::endl;
        for(std::set<str>::iterator it = allowedModels.begin(); it != allowedModels.end(); ++it)
        {
          std::cout << "  "<< *it << std::endl;
        }
      }
      if (allowedModels.empty() and allowedGroupCombos.empty()) allowed=true;
      if (allowed_parent_or_friend_exists(model)) allowed=true;
      if (verbose) std::cout << "  Allowed to be used with model "<<model<<"? "<<allowed<<std::endl;
      return allowed;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

modelComboAllowed()

bool Gambit::functor::modelComboAllowed

(

std::set< str >

combo

)

Test whether the functor is allowed (either explicitly or implicitly) to be used with a given combination of models.

Definition at line 453 of file functors.cpp.

References allowedGroupCombos, contains_anything_interpretable_as_member_of(), combine_hdf5::group, and modelAllowed().

    {
     // If any model in the combo is always allowed, then give the combo a thumbs up.
      for(std::set<str>::const_iterator model = combo.begin(); model != combo.end(); model++)
      {
        if (modelAllowed(*model)) return true;
      }
      // Loop over the allowed combinations, and check if the passed combo matches any of them
      for(std::set<std::set<str> >::const_iterator group_combo = allowedGroupCombos.begin(); group_combo != allowedGroupCombos.end(); group_combo++)
      {
        bool matches = true;
        //Loop over each group in the allowed group combination, and check if one of the entries in the passed model combination matches it somehow.
        for(std::set<str>::const_iterator group = group_combo->begin(); group != group_combo->end(); group++)
        {
          matches = matches and contains_anything_interpretable_as_member_of(combo, *group);
          if (not matches) break;
        }
        //Return true immediately if all entries in the allowed group combination have been matched.
        if (matches) return true;
      }
      return false;
    }

Here is the call graph for this function:

modelComboExplicitlyAllowed()

bool Gambit::functor::modelComboExplicitlyAllowed

(

std::set< str >

combo

)

Test whether the functor has been explictly allowed to be used with a given combination of models.

Definition at line 477 of file functors.cpp.

References allowedGroupCombos, combine_hdf5::group, has_common_elements(), and modelExplicitlyAllowed().

    {
      // If any model in the combo is always explicitly allowed, then give the combo a thumbs up.
      for(std::set<str>::const_iterator model = combo.begin(); model != combo.end(); model++)
      {
        if (modelExplicitlyAllowed(*model)) return true;
      }
      // Loop over the allowed combinations, and check if the passed combo matches any of them
      for(std::set<std::set<str> >::const_iterator group_combo = allowedGroupCombos.begin(); group_combo != allowedGroupCombos.end(); group_combo++)
      {
        bool matches = true;
        //Loop over each group in the allowed group combination, and check if one of the entries in the passed model combination matches it explicitly.
        for(std::set<str>::const_iterator group = group_combo->begin(); group != group_combo->end(); group++)
        {
          matches = matches and has_common_elements(combo, *group);
          if (not matches) break;
        }
        //Return true immediately if all entries in the allowed group combination have been matched.
        if (matches) return true;
      }
      return false;
    }

Here is the call graph for this function:

modelExplicitlyAllowed()

bool Gambit::functor::modelExplicitlyAllowed

(

str

model

)

Test whether the functor is explictly always allowed to be used with a given model.

Test whether the functor has been explictly allowed to be used with a given model.

Definition at line 437 of file functors.cpp.

References allowedModels.

Referenced by modelComboExplicitlyAllowed().

    {
      if (allowedModels.find(model) != allowedModels.end()) return true;
      return false;
    }

Here is the caller graph for this function:

name()

str Gambit::functor::name

(

)

const

Getter for the wrapped function's name.

Definition at line 115 of file functors.cpp.

References myName.

Referenced by Gambit::DRes::backendFuncMatchesIniEntry(), Gambit::module_functor_common::breakLoopFromManagedFunctor(), Gambit::module_functor< void >::calculate(), Gambit::gambit_core::check_databases(), Gambit::gambit_core::ff_backend_diagnostic(), Gambit::gambit_core::ff_module_diagnostic(), Gambit::module_functor_common::loopManagerName(), main(), Gambit::Likelihood_Container::main(), Gambit::module_functor_common::makeBackendMatchingRule(), Gambit::module_functor_common::makeBackendOptionRule(), Gambit::DRes::moduleFuncMatchesIniEntry(), Gambit::safety_bucket_base::name(), Gambit::DRes::DependencyResolver::resolveRequirement(), Gambit::module_functor_common::retrieve_conditional_dep_type_pair(), Gambit::module_functor_common::setBackendConditionalDependencySingular(), Gambit::module_functor_common::setNestedList(), and Gambit::module_functor_common::setPermittedBackend().

{ return myName; }

Here is the caller graph for this function:

notifyOfBackends()

void Gambit::functor::notifyOfBackends ( std::map< str, std::set< str > >  )

virtual

Indicate to the functor which backends are actually loaded and working.

Reimplemented in Gambit::module_functor_common.

Definition at line 341 of file functors.cpp.

References LOCAL_INFO, print(), Gambit::utils_error(), and Gambit::utils_warning().

Referenced by Gambit::gambit_core::accountForMissingClasses().

    {
      utils_error().raise(LOCAL_INFO,"The notifyOfBackends method has not been defined in this class.");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

notifyOfDependee()

void Gambit::functor::notifyOfDependee ( functor *  )

virtual

Notify the functor that it is being used to fill a dependency of another functor.

Reimplemented in Gambit::module_functor_common.

Definition at line 335 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

Referenced by Gambit::module_functor_common::resolveDependency().

    {
      utils_error().raise(LOCAL_INFO,"The notifyOfDependee method has not been defined in this class.");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

notifyOfIniOptions()

void Gambit::functor::notifyOfIniOptions

(

const Options &

opt

)

Notify the functor about an instance of the options class that contains information from its corresponding ini-file entry in the auxiliaries or observables section.

Definition at line 369 of file functors.cpp.

References myOptions.

    {
      myOptions = opt;
    }

notifyOfInvalidation()

void Gambit::functor::notifyOfInvalidation ( const str &  )

virtual

Reimplemented in Gambit::module_functor_common.

Definition at line 84 of file functors.cpp.

{}

notifyOfModel()

void Gambit::functor::notifyOfModel ( str  )

virtual

Notify the functor that a certain model is being scanned, so that it can activate itself accordingly.

Notify the functor that a certain model is being scanned, so that it can activate its dependencies accordingly.

Reimplemented in Gambit::module_functor_common.

Definition at line 329 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The notifyOfModel method has not been defined in this class.");
    }

Here is the call graph for this function:

notifyOfSubCaps()

void Gambit::functor::notifyOfSubCaps

(

const Options &

subcaps

)

Notify the functor about an instance of the options class that contains sub-capability information.

Definition at line 381 of file functors.cpp.

References Gambit::Options::getValue(), Gambit::Options::hasKey(), LOCAL_INFO, myName, myOrigin, mySubCaps, Gambit::Options::setValue(), and Gambit::utils_error().

Referenced by Gambit::module_functor_common::notifyOfDependee().

    {
      for (auto entry : subcaps)
      {
        str key = entry.first.as<std::string>();
        if (not mySubCaps.hasKey(key)) mySubCaps.setValue(key, entry.second);
        else
        {
          std::ostringstream ss1, ss2;
          ss1 << mySubCaps.getValue<YAML::Node>(key);
          ss2 << entry.second.as<YAML::Node>();
          if (not (ss1.str() == ss2.str()))
          {
            std::ostringstream ss;
            ss << "Duplicate sub_capability clash. " << endl
               << "Your ObsLike section of the YAML file contains both " << endl
               << key << ": " << ss1.str() << endl << "and" << endl << key << ": " << ss2.str() << endl
               << "GAMBIT does not know which value to choose when trying to determine the sub-capabilities" << endl
               << "served by " << myOrigin << "::" << myName << ", as both ObsLike entries depend on this function.";
            utils_error().raise(LOCAL_INFO, ss.str());
          }
        }
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

origin()

str Gambit::functor::origin

(

)

const

Getter for the wrapped function's origin (module or backend name)

Definition at line 121 of file functors.cpp.

References myOrigin.

Referenced by backend_conditional_dependencies(), Gambit::module_functor_common::backend_conditional_dependencies(), Gambit::gambit_core::backend_diagnostic(), Gambit::DRes::backendFuncMatchesIniEntry(), Gambit::module_functor_common::breakLoopFromManagedFunctor(), Gambit::module_functor< void >::calculate(), Gambit::gambit_core::capability_diagnostic(), Gambit::gambit_core::check_databases(), Gambit::gambit_core::ff_backend_diagnostic(), Gambit::gambit_core::ff_model_diagnostic(), Gambit::gambit_core::ff_module_diagnostic(), Gambit::DRes::DependencyResolver::getObsLike(), Gambit::module_functor_common::loopManagerOrigin(), main(), Gambit::Likelihood_Container::main(), Gambit::module_functor_common::makeBackendMatchingRule(), Gambit::module_functor_common::makeBackendOptionRule(), Gambit::gambit_core::model_diagnostic(), Gambit::gambit_core::module_diagnostic(), Gambit::DRes::moduleFuncMatchesIniEntry(), Gambit::safety_bucket_base::origin(), Gambit::module_functor_common::resolveBackendReq(), Gambit::DRes::DependencyResolver::resolveRequirement(), Gambit::module_functor_common::retrieve_conditional_dep_type_pair(), Gambit::module_functor_common::setBackendConditionalDependencySingular(), Gambit::module_functor_common::setNestedList(), and Gambit::module_functor_common::setPermittedBackend().

{ return myOrigin; }

Here is the caller graph for this function:

print() [1/2]

void Gambit::functor::print ( Printers::BasePrinter *  printer, const int  pointID, int  thread_num  )

virtual

Printer function.

Print function.

Reimplemented in Gambit::module_functor< void >, Gambit::module_functor< TYPE >, and Gambit::module_functor< ModelParameters >.

Definition at line 348 of file functors.cpp.

Referenced by notifyOfBackends(), and print().

      {
        str warn_msg = "This is the functor base class print function! This should not\n";
        warn_msg += "be used; the print function should be redefined in daughter\n"
                    "functor classes. If this is running there is a problem somewhere.\n"
                    "Currently only functors derived from module_functor_common<!=void>\n"
                    "are allowed to try to print themselves; i.e. backend and void\n"
                    "functors may not do this (they inherit this default message).";
        utils_warning().raise(LOCAL_INFO,warn_msg);
      }

Here is the caller graph for this function:

print() [2/2]

void Gambit::functor::print ( Printers::BasePrinter *  printer, const int  pointID  )

virtual

Printer function (no-thread-index short-circuit)

Reimplemented in Gambit::module_functor< void >, Gambit::module_functor< TYPE >, and Gambit::module_functor< ModelParameters >.

Definition at line 360 of file functors.cpp.

References print().

      {
        print(printer,pointID,0);
      }

Here is the call graph for this function:

purpose()

str Gambit::functor::purpose

(

)

const

Getter for purpose (relevant for output nodes, aka helper structures for the dep. resolution)

Definition at line 138 of file functors.cpp.

References myPurpose.

Referenced by Gambit::module_functor_common::setDependency(), and setPurpose().

{ return myPurpose; }

Here is the caller graph for this function:

quantity()

sspair Gambit::functor::quantity

(

)

const

Getter for the overall quantity provided by the wrapped function (capability-type pair)

Definition at line 136 of file functors.cpp.

References myCapability, and myType.

Referenced by Gambit::module_functor_common::notifyOfDependee(), Gambit::module_functor_common::resolveBackendReq(), and Gambit::module_functor_common::resolveDependency().

{ return std::make_pair(myCapability, myType); }

Here is the caller graph for this function:

requiresPrinting()

bool Gambit::functor::requiresPrinting ( ) const

virtual

Getter indicating if the wrapped function's result should to be printed.

Reimplemented in Gambit::module_functor< TYPE >, and Gambit::module_functor< ModelParameters >.

Definition at line 144 of file functors.cpp.

{ return false; }

requiresTimingPrinting()

bool Gambit::functor::requiresTimingPrinting ( ) const

virtual

Getter indicating if the timing data for this function's execution should be printed.

Reimplemented in Gambit::module_functor_common.

Definition at line 146 of file functors.cpp.

{ return false; }

reset() [1/2]

void Gambit::functor::reset ( )

virtual

Reimplemented in Gambit::module_functor_common.

Definition at line 85 of file functors.cpp.

Referenced by reset_and_calculate().

{}

Here is the caller graph for this function:

reset() [2/2]

void Gambit::functor::reset ( int  )

protectedvirtual

Reset functor for one thread only.

Reimplemented in Gambit::module_functor_common.

Definition at line 86 of file functors.cpp.

{}

reset_and_calculate()

void Gambit::functor::reset_and_calculate ( )

virtual

Reset-then-recalculate method.

Definition at line 90 of file functors.cpp.

References calculate(), and reset().

{ this->reset(omp_get_thread_num()); this->calculate(); }

Here is the call graph for this function:

resolveBackendReq()

void Gambit::functor::resolveBackendReq ( functor *  )

virtual

Resolve a backend requirement using a pointer to another functor object.

Reimplemented in Gambit::module_functor_common.

Definition at line 323 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The resolveBackendReq method has not been defined in this class.");
    }

Here is the call graph for this function:

resolveDependency()

void Gambit::functor::resolveDependency ( functor *  )

virtual

Resolve a dependency using a pointer to another functor object.

Reimplemented in Gambit::module_functor_common.

Definition at line 311 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The resolveDependency method has not been defined in this class.");
    }

Here is the call graph for this function:

resolveLoopManager()

void Gambit::functor::resolveLoopManager ( functor *  )

virtual

Set this functor's loop manager (if it has one)

Reimplemented in Gambit::module_functor_common.

Definition at line 317 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The resolveLoopManager method has not been defined in this class.");
    }

Here is the call graph for this function:

retrieve_invalid_point_exception()

invalid_point_exception * Gambit::functor::retrieve_invalid_point_exception ( )

virtual

Retrieve the previously saved exception generated when this functor invalidated the current point in model space.

Reimplemented in Gambit::module_functor_common.

Definition at line 631 of file functors.cpp.

{ return NULL; }

safe_version()

str Gambit::functor::safe_version ( ) const

virtual

Getter for the 'safe' incarnation of the version of the wrapped function's origin (module or backend)

Reimplemented in Gambit::backend_functor_common< PTR_TYPE, TYPE, ARGS >, Gambit::backend_functor_common< void(*)(ARGS...), void, ARGS... >, Gambit::backend_functor_common< variadic_ptr< void, ARGS... >::type, void, ARGS... >, Gambit::backend_functor_common< variadic_ptr< TYPE, ARGS... >::type, TYPE, ARGS... >, and Gambit::backend_functor_common< TYPE(*)(ARGS...), TYPE, ARGS... >.

Definition at line 125 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

Referenced by Gambit::module_functor_common::resolveBackendReq().

{ utils_error().raise(LOCAL_INFO,"The safe_version method is only defined for backend functors."); return ""; }

Here is the call graph for this function:

Here is the caller graph for this function:

setAllowedModel()

void Gambit::functor::setAllowedModel

(

str

model

)

Add a model to the internal list of models for which this functor is allowed to be used.

Definition at line 450 of file functors.cpp.

References allowedModels.

Referenced by Gambit::register_model_singly().

{ allowedModels.insert(model); }

Here is the caller graph for this function:

setAllowedModelGroupCombo()

void Gambit::functor::setAllowedModelGroupCombo

(

str

groups

)

Add a combination of model groups to the internal list of combinations for which this functor is allowed to be used.

Add a model group combination to the internal list of combinations for which this functor is allowed to be used.

Definition at line 511 of file functors.cpp.

References allowedGroupCombos, Gambit::Utils::delimiterSplit(), Gambit::Utils::strip_parentheses(), and Gambit::Utils::strip_whitespace_except_after_const().

Referenced by Gambit::register_model_combination().

    {
      //Strip the group combo of its parentheses and whitespace, then split it and save it in the vector of allowed combos
      Utils::strip_parentheses(groups);
      Utils::strip_whitespace_except_after_const(groups);
      std::vector<str> v = Utils::delimiterSplit(groups, ",");
      std::set<str> group_combo(v.begin(), v.end());
      allowedGroupCombos.insert(group_combo);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFadeRate()

void Gambit::functor::setFadeRate ( double  )

virtual

Reimplemented in Gambit::module_functor_common.

Definition at line 83 of file functors.cpp.

{}

setInUse()

virtual void Gambit::functor::setInUse ( bool  )

inlinevirtual

Set the inUse flag (must be overridden in derived class to have any effect).

Reimplemented in Gambit::backend_functor_common< PTR_TYPE, TYPE, ARGS >, Gambit::backend_functor_common< void(*)(ARGS...), void, ARGS... >, Gambit::backend_functor_common< variadic_ptr< void, ARGS... >::type, void, ARGS... >, Gambit::backend_functor_common< variadic_ptr< TYPE, ARGS... >::type, TYPE, ARGS... >, and Gambit::backend_functor_common< TYPE(*)(ARGS...), TYPE, ARGS... >.

Definition at line 130 of file functors.hpp.

References Gambit::ColliderBit::print().

Referenced by setStatus().

{};

Here is the call graph for this function:

Here is the caller graph for this function:

setIteration()

void Gambit::functor::setIteration ( long long  )

virtual

Set the iteration number in a loop in which this functor runs.

Reimplemented in Gambit::module_functor_common.

Definition at line 177 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The setIteration method has not been defined in this class.");
    }

Here is the call graph for this function:

setModelGroup()

void Gambit::functor::setModelGroup	(	str	group,
		str	contents
	)

Add a model group definition to the internal list of model groups.

Definition at line 501 of file functors.cpp.

References Gambit::Utils::delimiterSplit(), combine_hdf5::group, modelGroups, and Gambit::Utils::strip_parentheses().

Referenced by Gambit::register_model_group().

    {
      //Strip the group contents of its parentheses, then split it, turn it into a set and save it in the map
      Utils::strip_parentheses(contents);
      std::vector<str> v = Utils::delimiterSplit(contents, ",");
      std::set<str> combo(v.begin(), v.end());
      modelGroups[group] = combo;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setNestedList()

void Gambit::functor::setNestedList ( std::vector< functor *> &  )

virtual

Set the ordered list of pointers to other functors that should run nested in a loop managed by this one.

Reimplemented in Gambit::module_functor_common.

Definition at line 171 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      utils_error().raise(LOCAL_INFO,"The setNestedList method has not been defined in this class.");
    }

Here is the call graph for this function:

setOption()

template<typename TYPE >

void Gambit::functor::setOption ( const str &  key, const TYPE  val  )

inline

Set an option for the functor directly (for use in standalone executables).

Definition at line 269 of file functors.hpp.

      {
        myOptions.setValue<str,TYPE>(key, val);
      }

setPrintRequirement()

void Gambit::functor::setPrintRequirement ( bool  flag )

virtual

Setter for indicating if the wrapped function's result should to be printed.

Reimplemented in Gambit::module_functor< TYPE >, and Gambit::module_functor< ModelParameters >.

Definition at line 153 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      if (flag)
      {
        utils_error().raise(LOCAL_INFO,"The setPrintRequirement method has not been defined in this class.");
      }
    }

Here is the call graph for this function:

setPurpose()

void Gambit::functor::setPurpose

(

str

purpose

)

Setter for purpose (relevant only for next-to-output functors)

Definition at line 93 of file functors.cpp.

References myPurpose, and purpose().

Referenced by Gambit::module_functor_common::resolveDependency().

{ myPurpose = purpose; }

Here is the call graph for this function:

Here is the caller graph for this function:

setStatus()

void Gambit::functor::setStatus

(

int

stat

)

Setter for status: -6 = required external tool absent (pybind11) -5 = required external tool absent (Mathematica) -4 = required backend absent (backend ini functions) -3 = required classes absent -2 = function absent -1 = origin absent 0 = model incompatibility (default) 1 = available 2 = active.

Setter for status: -4 = required backend absent (backend ini functions) -3 = required classes absent -2 = function absent -1 = origin absent 0 = model incompatibility (default) 1 = available 2 = active.

Definition at line 108 of file functors.cpp.

References myStatus, and setInUse().

Referenced by Gambit::module_functor_common::resolveBackendReq().

    {
      myStatus = stat;
      setInUse(myStatus == 2);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSubCap()

template<typename TYPE >

void Gambit::functor::setSubCap ( const str &  key, const TYPE  val  )

inline

Set a sub-capability (subcap)for the functor directly (for use in standalone executables).

Definition at line 282 of file functors.hpp.

References combine_hdf5::group.

      {
        mySubCaps.setValue<str,TYPE>(key, val);
      }

setTimingPrintRequirement()

void Gambit::functor::setTimingPrintRequirement ( bool  flag )

virtual

Setter for indicating if the timing data for this function's execution should be printed.

Setter for indicating if the timing data for this functor should be printed.

Reimplemented in Gambit::module_functor_common.

Definition at line 162 of file functors.cpp.

References LOCAL_INFO, and Gambit::utils_error().

    {
      if (flag)
      {
        utils_error().raise(LOCAL_INFO,"The setTimingPrintRequirement method has not been defined in this class.");
      }
    }

Here is the call graph for this function:

setTimingVertexID()

void Gambit::functor::setTimingVertexID

(

int

ID

)

Set ID for timing 'vertex' (used in printer system)

Acquire ID for timing 'vertex' (used in printer system)

Definition at line 99 of file functors.cpp.

References myTimingVertexID.

{ myTimingVertexID = ID; }

setVertexID()

void Gambit::functor::setVertexID

(

int

ID

)

Setter for vertex ID (used in printer system)

Definition at line 96 of file functors.cpp.

References myVertexID.

{ myVertexID = ID; }

status()

int Gambit::functor::status

(

)

const

Getter for the wrapped function current status: -4 = required backend absent (backend ini functions) -3 = required classes absent -2 = function absent -1 = origin absent 0 = model incompatibility (default) 1 = available 2 = active.

Definition at line 134 of file functors.cpp.

References myStatus.

Referenced by Gambit::Models::ModelFunctorClaw::checkPrimaryModelFunctorUsage(), and Gambit::gambit_core::ff_backend_diagnostic().

{ return myStatus; }

Here is the caller graph for this function:

timingLabel()

str Gambit::functor::timingLabel

(

)

const

Getter for the printer timing label.

Definition at line 150 of file functors.cpp.

References myTimingLabel.

{ return myTimingLabel; }

timingVertexID()

int Gambit::functor::timingVertexID

(

)

const

Getter for timing vertex ID.

Definition at line 142 of file functors.cpp.

References myTimingVertexID.

{ return myTimingVertexID; }

type()

str Gambit::functor::type

(

)

const

Getter for the wrapped function's reported return type.

Definition at line 119 of file functors.cpp.

References myType.

Referenced by backend_conditional_dependencies(), Gambit::module_functor_common::backend_conditional_dependencies(), Gambit::DRes::backendFuncMatchesIniEntry(), Gambit::gambit_core::check_databases(), Gambit::gambit_core::ff_backend_diagnostic(), Gambit::gambit_core::ff_module_diagnostic(), Gambit::DRes::moduleFuncMatchesIniEntry(), Gambit::module_functor_common::resolveLoopManager(), and Gambit::module_functor_common::setBackendReq().

{ return myType; }

Here is the caller graph for this function:

version()

str Gambit::functor::version

(

)

const

Getter for the version of the wrapped function's origin (module or backend)

Definition at line 123 of file functors.cpp.

References myVersion.

Referenced by backend_conditional_dependencies(), Gambit::module_functor_common::backend_conditional_dependencies(), Gambit::gambit_core::backend_diagnostic(), Gambit::DRes::backendFuncMatchesIniEntry(), Gambit::gambit_core::check_databases(), Gambit::gambit_core::ff_backend_diagnostic(), Gambit::module_functor_common::resolveBackendReq(), Gambit::DRes::DependencyResolver::resolveRequirement(), and Gambit::BE_bucket_base::version().

{ return myVersion; }

Here is the caller graph for this function:

vertexID()

int Gambit::functor::vertexID

(

)

const

Getter for vertex ID.

Definition at line 140 of file functors.cpp.

References myVertexID.

{ return myVertexID; }

Member Data Documentation

allowedGroupCombos

std::set<std::set<str> > Gambit::functor::allowedGroupCombos

protected

List of allowed model group combinations.

Definition at line 367 of file functors.hpp.

Referenced by allModelsAllowed(), in_allowed_combo(), modelAllowed(), modelComboAllowed(), modelComboExplicitlyAllowed(), and setAllowedModelGroupCombo().

allowedModels

std::set<str> Gambit::functor::allowedModels

protected

List of allowed models.

Definition at line 364 of file functors.hpp.

Referenced by allModelsAllowed(), allowed_parent_or_friend_exists(), Gambit::module_functor_common::fill_activeModelFlags(), modelAllowed(), modelExplicitlyAllowed(), and setAllowedModel().

modelGroups

std::map<str, std::set<str> > Gambit::functor::modelGroups

protected

Map from model group names to group contents.

Definition at line 370 of file functors.hpp.

Referenced by contains_anything_interpretable_as_member_of(), Gambit::module_functor_common::fill_activeModelFlags(), has_common_elements(), in_allowed_combo(), and setModelGroup().

myCapability

str Gambit::functor::myCapability

protected

Internal storage of exactly what the function calculates.

Definition at line 322 of file functors.hpp.

Referenced by capability(), and quantity().

myClaw

const Models::ModelFunctorClaw* Gambit::functor::myClaw

protected

Bound model functor claw, for checking relationships between models.

Definition at line 332 of file functors.hpp.

Referenced by allowed_parent_or_friend_exists(), contains_anything_interpretable_as_member_of(), find_friend_or_parent_model_in_map(), in_allowed_combo(), and Gambit::module_functor_common::notifyOfModel().

myDependees

std::set<sspair> Gambit::functor::myDependees

protected

List of all capability,type pairs of functors downstream of this one in the dependency tree.

Definition at line 361 of file functors.hpp.

Referenced by getDependees(), and Gambit::module_functor_common::notifyOfDependee().

myLabel

const str Gambit::functor::myLabel

protected

String label, used to label functor results for printer system.

Definition at line 335 of file functors.hpp.

Referenced by label(), and modelAllowed().

myName

str Gambit::functor::myName

protected

Internal storage of the function name.

Definition at line 320 of file functors.hpp.

Referenced by Gambit::module_functor_common::check_missing_LogTag(), Gambit::FunctorHelp::entering_multithreaded_region(), Gambit::module_functor_common::getActiveModelFlag(), Gambit::FunctorHelp::leaving_multithreaded_region(), name(), notifyOfSubCaps(), Gambit::module_functor_common::resolveBackendReq(), Gambit::module_functor_common::resolveDependency(), and Gambit::module_functor_common::resolveLoopManager().

myOptions

Options Gambit::functor::myOptions

protected

Internal storage of function options, as a YAML node.

Definition at line 355 of file functors.hpp.

Referenced by getOptions(), and notifyOfIniOptions().

myOrigin

str Gambit::functor::myOrigin

protected

Internal storage of the name of the module or backend to which the function belongs.

Definition at line 326 of file functors.hpp.

Referenced by Gambit::module_functor_common::check_missing_LogTag(), Gambit::module_functor_common::getActiveModelFlag(), Gambit::module_functor_common::module_functor_common(), notifyOfSubCaps(), origin(), Gambit::module_functor_common::resolveBackendReq(), Gambit::module_functor_common::resolveDependency(), and Gambit::module_functor_common::resolveLoopManager().

myPurpose

str Gambit::functor::myPurpose

protected

Purpose of the function (relevant for output and next-to-output functors)

Definition at line 330 of file functors.hpp.

Referenced by purpose(), Gambit::module_functor_common::resolveDependency(), Gambit::module_functor_common::setDependency(), and setPurpose().

myStatus

int Gambit::functor::myStatus

protected

Status: -4 = required backend absent (backend ini functions) -3 = required classes absent -2 = function absent -1 = origin absent 0 = model incompatibility (default) 1 = available 2 = active.

Definition at line 346 of file functors.hpp.

Referenced by Gambit::module_functor< void >::calculate(), Gambit::module_functor_common::notifyOfBackends(), setStatus(), and status().

mySubCaps

Options Gambit::functor::mySubCaps

protected

Internal storage of function sub-capabilities, as a YAML node.

Definition at line 358 of file functors.hpp.

Referenced by getSubCaps(), and notifyOfSubCaps().

myTimingLabel

const str Gambit::functor::myTimingLabel

protected

String label, used to label functor timing data for printer system.

Definition at line 337 of file functors.hpp.

Referenced by timingLabel().

myTimingVertexID

int Gambit::functor::myTimingVertexID

protected

ID assigned by printers to the timing data output stream.

Definition at line 350 of file functors.hpp.

Referenced by setTimingVertexID(), and timingVertexID().

myType

str Gambit::functor::myType

protected

Internal storage of the type of what the function calculates.

Definition at line 324 of file functors.hpp.

Referenced by quantity(), and type().

myVersion

str Gambit::functor::myVersion

protected

Internal storage of the version of the module or backend to which the function belongs.

Definition at line 328 of file functors.hpp.

Referenced by version().

myVertexID

int Gambit::functor::myVertexID

protected

Internal storage of the vertex ID number used by the printer system to identify functors.

Definition at line 348 of file functors.hpp.

Referenced by setVertexID(), and vertexID().

verbose

bool Gambit::functor::verbose

protected

Debug flag.

Definition at line 352 of file functors.hpp.

Referenced by modelAllowed(), and Gambit::module_functor_common::notifyOfModel().

---

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

• Elements/include/gambit/Elements/functors.hpp
• Elements/src/functors.cpp