IMP logo
IMP Reference Guide  2.13.0
The Integrative Modeling Platform
model_statistics.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/model_statistics.h
3  * \brief Write the scores of the passed restraints to a file.
4  *
5  * Copyright 2007-2020 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPCORE_MODEL_STATISTICS_H
9 #define IMPCORE_MODEL_STATISTICS_H
10 
11 #include <IMP/core/core_config.h>
12 #include <IMP/Model.h>
13 #include <IMP/OptimizerState.h>
14 #include <IMP/io.h>
15 
16 IMPCORE_BEGIN_NAMESPACE
17 
18 //! Write the scores of the passed restraints to a file during optimization.
19 /** The file starts with a line whose first character
20  is a # with the names of the restraints separated by commas
21  and then has one line per periodic update with comma
22  separated scores for each restraint.
23 */
25  : public OptimizerState {
26  Restraints rs_;
27  TextOutput out_;
28 
29  public:
31  TextOutput out);
32 
33  protected:
34  virtual void do_update(unsigned int call_num) IMP_OVERRIDE;
36 };
37 
38 IMPCORE_END_NAMESPACE
39 
40 #endif /* IMPCORE_MODEL_STATISTICS_H */
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
Storage of a model, its restraints, constraints and particles.
Write/read the state of the particles to/from a buffer in memory.
virtual void do_update(unsigned int)
Shared optimizer state that is invoked upon commitment of new coordinates.
Shared optimizer state.
Write the scores of the passed restraints to a file during optimization.
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.