IMP logo
IMP Reference Guide  2.16.0
The Integrative Modeling Platform
SingletonConstraint.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-315/imp-2.16.0/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-315/imp-2.16.0/tools/build/container_templates/core/ClassnameConstraint.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/core/SingletonConstraint.h
7  * \brief Use a SingletonModifier applied to a ParticlesTemp to
8  * maintain an invariant
9  *
10  * Copyright 2007-2021 IMP Inventors. All rights reserved.
11  */
12 
13 #ifndef IMPCORE_SINGLETON_CONSTRAINT_H
14 #define IMPCORE_SINGLETON_CONSTRAINT_H
15 
16 #include <IMP/core/core_config.h>
17 #include <IMP/internal/TupleConstraint.h>
18 #include <IMP/SingletonModifier.h>
20 
21 IMPCORE_BEGIN_NAMESPACE
22 //! Apply a SingletonFunction to a Singleton
23 /** The score state is passed up to two SingletonModifiers, one to
24  apply before evaluation and the other after. The one after
25  should take a DerivativeAccumulator as its last argument for
26  SingletonModifier::apply() and will only be called if
27  the score was computed with derivatives.
28 
29  \see container::SingletonsConstraint
30  */
32 #if defined(IMP_DOXYGEN) || defined(SWIG)
33  public Constraint
34 #else
35  public IMP::internal::TupleConstraint<SingletonModifier,
36  SingletonDerivativeModifier>
37 #endif
38  {
39  public:
40  /** \deprecated_at{2.1} Use the model/index constructor.
41  */
42  IMPCORE_DEPRECATED_METHOD_DECL(2.1)
45  std::string name = "SingletonConstraint %1%")
46  : IMP::internal::TupleConstraint<
48  name) {
49  IMPCORE_DEPRECATED_METHOD_DEF(2.1, "Use the model/index constructor.");
50  }
51 
54  ParticleIndex vt,
55  std::string name = "SingletonConstraint %1%",
56  bool can_skip=false)
57  : IMP::internal::TupleConstraint<
59  vt, name,
60  can_skip) {}
61 
62 #if defined(IMP_DOXYGEN) || defined(SWIG)
63  protected:
64  void do_update_attributes();
65  void do_update_derivatives(DerivativeAccumulator *da);
66  virtual ModelObjectsTemp do_get_inputs() const;
67  virtual ModelObjectsTemp do_get_outputs() const;
69 #endif
70 };
71 
72 IMPCORE_END_NAMESPACE
73 
74 #endif /* IMPCORE_SINGLETON_CONSTRAINT_H */
A base class for modifiers of ParticlesTemp.
A Modifier on ParticlesTemp.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
Apply a SingletonFunction to a Singleton.
A more IMP-like version of the std::vector.
Definition: Vector.h:40
Implement a constraint on the Model.
Definition: Constraint.h:49
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:73
A Modifier on ParticlesTemp.
Class to handle individual particles of a Model object.
Definition: Particle.h:41
Class for adding derivatives from restraints to the model.