IMP logo
IMP Reference Guide  develop.eba5f5c79c,2020/07/08
The Integrative Modeling Platform
Model.h
Go to the documentation of this file.
1 /**
2  * \file IMP/Model.h
3  * \brief Storage of a model, its restraints, constraints and particles.
4  *
5  * Copyright 2007-2020 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPKERNEL_MODEL_H
10 #define IMPKERNEL_MODEL_H
11 
12 #include <IMP/kernel_config.h>
13 #include "ModelObject.h"
14 #include "ScoringFunction.h"
15 #include "Restraint.h"
16 #include "RestraintSet.h"
17 #include "ScoreState.h"
18 #include "container_macros.h"
19 #include "base_types.h"
20 //#include "Particle.h"
21 #include "Undecorator.h"
22 #include "internal/AttributeTable.h"
23 #include "internal/attribute_tables.h"
24 #include <IMP/Object.h>
25 #include <IMP/Pointer.h>
26 #include <boost/unordered_map.hpp>
27 #include <boost/unordered_set.hpp>
28 #include <IMP/tuple_macros.h>
29 #include <boost/iterator/transform_iterator.hpp>
30 #include <boost/iterator/filter_iterator.hpp>
31 
32 #include <limits>
33 
34 IMPKERNEL_BEGIN_NAMESPACE
35 
36 class ModelObject;
37 class Undecorator;
38 class Particle;
39 
40 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
41 namespace internal {
42 enum Stage {
43  NOT_EVALUATING,
44  BEFORE_EVALUATING,
45  EVALUATING,
46  AFTER_EVALUATING,
47  COMPUTING_DEPENDENCIES
48 };
49 }
50 #endif
51 
52 class Model;
53 
54 //! Class for storing model, its restraints, constraints, and particles.
55 /** The Model maintains a standard \imp container for each of Particle,
56  ScoreState and Restraint object types.
57 
58  Each Float attribute has an associated range which reflects the
59  range of values that it is expected to take on during optimization.
60  The optimizer can use these ranges to make the optimization process
61  more efficient. By default, the range estimates are simply the
62  range of values for that attribute in the various particles, but
63  it can be set to another value. For example, an attribute storing
64  an angle could have the range set to (0,PI).
65 
66  The ranges are not enforced; they are just guidelines. In order to
67  enforce ranges, see, for example,
68  IMP::example::ExampleSingletonModifier.
69 
70  \headerfile Model.h "IMP/Model.h"
71  */
72 class IMPKERNELEXPORT Model : public Object
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74  ,
75  public internal::Masks,
76  // The attribute tables provide fast access to
77  // e.g. particle attributes, etc.
78  public internal::FloatAttributeTable,
79  public internal::StringAttributeTable,
80  public internal::IntAttributeTable,
81  public internal::ObjectAttributeTable,
82  public internal::WeakObjectAttributeTable,
83  public internal::IntsAttributeTable,
84  public internal::ObjectsAttributeTable,
85  public internal::ParticleAttributeTable,
86  public internal::ParticlesAttributeTable
87 #endif
88  {
90  // must be up top
91  // we don't want any liveness checks
92  IMP_NAMED_TUPLE_5(NodeInfo, NodeInfos, Edges, inputs, Edges, input_outputs,
93  Edges, outputs, Edges, readers, Edges, writers, );
94  typedef boost::unordered_map<const ModelObject *, NodeInfo> DependencyGraph;
95  DependencyGraph dependency_graph_;
96  boost::unordered_set<const ModelObject *> no_dependencies_;
97  boost::unordered_map<const ModelObject *, ScoreStatesTemp>
98  required_score_states_;
99 
100  // basic representation
101  boost::unordered_map<FloatKey, FloatRange> ranges_;
102 
103  ParticleIndexes free_particles_;
106 
107  Vector<PointerMember<Object> > model_data_;
108 
109  void do_add_dependencies(const ModelObject *mo);
110  void do_clear_required_score_states(ModelObject *mo);
111  void do_check_required_score_states(const ModelObject *mo) const;
112  void do_check_update_order(const ScoreState *ss) const;
113  void do_check_inputs_and_outputs(const ModelObject *mo) const;
114  void do_check_readers_and_writers(const ModelObject *mo) const;
115  void do_check_not_in_readers_and_writers(const ModelObject *mo) const;
116  void do_clear_dependencies(const ModelObject *mo);
117 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
118  // things the evaluate template functions need, can't be bothered with friends
119  public:
120 #endif
121  // check more things on the first call
122  bool first_call_;
123  // the stage of evaluation
124  internal::Stage cur_stage_;
125 
126  ModelObjectsTemp get_dependency_graph_inputs(const ModelObject *mo) const;
127  ModelObjectsTemp get_dependency_graph_outputs(const ModelObject *mo) const;
128  bool do_get_has_dependencies(const ModelObject *mo) const {
129  return no_dependencies_.find(mo) == no_dependencies_.end();
130  }
131  void do_set_has_dependencies(const ModelObject *mo, bool tf);
132  void do_set_has_all_dependencies(bool tf);
133 
134  void validate_computed_derivatives() const {}
135  void set_has_all_dependencies(bool tf);
136  bool get_has_all_dependencies() const;
137  void check_dependency_invariants() const;
138  void check_dependency_invariants(const ModelObject *mo) const;
139  ScoreStatesTemp get_ancestor_score_states(const ModelObject *mo) const;
140  ScoreStatesTemp get_descendent_score_states(const ModelObject *mo) const;
141 
142  void before_evaluate(const ScoreStatesTemp &states);
143  void after_evaluate(const ScoreStatesTemp &states, bool calc_derivs);
144 
145  internal::Stage get_stage() const { return cur_stage_; }
146  ParticleIndex add_particle_internal(Particle *p);
147  static void do_remove_score_state(ScoreState *obj);
148  void do_add_score_state(ScoreState *obj);
149  void do_remove_particle(ParticleIndex pi);
150  bool do_get_has_required_score_states(const ModelObject *mo) const;
151  void do_set_has_required_score_states(ModelObject *mo, bool tf);
152  const ScoreStatesTemp &do_get_required_score_states(const ModelObject *mo)
153  const {
154  IMP_USAGE_CHECK(do_get_has_required_score_states(mo),
155  "Doesn't have score states");
156  return required_score_states_.find(mo)->second;
157  }
158  void do_add_model_object(ModelObject *mo);
159  void do_remove_model_object(ModelObject *mo);
160 
161  public:
162  //! Construct an empty model
163  Model(std::string name = "Model %1%");
164 
165  public:
166 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
167  IMP_MODEL_IMPORT(internal::FloatAttributeTable);
168  IMP_MODEL_IMPORT(internal::StringAttributeTable);
169  IMP_MODEL_IMPORT(internal::IntAttributeTable);
170  IMP_MODEL_IMPORT(internal::ObjectAttributeTable);
171  IMP_MODEL_IMPORT(internal::WeakObjectAttributeTable);
172  IMP_MODEL_IMPORT(internal::IntsAttributeTable);
173  IMP_MODEL_IMPORT(internal::ObjectsAttributeTable);
174  IMP_MODEL_IMPORT(internal::ParticleAttributeTable);
175  IMP_MODEL_IMPORT(internal::ParticlesAttributeTable);
176 #endif
177  //! Clear all the cache attributes of a given particle.
178  void clear_particle_caches(ParticleIndex pi);
179 
180  //! Add particle to the model
181  ParticleIndex add_particle(std::string name);
182 
183  //! Get the name of a particle
184  std::string get_particle_name(ParticleIndex pi);
185 
186  //! Add the passed Undecorator to the particle.
187  void add_undecorator(ParticleIndex pi, Undecorator *d);
188 
189  /** @name States
190 
191  ScoreStates maintain invariants in the Model (see ScoreState
192  for more information.)
193 
194  ScoreStates do not need to be explictly added to the Model, but they
195  can be if desired in order to keep them alive as long as the model is
196  alive.
197 
198  \advancedmethod
199  */
200  /**@{*/
201  IMP_LIST_ACTION(public, ScoreState, ScoreStates, score_state, score_states,
202  ScoreState *, ScoreStates, do_add_score_state(obj), {},
203  do_remove_score_state(obj));
204  /**@}*/
205 
206  public:
207 #ifndef SWIG
208  using Object::clear_caches;
209 #endif
210 
211  //! Sometimes it is useful to be able to make sure the model is up to date
212  /** This method updates all the state but does not necessarily compute the
213  score. Use this to make sure that your containers and rigid bodies are
214  up to date.
215  */
216  void update();
217 
218 #ifdef IMP_DOXYGEN
219  /** \name Accessing attributes
220  \anchor model_attributes
221  All the attribute data associated with each Particle are stored in the
222  Model. For each type of attribute, there are the methods detailed below
223  (where, eg, TypeKey is FloatKey or StringKey)
224  @{
225  */
226  //! add particle atribute with the specied key and initial value
227  /** \pre get_has_attribute(attribute_key, particle) is false*/
228  void add_attribute(TypeKey attribute_key, ParticleIndex particle, Type value);
229 
230  //! remove particle attribute with the specied key
231  /** \pre get_has_attribute(attribute_key, particle) is true*/
232  void remove_attribute(TypeKey attribute_key, ParticleIndex particle);
233 
234  //! return true if particle has attribute with the specified key
235  bool get_has_attribute(TypeKey attribute_key, ParticleIndex particle) const;
236 
237  //! set the value of particle attribute with the specified key
238  /** \pre get_has_attribute(attribute_key, particle) is true*/
239  void set_attribute(TypeKey attribute_key, ParticleIndex particle, Type value);
240 
241  //! get the value of the particle attribute with the specified key
242  /** \pre get_has_attribute(attribute_key, particle) is true*/
243  Type get_attribute(TypeKey attribute_key, ParticleIndex particle);
244 
245  /** Cache attributes, unlike normal attributes, can be added during
246  evaluation. They are also cleared by the clear_cache_attributes() method.
247  Cache attributes should be used when one is adding data to a particle
248  to aid scoring (eg cache the rigid body collision acceleration structure).
249 
250  When some pertinent aspect of the particle changes, the clear method
251  should
252  be called (yes, this is a bit vague). Examples where it should be cleared
253  include changing the set of members of a core::RigidBody or their
254  coordinates, changing the members of an atom::Hierarchy.
255  */
256  void add_cache_attribute(TypeKey attribute_key, ParticleIndex particle,
257  Type value);
258 
259  //! Optimized attributes are the parameters of the model that are
260  //! allowed to be modified by samplers and optimizers
261  void set_is_optimized(TypeKey attribute_key, ParticleIndex particle,
262  bool true_or_false);
263 /** @} */
264 #endif
265 
266 #ifdef SWIG
267 #define IMP_MODEL_ATTRIBUTE_METHODS(Type, Value) \
268  void add_attribute(Type##Key attribute_key, ParticleIndex particle, \
269  Value value); \
270  void remove_attribute(Type##Key attribute_key, ParticleIndex particle); \
271  bool get_has_attribute(Type##Key attribute_key, \
272  ParticleIndex particle) const; \
273  void set_attribute(Type##Key attribute_key, ParticleIndex particle, \
274  Value value); \
275  Value get_attribute(Type##Key attribute_key, ParticleIndex particle); \
276  void add_cache_attribute(Type##Key attribute_key, ParticleIndex particle, \
277  Value value)
278 
279  IMP_MODEL_ATTRIBUTE_METHODS(Float, Float);
280  IMP_MODEL_ATTRIBUTE_METHODS(Int, Int);
281  IMP_MODEL_ATTRIBUTE_METHODS(Ints, Ints);
282  IMP_MODEL_ATTRIBUTE_METHODS(String, String);
283  IMP_MODEL_ATTRIBUTE_METHODS(ParticleIndexes, ParticleIndexes);
284  IMP_MODEL_ATTRIBUTE_METHODS(ParticleIndex, ParticleIndex);
285  IMP_MODEL_ATTRIBUTE_METHODS(Object, Object *);
286  IMP_MODEL_ATTRIBUTE_METHODS(WeakObject, Object *);
287  void set_is_optimized(FloatKey, ParticleIndex, bool);
288  void add_to_derivative(FloatKey k, ParticleIndex particle, double v,
289  const DerivativeAccumulator &da);
290 #endif
291 
292  //! Get the particle from an index.
294  IMP_USAGE_CHECK(get_has_particle(p), "Invalid particle requested");
295  return particle_index_[p];
296  }
297 
298  //! Check whether a given particle index exists.
300  if (particle_index_.size() <= get_as_unsigned_int(p)) return false;
301  return particle_index_[p];
302  }
303 
304  //! Get all particle indexes
306 
307  //! Get all the ModelObjects associated with this Model.
308  ModelObjectsTemp get_model_objects() const;
309 
310  //! Remove a particle from the Model.
311  /** The particle will then be inactive and cannot be used for anything
312  and all data stored in the particle is lost.
313  */
314  void remove_particle(ParticleIndex pi);
315 
316  /** \name Storing data in the model
317 
318  One can store data associated with the model. This is used, for example,
319  to keep a central ScoreState to normalize rigid body rotational variables.
320  @{ */
321  //! Store a piece of data in the model referenced by the key.
322  void add_data(ModelKey mk, Object *o);
323  //! Get back some data stored in the model.
324  Object *get_data(ModelKey mk) const;
325  //! Remove data stored in the model.
326  void remove_data(ModelKey mk);
327  //! Check if the model has a certain piece of data attached.
328  bool get_has_data(ModelKey mk) const;
329  /** @} */
330 
332 
333  public:
334 #if !defined(IMP_DOXYGEN)
335  virtual void do_destroy() IMP_OVERRIDE;
336 #endif
337 };
338 
339 IMPKERNEL_END_NAMESPACE
340 
341 // This is needed for per cpp compilations, a not even sure why
342 // (perhaps cause Model returns ParticleIterator here and there?)
343 // - Feel free to remove if you *really* know what you're doing
344 #include "IMP/Particle.h"
345 
346 #endif /* IMPKERNEL_MODEL_H */
Particle * get_particle(ParticleIndex p) const
Get the particle from an index.
Definition: Model.h:293
Basic types used by IMP.
Used to hold a set of related restraints.
boost::graph DependencyGraph
A directed graph on the interactions between the various objects in the model.
The base class for decorators.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
void add_particle(RMF::FileHandle fh, Particle *hs)
Various general useful macros for IMP.
virtual void clear_caches()
Definition: Object.h:227
bool get_has_particle(ParticleIndex p) const
Check whether a given particle index exists.
Definition: Model.h:299
Macros to define containers of objects.
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
virtual void do_destroy()
Definition: Object.h:231
Common base class for heavy weight IMP objects.
Definition: Object.h:106
ParticleIndexes get_particle_indexes(ParticlesTemp const &particles)
ScoreStates maintain invariants in the Model.
Definition: ScoreState.h:53
Shared score state.
Single variable function.
Classes to handle individual model particles. (Note that implementation of inline functions is in int...
A nullptr-initialized pointer to an IMP Object.
A shared base class to help in debugging and things.
Represents a scoring function on the model.
double Float
Basic floating-point value (could be float, double...)
Definition: types.h:20
Class to handle individual particles of a Model object.
Definition: Particle.h:41
#define IMP_USAGE_CHECK(expr, message)
A runtime test for incorrect usage of a class or method.
Definition: check_macros.h:168
Abstract base class for all restraints.
int Int
Basic integer value.
Definition: types.h:35
std::string String
Basic string value.
Definition: types.h:44
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Class for adding derivatives from restraints to the model.