 |
|
IMP Reference Guide
develop.63b38c487d,2024/12/21
The Integrative Modeling Platform
|
Base class for all samplers. More...
#include <IMP/Sampler.h>
Inheritance diagram for IMP::Sampler:Base class for all samplers.
A sampler takes a Model and searches for good configurations, given the optimizable parameters and the scoring function in the Model and extra information that can be provided. Typically, the current configuration of the model is ignored.
Typically a sampler works by using one or more Optimizer types to search for configurations which minimize the scoring function.
Public Member Functions | |
| Sampler (Model *m, std::string name="Sampler %1%") | |
| ConfigurationSet * | create_sample () const |
| Model * | get_model () const |
| ScoringFunction * | get_scoring_function () const |
| Return the scoring function that is being used. More... | |
| void | set_scoring_function (ScoringFunctionAdaptor sf) |
| Public Member Functions inherited from IMP::Object | |
| virtual void | clear_caches () |
| CheckLevel | get_check_level () const |
| LogLevel | get_log_level () const |
| virtual VersionInfo | get_version_info () const |
| Get information about the module and version of the object. More... | |
| void | set_check_level (CheckLevel l) |
| void | set_log_level (LogLevel l) |
| Set the logging level used in this object. More... | |
| void | set_was_used (bool tf) const |
| void | show (std::ostream &out=std::cout) const |
| const std::string & | get_name () const |
| void | set_name (std::string name) |
| virtual std::string | get_type_name () const |
Protected Member Functions | |
| virtual ConfigurationSet * | do_sample () const =0 |
| Protected Member Functions inherited from IMP::Object | |
| Object (std::string name) | |
| Construct an object with the given name. More... | |
| virtual void | do_destroy () |
| ScoringFunction* IMP::Sampler::get_scoring_function | ( | ) | const |
Return the scoring function that is being used.
| ValueException | if no scoring function was set |