IMP logo

IMP::Sampler Class Reference


Detailed Description

Base class for all samplers.

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 a sampler works by using one or more Optimizer types to search for configurations which minimize the scoring function.

Inheritance diagram for IMP::Sampler:

Inheritance graph
[legend]

Public Member Functions

def __disown__
Modelget_model () const
ConfigurationSetget_sample () const
 Sampler (Model *m, std::string name="Sampler %1%")
Filtering
The set of returned configurations can be filtered on a variety of criteria.

double get_maximum_score () const
void set_maximum_score (Restraint *r, double s)
 Set the maximum allowable score for a restraint.
void set_maximum_score (double s)
 Set the maximum allowable score for the whole model.

Protected Member Functions

virtual ConfigurationSetdo_sample () const =0
 Subclasses should override this method.
bool get_is_good_configuration () const

Friends

template<class T >
void IMP::internal::unref (T *)

Related Functions

(Note that these are not member functions.)

 IMP_SAMPLER(Name)
 Define the basic things you need for a Sampler.

Member Function Documentation

bool IMP::Sampler::get_is_good_configuration (  )  const [protected]

The Sampler can contain a number of filters which limit the set of configurations which are saved. The sampler should check that a state passes the filters before adding it to the returned ConfigurationSet.


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

Generated on Mon Mar 8 23:08:45 2010 for IMP by doxygen 1.5.8