IMP logo
IMP Reference Guide  2.16.0
The Integrative Modeling Platform
DecayPairContainerOptimizerState.h
Go to the documentation of this file.
1 /**
2  * \file IMP/misc/DecayPairContainerOptimizerState.h
3  * \brief A pair container with a decaying list of pairs.
4  *
5  * Copyright 2007-2021 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPMISC_DECAY_PAIR_CONTAINER_OPTIMIZER_STATE_H
9 #define IMPMISC_DECAY_PAIR_CONTAINER_OPTIMIZER_STATE_H
10 
11 #include <IMP/misc/misc_config.h>
12 #include <IMP/OptimizerState.h>
13 #include <IMP/PairContainer.h>
14 #include <IMP/PairContainer.h>
15 #include <IMP/OptimizerState.h>
17 #include <IMP/PairPredicate.h>
18 #include <IMP/PairContainer.h>
19 #include <IMP/Pointer.h>
20 
21 IMPMISC_BEGIN_NAMESPACE
22 
23 //! Maintain a pair container with a decaying list of pairs.
24 /** The pair container passed to the constructor provides an initial
25  list of pairs. Periodically (see the set_period() method), the
26  predicate is applied to all the remaining pairs and ones for which
27  it evaluates to 0 are removed.
28  */
30  : public OptimizerState {
34 
35  public:
37  PairPredicate *pred, const ParticleIndexPairs &initial_list,
38  std::string name = "DecayPairContainerOptimizerState%1%");
39 
40  PairContainer *get_output_container() const { return output_; }
41  virtual void do_update(unsigned int call_num) IMP_OVERRIDE;
43 };
44 
45 IMPMISC_END_NAMESPACE
46 
47 #endif /* IMPMISC_DECAY_PAIR_CONTAINER_OPTIMIZER_STATE_H */
A shared container for Pairs.
Definition: PairContainer.h:37
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
Maintain a pair container with a decaying list of pairs.
virtual void do_update(unsigned int)
Store a list of ParticlePairsTemp.
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:73
A container for Pairs.
Define PairPredicate.
A smart pointer to a ref-counted Object that is a class member.
Definition: Pointer.h:146
A nullptr-initialized pointer to an IMP Object.
Abstract predicate function.
Definition: PairPredicate.h:31
Shared optimizer state that is invoked upon commitment of new coordinates.
Shared optimizer state.
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.