IMP logo
IMP Reference Guide  2.20.0
The Integrative Modeling Platform
PairsRestraint.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-18515/imp-2.20.0/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-18515/imp-2.20.0/tools/build/container_templates/container/ClassnamesRestraint.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/container/PairsRestraint.h
7  * \brief Apply a PairScore to each Pair in a list.
8  *
9  * Copyright 2007-2023 IMP Inventors. All rights reserved.
10  *
11  */
12 
13 #ifndef IMPCONTAINER_PAIRS_RESTRAINT_H
14 #define IMPCONTAINER_PAIRS_RESTRAINT_H
15 
16 #include <IMP/container/container_config.h>
17 #include <IMP/internal/ContainerRestraint.h>
18 #include <IMP/PairContainer.h>
19 #include <IMP/PairScore.h>
20 #include <cereal/access.hpp>
21 #include <cereal/types/base_class.hpp>
22 
23 IMPCONTAINER_BEGIN_NAMESPACE
24 
25 //! Applies a PairScore to each Pair in a list.
26 /** This restraint stores the used particle indexes in a ParticleIndexPairs.
27  The container used can be set so that the list can be shared
28  with other containers (or a nonbonded list can be used).
29 
30  Examples using various multiplicity containers:
31  \include restrain_in_sphere.py
32  \include nonbonded_interactions.py
33 
34  \see IMP::core::PairRestraint
35  */
37 #if defined(SWIG) || defined(IMP_DOXYGEN)
38  public Restraint
39 #else
40  public IMP::internal::ContainerRestraint<PairScore, PairContainer>
41 #endif
42  {
43  typedef IMP::internal::ContainerRestraint<
45 
46  friend class cereal::access;
47 
48  template<class Archive> void serialize(Archive &ar) {
49  ar(cereal::base_class<P>(this));
50  }
52 
53  public:
54  //! Create the restraint with a shared container
55  /** \param[in] ss The function to apply to each particle.
56  \param[in] pc The container containing the stored particles. This
57  container is not copied.
58  \param[in] name The object name
59  */
61  std::string name = "PairsRestraint %1%")
62  : P(ss, pc, name) {}
63 
64  PairsRestraint() {}
65 
66 #if defined(IMP_DOXYGEN) || defined(SWIG)
67  double unprotected_evaluate(IMP::DerivativeAccumulator *accum) const;
68  IMP::ModelObjectsTemp do_get_inputs() const;
70 #endif
71 };
72 
74 
75 IMPCONTAINER_END_NAMESPACE
76 
77 #endif /* IMPCONTAINER_PAIRS_RESTRAINT_H */
Abstract class for scoring object(s) of type ParticleIndexPair.
Definition: PairScore.h:44
A shared container for Pairs.
Definition: PairContainer.h:39
PairsRestraint(PairScore *ss, PairContainerAdaptor pc, std::string name="PairsRestraint %1%")
Create the restraint with a shared container.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
A more IMP-like version of the std::vector.
Definition: Vector.h:42
A container for Pairs.
Define PairScore.
#define IMP_OBJECT_SERIALIZE_DECL(Name)
Declare methods needed for serialization of Object pointers.
Definition: object_macros.h:95
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing lists of object pointers.
Definition: object_macros.h:44
Applies a PairScore to each Pair in a list.
Class for adding derivatives from restraints to the model.
A restraint is a term in an IMP ScoringFunction.
Definition: Restraint.h:56