IMP
2.1.1
The Integrative Modeling Platform
IMP Mainpage
All IMP Modules
Related Pages
Modules
Namespaces
Classes
Files
Examples
Indexes
File List
File Members
SingletonRestraint.h
Go to the documentation of this file.
1
/**
2
* \file IMP/core/SingletonRestraint.h
3
* \brief Apply a SingletonScore to a Singleton.
4
*
5
* WARNING This file was generated from SingletonRestraint.h
6
* in /tmp/nightly-build-61576/imp-2.1.1/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_SINGLETON_RESTRAINT_H
14
#define IMPCORE_SINGLETON_RESTRAINT_H
15
16
#include <IMP/core/core_config.h>
17
18
#include <IMP/kernel/internal/TupleRestraint.h>
19
#include <
IMP/SingletonScore.h
>
20
#include <
IMP/restraint_macros.h
>
21
22
#include <iostream>
23
24
IMPCORE_BEGIN_NAMESPACE
25
26
//! Applies a SingletonScore to a Singleton.
27
/** This restraint stores a Singleton.
28
\see SingletonRestraint
29
*/
30
class
SingletonRestraint
:
31
#if defined(SWIG) || defined(IMP_DOXYGEN)
32
public
Restraint
33
#else
34
public
IMP::kernel::internal::TupleRestraint<SingletonScore>
35
#endif
36
{
37
public
:
38
//! Create the restraint.
39
/** This function takes the function to apply to the
40
stored Singleton and the Singleton.
41
*/
42
SingletonRestraint
(
SingletonScore
*ss,
Particle
* vt,
43
std::string name =
"SingletonRestraint %1%"
)
44
: IMP::kernel::internal::TupleRestraint<
SingletonScore
>(
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
;
52
IMP_OBJECT_METHODS
(
SingletonRestraint
)
53
#endif
54
};
55
56
IMPCORE_END_NAMESPACE
57
58
#endif
/* IMPCORE_SINGLETON_RESTRAINT_H */
IMP::kernel::DerivativeAccumulator
Class for adding derivatives from restraints to the model.
Definition:
kernel/DerivativeAccumulator.h:25
IMP::domino::get_index
Ints get_index(const kernel::ParticlesTemp &particles, const Subset &subset, const Subsets &excluded)
IMP::core::SingletonRestraint::SingletonRestraint
SingletonRestraint(SingletonScore *ss, Particle *vt, std::string name="SingletonRestraint %1%")
Create the restraint.
Definition:
SingletonRestraint.h:42
IMP::base::Vector
Definition:
base/Vector.h:37
restraint_macros.h
Import IMP/kernel/restraint_macros.h in the namespace.
IMP::kernel::Restraint
A restraint is a term in an IMP ScoringFunction.
Definition:
kernel/declare_Restraint.h:52
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition:
base/object_macros.h:25
IMP::kernel::Particle
Class to handle individual model particles.
Definition:
kernel/declare_Particle.h:34
SingletonScore.h
Import IMP/kernel/SingletonScore.h in the namespace.
IMP::kernel::SingletonScore
Abstract score function.
Definition:
kernel/SingletonScore.h:33
IMP::core::SingletonRestraint
Applies a SingletonScore to a Singleton.
Definition:
SingletonRestraint.h:30