IMP logo
IMP Reference Guide  2.15.0
The Integrative Modeling Platform
version 2.15.0
StateAdaptor.h
Go to the documentation of this file.
1 /**
2  * \file IMP/misc/StateAdaptor.h
3  * \brief XXXXXXXXXXXXXX
4  *
5  * Copyright 2007-2021 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPMISC_STATE_ADAPTOR_H
9 #define IMPMISC_STATE_ADAPTOR_H
10 
11 #include <IMP/misc/misc_config.h>
12 
13 #include <IMP/OptimizerState.h>
14 #include <IMP/ScoreState.h>
15 
16 IMPMISC_BEGIN_NAMESPACE
17 
18 //! Allow OptimizerStates to be used as ScoreStates
19 /** You can have up to two, one for before, and one for after.
20  */
21 class IMPMISCEXPORT StateAdaptor : public ScoreState {
22  IMP::PointerMember<OptimizerState> before_, after_;
23 
24  public:
25  //! set the before and after states
26  StateAdaptor(Model *m, OptimizerState *before, OptimizerState *after);
27  virtual void do_before_evaluate() IMP_OVERRIDE;
28  virtual void do_after_evaluate(DerivativeAccumulator *da) IMP_OVERRIDE;
29  virtual ModelObjectsTemp do_get_inputs() const IMP_OVERRIDE;
30  virtual ModelObjectsTemp do_get_outputs() const IMP_OVERRIDE;
31  IMP_OBJECT_METHODS(StateAdaptor);
32 };
33 
34 IMPMISC_END_NAMESPACE
35 
36 #endif /* IMPMISC_STATE_ADAPTOR_H */
IMP::ScoreState::do_before_evaluate
virtual void do_before_evaluate()=0
Update the state given the current state of the model.
IMP::misc::StateAdaptor
Allow OptimizerStates to be used as ScoreStates.
Definition: StateAdaptor.h:21
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
IMP::ScoreState::do_after_evaluate
virtual void do_after_evaluate(DerivativeAccumulator *accpt)=0
Do any necessary updates after the model score is calculated.
IMP::Vector
A more IMP-like version of the std::vector.
Definition: Vector.h:40
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
IMP::ScoreState
ScoreStates maintain invariants in the Model.
Definition: ScoreState.h:54
IMP::PointerMember
A smart pointer to a ref-counted Object that is a class member.
Definition: Pointer.h:146
ScoreState.h
Shared score state.
IMP::ModelObject::do_get_outputs
virtual ModelObjectsTemp do_get_outputs() const =0
IMP::OptimizerState
Shared optimizer state that is invoked upon commitment of new coordinates.
Definition: OptimizerState.h:43
OptimizerState.h
Shared optimizer state.
IMP::ModelObject::do_get_inputs
virtual ModelObjectsTemp do_get_inputs() const =0
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:78
IMP::DerivativeAccumulator
Class for adding derivatives from restraints to the model.
Definition: DerivativeAccumulator.h:24