IMP logo
IMP Reference Guide  develop.63e71f5352,2022/07/06
The Integrative Modeling Platform
core/DistancePairScore.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/DistancePairScore.h
3  * \brief A Score on the distance between a pair of particles.
4  *
5  * Copyright 2007-2022 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPCORE_DISTANCE_PAIR_SCORE_H
9 #define IMPCORE_DISTANCE_PAIR_SCORE_H
10 
11 #include <IMP/core/core_config.h>
16 IMPCORE_BEGIN_NAMESPACE
17 
18 /** Score a pair of particles based on the distance between their
19  centers using an arbitrary UnaryFunction.
20 
21  Note: implicitly assumes the scored particles are decorated as XYZR.
22 
23  \see XYZR
24  \see SphereDistancePairScore
25  \see DistancePairScore
26  \see SoftSpherePairScore
27 */
29  DistancePairScore, score_functor::UnaryFunctionEvaluate,
30  (UnaryFunction *uf, std::string name = "DistancePairScore%1%"), (uf));
32 
33 #ifndef IMP_DOXYGEN
34 typedef score_functor::Shift<score_functor::Harmonic> HarmonicDistanceScore;
35 #endif
36 
37 /** Score a pair of particles based on the distance between their centers, using a
38  Harmonic. This is faster than DistancePairScore if you
39  are using a Harmonic.
40 
41  Note: implicitly assumes the scored particles are decorated as XYZR.
42 
43  \see XYZR
44  \see SphereDistancePairScore
45  \see DistancePairScore
46  \see SoftSpherePairScore
47 
48 */
50  HarmonicDistancePairScore, HarmonicDistanceScore,
51  (double x0, double k, std::string name = "HarmonicDistancePairScore%1%"),
54 
55 IMPCORE_END_NAMESPACE
56 
57 #endif /* IMPCORE_DISTANCE_PAIR_SCORE_H */
Various important macros for implementing decorators.
#define IMP_FUNCTOR_DISTANCE_PAIR_SCORE(Name, Functor, Args, PassArgs)
A Score on the distance between a pair of particles.
A more IMP-like version of the std::vector.
Definition: Vector.h:40
A harmonic score on the directed distance between a pair of particles, centered at 0...
A Score on the distance between a pair of particles.
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing lists of object pointers.
Definition: object_macros.h:44
Abstract single variable functor class for score functions.
Definition: UnaryFunction.h:25