IMP  2.1.0
The Integrative Modeling Platform
SerialMover.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/SerialMover.h
3  * \brief A mover that apply other movers one at a time
4  *
5  * Copyright 2007-2013 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPCORE_SERIAL_MOVER_H
10 #define IMPCORE_SERIAL_MOVER_H
11 
12 #include <IMP/core/core_config.h>
13 #include "MonteCarlo.h"
14 #include "MonteCarloMover.h"
15 
16 IMPCORE_BEGIN_NAMESPACE
17 
18 //! Apply a list of movers one at a time
19 /** Each time a move is requested, on the next mover is applied. This
20  should probably be used in conjunction with incremental scoring
21  (MonteCarlo::set_use_incremental()).
22  */
23 class IMPCOREEXPORT SerialMover : public MonteCarloMover {
24  int imov_;
25  MonteCarloMovers movers_;
26 
27  public:
28  /** The Serial are applied one at a time
29  \param[in] mvs list of movers to apply one after another
30  */
32 
33  const MonteCarloMovers& get_movers() const { return movers_; }
34 
35  /** \deprecated_at{2.1} Use the functions on the individual movers. */
36  IMPCORE_DEPRECATED_METHOD_DECL(2.1)
37  double get_acceptance_probability(int i) const;
38  /** \deprecated_at{2.1} Use the functions on the individual movers. */
39  IMPCORE_DEPRECATED_METHOD_DECL(2.1)
40  void reset_acceptance_probabilities();
41  /** \deprecated_at{2.1} Use the functions on the individual movers. */
42  IMPCORE_DEPRECATED_METHOD_DECL(2.1)
43  unsigned int get_number_of_movers() const;
44 
45  protected:
46  virtual kernel::ModelObjectsTemp do_get_inputs() const IMP_OVERRIDE;
47  virtual MonteCarloMoverResult do_propose() IMP_OVERRIDE;
48  virtual void do_reject() IMP_OVERRIDE;
49  virtual void do_accept() IMP_OVERRIDE;
51 };
52 
53 IMPCORE_END_NAMESPACE
54 
55 #endif /* IMPCORE_SERIAL_MOVER_H */
Simple Monte Carlo optimizer.
virtual void do_accept()
Implement accept_proposed_move(), default impl is empty.
virtual void do_reject()=0
Implement reset_proposed_move()
A base class for classes which perturb particles.
The base class for movers for MC optimization.
virtual MonteCarloMoverResult do_propose()=0
Implement propose_move()
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
virtual ModelObjectsTemp do_get_inputs() const =0
Apply a list of movers one at a time.
Definition: SerialMover.h:23