IMP  2.3.0
The Integrative Modeling Platform
QuadRestraint.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/QuadRestraint.h
3  * \brief Apply a QuadScore to a Quad.
4  *
5  * WARNING This file was generated from QuadRestraint.h
6  * in /tmp/nightly-build-54722/imp-2.3.0/tools/build/container_templates/core
7  * by tools/build/make_containers.py.
8  *
9  * Copyright 2007-2014 IMP Inventors. All rights reserved.
10  *
11  */
12 
13 #ifndef IMPCORE_QUAD_RESTRAINT_H
14 #define IMPCORE_QUAD_RESTRAINT_H
15 
16 #include <IMP/core/core_config.h>
17 
18 #include <IMP/kernel/internal/TupleRestraint.h>
19 #include <IMP/QuadScore.h>
20 
21 #include <iostream>
22 
23 IMPCORE_BEGIN_NAMESPACE
24 
25 //! Applies a QuadScore to a Quad.
26 /** This restraint stores a Quad.
27  \see QuadRestraint
28  */
30 #if defined(SWIG) || defined(IMP_DOXYGEN)
31  public Restraint
32 #else
33  public IMP::kernel::internal::TupleRestraint<QuadScore>
34 #endif
35  {
36  public:
37  //! Create the restraint.
38  /** This function takes the function to apply to the
39  stored Quad and the Quad.
40  */
42  std::string name = "QuadRestraint %1%")
43  : IMP::kernel::internal::TupleRestraint<QuadScore>(
44  ss, IMP::kernel::internal::get_model(vt),
45  IMP::kernel::internal::get_index(vt), name) {}
46 
47  //! Create the restraint.
48  /** This function takes the function to apply to the
49  stored Quad and the Quad.
50  */
52  std::string name = "QuadRestraint %1%")
53  : IMP::kernel::internal::TupleRestraint<QuadScore>(ss, m, vt, name) {
54  }
55 
56 #if defined(SWIG) || defined(IMP_DOXYGEN)
57  protected:
58  double unprotected_evaluate(IMP::DerivativeAccumulator *accum) const;
59  IMP::kernel::ModelObjectsTemp do_get_inputs() const;
61 #endif
62 };
63 
64 IMPCORE_END_NAMESPACE
65 
66 #endif /* IMPCORE_QUAD_RESTRAINT_H */
QuadRestraint(QuadScore *ss, const kernel::ParticleQuad &vt, std::string name="QuadRestraint %1%")
Create the restraint.
Definition: QuadRestraint.h:41
Abstract class for scoring object(s) of type ParticleQuad.
Class for adding derivatives from restraints to the model.
Ints get_index(const kernel::ParticlesTemp &particles, const Subset &subset, const Subsets &excluded)
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
A restraint is a term in an IMP ScoringFunction.
Applies a QuadScore to a Quad.
Definition: QuadRestraint.h:29
Import IMP/kernel/QuadScore.h in the namespace.
QuadRestraint(kernel::Model *m, QuadScore *ss, const kernel::ParticleIndexQuad &vt, std::string name="QuadRestraint %1%")
Create the restraint.
Definition: QuadRestraint.h:51
Class for storing model, its restraints, constraints, and particles.
Definition: kernel/Model.h:73