home
about
news
download
doc
source
systems
tests
bugs
contact
IMP Reference Guide
2.18.0
The Integrative Modeling Platform
IMP Manual
Reference Guide
Tutorial Index
Modules
Classes
Examples
include
IMP
core
version 2.18.0
AngleRestraint.h
Go to the documentation of this file.
1
/**
2
* \file IMP/core/AngleRestraint.h
3
* \brief Angle restraint between three particles.
4
*
5
* Copyright 2007-2022 IMP Inventors. All rights reserved.
6
*
7
*/
8
9
#ifndef IMPCORE_ANGLE_RESTRAINT_H
10
#define IMPCORE_ANGLE_RESTRAINT_H
11
12
#include <IMP/core/core_config.h>
13
#include "
AngleTripletScore.h
"
14
#include "
XYZ.h
"
15
16
#include <
IMP/core/TripletRestraint.h
>
17
#include <
IMP/UnaryFunction.h
>
18
19
IMPCORE_BEGIN_NAMESPACE
20
21
//! Angle restraint between three particles
22
/** \see AngleTripletScore
23
*/
24
class
IMPCOREEXPORT
AngleRestraint
:
public
TripletRestraint
{
25
public
:
26
//! Create the angle restraint.
27
/** \param[in] m Model.
28
\param[in] score_func Scoring function for the restraint.
29
\param[in] p1 First particle in angle restraint.
30
\param[in] p2 Second particle in angle restraint.
31
\param[in] p3 Third particle in angle restraint.
32
*/
33
AngleRestraint
(
Model
*m,
UnaryFunction
* score_func,
ParticleIndexAdaptor
p1,
34
ParticleIndexAdaptor
p2,
ParticleIndexAdaptor
p3);
35
36
IMP_OBJECT_METHODS
(
AngleRestraint
);
37
};
38
39
IMPCORE_END_NAMESPACE
40
41
#endif
/* IMPCORE_ANGLE_RESTRAINT_H */
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition:
object_macros.h:25
IMP::ParticleIndexAdaptor
Take Decorator, Particle or ParticleIndex.
Definition:
particle_index.h:32
UnaryFunction.h
Single variable function.
XYZ.h
Simple XYZ decorator.
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition:
Model.h:73
IMP::core::AngleRestraint
Angle restraint between three particles.
Definition:
AngleRestraint.h:24
IMP::core::TripletRestraint
Applies a TripletScore to a Triplet.
Definition:
TripletRestraint.h:29
TripletRestraint.h
Apply a TripletScore to a Triplet.
IMP::UnaryFunction
Abstract single variable functor class for score functions.
Definition:
UnaryFunction.h:25
AngleTripletScore.h
A Score on the angle between three particles.