Chemical Data Processing Library C++ API - Version 1.4.0
XBondingInteractionScore.hpp
Go to the documentation of this file.
1 /*
2  * XBondingInteractionScore.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_PHARM_XBONDINGINTERACTIONSCORE_HPP
30 #define CDPL_PHARM_XBONDINGINTERACTIONSCORE_HPP
31 
32 #include <functional>
33 
34 #include "CDPL/Pharm/APIPrefix.hpp"
36 
37 
38 namespace CDPL
39 {
40 
41  namespace Pharm
42  {
43 
44  class Feature;
45 
52  {
53 
54  public:
58  static constexpr double DEF_MIN_AX_DISTANCE = 1.6;
59 
63  static constexpr double DEF_MAX_AX_DISTANCE = 4.0;
64 
68  static constexpr double DEF_MIN_AXB_ANGLE = 150.0;
69 
73  static constexpr double DEF_MAX_ACC_ANGLE = 35.0;
74 
78  typedef std::shared_ptr<XBondingInteractionScore> SharedPointer;
79 
83  typedef std::function<double(double)> DistanceScoringFunction;
84 
88  typedef std::function<double(double)> AngleScoringFunction;
89 
99  XBondingInteractionScore(bool don_acc, double min_ax_dist = DEF_MIN_AX_DISTANCE, double max_ax_dist = DEF_MAX_AX_DISTANCE,
100  double min_axb_ang = DEF_MIN_AXB_ANGLE, double max_acc_ang = DEF_MAX_ACC_ANGLE);
101 
106  double getMinAXDistance() const;
107 
112  double getMaxAXDistance() const;
113 
118  double getMinAXBAngle() const;
119 
124  double getMaxAcceptorAngle() const;
125 
131 
137 
143 
150  double operator()(const Feature& ftr1, const Feature& ftr2) const;
151 
158  double operator()(const Math::Vector3D& ftr1_pos, const Feature& ftr2) const;
159 
160  private:
161  bool donAccOrder;
162  double minAXDist;
163  double maxAXDist;
164  double minAXBAngle;
165  double maxAccAngle;
166  DistanceScoringFunction distScoringFunc;
167  AngleScoringFunction accAngleScoringFunc;
168  AngleScoringFunction axbAngleScoringFunc;
169  };
170  } // namespace Pharm
171 } // namespace CDPL
172 
173 #endif // CDPL_PHARM_XBONDINGINTERACTIONSCORE_HPP
Definition of class CDPL::Pharm::FeatureInteractionScore.
Definition of the preprocessor macro CDPL_PHARM_API.
#define CDPL_PHARM_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Abstract base class for scoring functors that quantify the strength of a directional pharmacophore-fe...
Definition: FeatureInteractionScore.hpp:51
Abstract base class representing a single pharmacophore feature within a parent Pharm::Pharmacophore.
Definition: Feature.hpp:48
Pharm::FeatureInteractionScore implementation that scores a halogen-bond donor/acceptor feature pair ...
Definition: XBondingInteractionScore.hpp:52
std::shared_ptr< XBondingInteractionScore > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated XBondingInteractionScore instance...
Definition: XBondingInteractionScore.hpp:78
void setAXBAngleScoringFunction(const AngleScoringFunction &func)
Specifies the function that maps the acceptor-halogen-bound-atom angle to its score contribution.
double getMaxAXDistance() const
Returns the currently configured maximum halogen-acceptor distance.
double operator()(const Feature &ftr1, const Feature &ftr2) const
Evaluates the halogen-bond interaction score between features ftr1 and ftr2.
double operator()(const Math::Vector3D &ftr1_pos, const Feature &ftr2) const
Evaluates the halogen-bond interaction score with the first feature represented only by its 3D positi...
XBondingInteractionScore(bool don_acc, double min_ax_dist=DEF_MIN_AX_DISTANCE, double max_ax_dist=DEF_MAX_AX_DISTANCE, double min_axb_ang=DEF_MIN_AXB_ANGLE, double max_acc_ang=DEF_MAX_ACC_ANGLE)
Constructs a XBondingInteractionScore functor with the specified scores.
double getMaxAcceptorAngle() const
Returns the currently configured maximum deviation from the acceptor's preferred X-bonding direction.
std::function< double(double)> DistanceScoringFunction
Type of the function mapping a halogen-acceptor distance to its score contribution.
Definition: XBondingInteractionScore.hpp:83
double getMinAXBAngle() const
Returns the currently configured minimum acceptor-halogen-bound-atom angle.
void setAcceptorAngleScoringFunction(const AngleScoringFunction &func)
Specifies the function that maps the acceptor-direction angle to its score contribution.
void setDistanceScoringFunction(const DistanceScoringFunction &func)
Specifies the function that maps the halogen-acceptor distance to its score contribution.
double getMinAXDistance() const
Returns the currently configured minimum halogen-acceptor distance.
std::function< double(double)> AngleScoringFunction
Type of the function mapping a halogen-bond geometry angle to its score contribution.
Definition: XBondingInteractionScore.hpp:88
CVector< double, 3 > Vector3D
Bounded 3 element vector holding floating-point values of type double.
Definition: Vector.hpp:3218
The namespace of the Chemical Data Processing Library.