IMP  2.0.0
The Integrative Modeling Platform
IMP::kernel::Sampler Class Referenceabstract

Base class for all samplers. More...

#include <IMP/kernel/Sampler.h>

+ Inheritance diagram for IMP::kernel::Sampler:

Public Member Functions

 Sampler (Model *m, std::string name="Sampler %1%")
 
ConfigurationSetcreate_sample () const
 
Modelget_model () const
 
ScoringFunctionget_scoring_function () const
 
void set_scoring_function (ScoringFunctionAdaptor sf)
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual IMP::base::VersionInfo get_version_info () const =0
 Get information about the module and version of the object.
 
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)
 

Protected Member Functions

virtual ConfigurationSetdo_sample () const =0
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 

Related Functions

(Note that these are not member functions.)

typedef IMP::base::Vector
< IMP::base::WeakPointer
< Sampler > > 
SamplersTemp
 

Detailed Description

A sampler takes a Model and searches for good configurations, given the optimizeable parameters and the scoring function in the Model and extra information that can be provided. Typically, the current configuration of the model is ignore.

Typically a sampler works by using one or more Optimizer types to search for configurations which minimize the scoring function.

Definition at line 30 of file kernel/Sampler.h.

Friends And Related Function Documentation

Pass a set of objects.

Definition at line 59 of file kernel/Sampler.h.


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