home
about
news
download
doc
source
systems
tests
bugs
contact
IMP Reference Guide
2.6.1
The Integrative Modeling Platform
IMP Manual
Reference Guide
Modules
Classes
Examples
include
IMP
core
SingletonRestraint.h
Go to the documentation of this file.
1
// Autogenerated by ../../../../tmp/nightly-build-59000/imp-2.6.1/tools/build/make_containers.py
2
// from ../../../../tmp/nightly-build-59000/imp-2.6.1/tools/build/container_templates/core/ClassnameRestraint.h
3
// Do not edit - any changes will be lost!
4
5
/**
6
* \file IMP/core/SingletonRestraint.h
7
* \brief Apply a SingletonScore to a Singleton.
8
*
9
* Copyright 2007-2016 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/internal/TupleRestraint.h>
19
#include <
IMP/SingletonScore.h
>
20
21
#include <iostream>
22
23
IMPCORE_BEGIN_NAMESPACE
24
25
//! Applies a SingletonScore to a Singleton.
26
/** This restraint stores a Singleton.
27
\see SingletonRestraint
28
*/
29
class
SingletonRestraint
:
30
#if defined(SWIG) || defined(IMP_DOXYGEN)
31
public
Restraint
32
#else
33
public
IMP::internal::TupleRestraint<SingletonScore>
34
#endif
35
{
36
public
:
37
//! Create the restraint.
38
/** This function takes the function to apply to the
39
stored Singleton and the Singleton.
40
*/
41
SingletonRestraint
(
Model
*m,
SingletonScore
*ss,
ParticleIndex
vt,
42
std::string name =
"SingletonRestraint %1%"
)
43
: IMP::internal::TupleRestraint<
SingletonScore
>(ss, m, vt, name) {
44
}
45
46
//! Create the restraint.
47
/** This function takes the function to apply to the
48
stored Singleton and the Singleton.
49
\deprecated_at{2.5} Use the index-based constructor instead.
50
*/
51
IMPCORE_DEPRECATED_METHOD_DECL(2.5)
52
SingletonRestraint
(
SingletonScore
*ss,
Particle
* vt,
53
std::
string
name = "
SingletonRestraint
%1%")
54
: IMP::internal::TupleRestraint<
SingletonScore
>(
55
ss, IMP::internal::get_model(vt),
56
IMP::internal::
get_index
(vt), name) {
57
IMPCORE_DEPRECATED_METHOD_DEF(2.5,
58
"Use the index-based constructor instead."
);
59
}
60
61
#if defined(SWIG) || defined(IMP_DOXYGEN)
62
protected
:
63
double
unprotected_evaluate(
IMP::DerivativeAccumulator
*accum)
const
;
64
IMP::ModelObjectsTemp
do_get_inputs()
const
;
65
IMP_OBJECT_METHODS
(
SingletonRestraint
)
66
#endif
67
};
68
69
IMPCORE_END_NAMESPACE
70
71
#endif
/* IMPCORE_SINGLETON_RESTRAINT_H */
IMP::core::SingletonRestraint::SingletonRestraint
SingletonRestraint(Model *m, SingletonScore *ss, ParticleIndex vt, std::string name="SingletonRestraint %1%")
Create the restraint.
Definition:
SingletonRestraint.h:41
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition:
object_macros.h:25
IMP::Index< ParticleIndexTag >
IMP::Vector
Definition:
Vector.h:42
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition:
Model.h:72
IMP::domino::get_index
Ints get_index(const ParticlesTemp &particles, const Subset &subset, const Subsets &excluded)
IMP::SingletonScore
Abstract class for scoring object(s) of type ParticleIndex.
Definition:
SingletonScore.h:37
SingletonScore.h
Define SingletonScore.
IMP::Particle
Class to handle individual model particles.
Definition:
Particle.h:37
IMP::core::SingletonRestraint
Applies a SingletonScore to a Singleton.
Definition:
SingletonRestraint.h:29
IMP::DerivativeAccumulator
Class for adding derivatives from restraints to the model.
Definition:
DerivativeAccumulator.h:25
IMP::Restraint
A restraint is a term in an IMP ScoringFunction.
Definition:
Restraint.h:52