IMP  2.0.1
The Integrative Modeling Platform
IMP::misc::DecayPairContainerOptimizerState Class Reference

Maintain a pair container with a decaying list of pairs. More...

#include <IMP/misc/DecayPairContainerOptimizerState.h>

+ Inheritance diagram for IMP::misc::DecayPairContainerOptimizerState:

Public Member Functions

 DecayPairContainerOptimizerState (PairPredicate *pred, const ParticlePairsTemp &initial_list, std::string name="DecayPairContainerOptimizerState%1%")
 
virtual void do_update (unsigned int call_num)
 
PairContainerget_output_container () const
 
- Public Member Functions inherited from IMP::core::PeriodicOptimizerState
 PeriodicOptimizerState (std::string name)
 
unsigned int get_number_of_updates () const
 Return the number of times update has been called.
 
unsigned int get_period () const
 
virtual void reset ()
 
void set_number_of_updates (unsigned int n)
 Set the counter.
 
void set_period (unsigned int p)
 
void update_always ()
 
- Public Member Functions inherited from IMP::kernel::OptimizerState
 OptimizerState (std::string name="OptimizerState %1%")
 
Optimizerget_optimizer () const
 
virtual void set_is_optimizing (bool)
 
virtual void update ()=0
 Called when the Optimizer accepts a new conformation.
 
- 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)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
- Protected Attributes inherited from IMP::kernel::OptimizerState
UncheckedWeakPointer< Optimizeroptimizer_
 

Detailed Description

The pair container passed to the constructor provides an initial list of pairs. Periodically (see the set_period() method), the pedicate is applied to all the remaining pairs and ones for which it evaluates to 0 are removed.

Definition at line 29 of file DecayPairContainerOptimizerState.h.

Member Function Documentation

virtual void IMP::misc::DecayPairContainerOptimizerState::do_update ( unsigned int  call_number)
virtual

This method is called every get_period() update calls.

Implements IMP::core::PeriodicOptimizerState.


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