IMP  2.1.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-90783/imp-2.1.0/tools/build/container_templates/core
7  * by tools/maintenance/setup_containers.py.
8  *
9  * Copyright 2007-2013 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 #include <IMP/restraint_macros.h>
21 
22 #include <iostream>
23 
24 IMPCORE_BEGIN_NAMESPACE
25 
26 //! Applies a QuadScore to a Quad.
27 /** This restraint stores a Quad.
28  \see QuadRestraint
29  */
31 #if defined(SWIG) || defined(IMP_DOXYGEN)
32  public Restraint
33 #else
34  public IMP::kernel::internal::TupleRestraint<QuadScore>
35 #endif
36  {
37  public:
38  //! Create the restraint.
39  /** This function takes the function to apply to the
40  stored Quad and the Quad.
41  */
43  std::string name = "QuadRestraint %1%")
44  : IMP::kernel::internal::TupleRestraint<QuadScore>(
45  ss, IMP::kernel::internal::get_model(vt),
46  IMP::kernel::internal::get_index(vt), name) {}
47 
48 #if defined(SWIG) || defined(IMP_DOXYGEN)
49  protected:
50  double unprotected_evaluate(IMP::DerivativeAccumulator *accum) const;
51  IMP::kernel::ModelObjectsTemp do_get_inputs() const;
53 #endif
54 };
55 
56 IMPCORE_END_NAMESPACE
57 
58 #endif /* IMPCORE_QUAD_RESTRAINT_H */
Abstract score function.
Class for adding derivatives from restraints to the model.
Ints get_index(const kernel::ParticlesTemp &particles, const Subset &subset, const Subsets &excluded)
Import IMP/kernel/restraint_macros.h in the namespace.
QuadRestraint(QuadScore *ss, const ParticleQuad &vt, std::string name="QuadRestraint %1%")
Create the restraint.
Definition: QuadRestraint.h:42
A restraint is a term in an IMP ScoringFunction.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Applies a QuadScore to a Quad.
Definition: QuadRestraint.h:30
Import IMP/kernel/QuadScore.h in the namespace.