Chemical Data Processing Library C++ API - Version 1.4.0
HBondingInteractionScore.hpp
Go to the documentation of this file.
1 /*
2  * HBondingInteractionScore.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_HBONDINGINTERACTIONSCORE_HPP
30 #define CDPL_PHARM_HBONDINGINTERACTIONSCORE_HPP
31 
32 #include <functional>
33 
34 #include "CDPL/Pharm/APIPrefix.hpp"
36 
37 
38 namespace CDPL
39 {
40 
41  namespace Pharm
42  {
43 
50  {
51 
52  public:
54  static constexpr double DEF_MIN_HB_LENGTH = 1.2;
56  static constexpr double DEF_MAX_HB_LENGTH = 2.8;
58  static constexpr double DEF_MIN_AHD_ANGLE = 150.0;
60  static constexpr double DEF_MAX_ACC_ANGLE = 75.0;
61 
65  typedef std::shared_ptr<HBondingInteractionScore> SharedPointer;
66 
68  typedef std::function<double(double)> DistanceScoringFunction;
70  typedef std::function<double(double)> AngleScoringFunction;
71 
81  HBondingInteractionScore(bool don_acc, double min_len = DEF_MIN_HB_LENGTH, double max_len = DEF_MAX_HB_LENGTH,
82  double min_ahd_ang = DEF_MIN_AHD_ANGLE, double max_acc_ang = DEF_MAX_ACC_ANGLE);
83 
88  double getMinLength() const;
89 
94  double getMaxLength() const;
95 
100  double getMinAHDAngle() const;
101 
106  double getMaxAcceptorAngle() const;
107 
113 
119 
125 
132  double operator()(const Feature& ftr1, const Feature& ftr2) const;
133 
140  double operator()(const Math::Vector3D& ftr1_pos, const Feature& ftr2) const;
141 
142  private:
143  bool donAccOrder;
144  double minLength;
145  double maxLength;
146  double minAHDAngle;
147  double maxAccAngle;
148  DistanceScoringFunction distScoringFunc;
149  AngleScoringFunction accAngleScoringFunc;
150  AngleScoringFunction ahdAngleScoringFunc;
151  };
152  } // namespace Pharm
153 } // namespace CDPL
154 
155 #endif // CDPL_PHARM_HBONDINGINTERACTIONSCORE_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 donor/acceptor feature pair by combining ...
Definition: HBondingInteractionScore.hpp:50
void setAHDAngleScoringFunction(const AngleScoringFunction &func)
Specifies the function that maps the acceptor-hydrogen-donor angle to its score contribution.
double operator()(const Feature &ftr1, const Feature &ftr2) const
Evaluates the H-bond interaction score between features ftr1 and ftr2.
std::function< double(double)> AngleScoringFunction
Type of the function mapping an H-bond geometry angle to its score contribution.
Definition: HBondingInteractionScore.hpp:70
double getMinLength() const
Returns the currently configured minimum H-bond length.
HBondingInteractionScore(bool don_acc, double min_len=DEF_MIN_HB_LENGTH, double max_len=DEF_MAX_HB_LENGTH, double min_ahd_ang=DEF_MIN_AHD_ANGLE, double max_acc_ang=DEF_MAX_ACC_ANGLE)
Constructs a HBondingInteractionScore functor with the specified constraints.
double getMaxLength() const
Returns the currently configured maximum H-bond length.
double getMaxAcceptorAngle() const
Returns the currently configured maximum H-bond direction to acceptor-vector angle.
double getMinAHDAngle() const
Returns the currently configured minimum acceptor-hydrogen-donor angle.
double operator()(const Math::Vector3D &ftr1_pos, const Feature &ftr2) const
Evaluates the H-bond interaction score with the first feature represented only by its 3D position ftr...
std::function< double(double)> DistanceScoringFunction
Type of the function mapping an H-bond length to its score contribution.
Definition: HBondingInteractionScore.hpp:68
void setDistanceScoringFunction(const DistanceScoringFunction &func)
Specifies the function that maps the H-bond length to its score contribution.
void setAcceptorAngleScoringFunction(const AngleScoringFunction &func)
Specifies the function that maps the H-bond direction to acceptor-vector angle to its score contribut...
std::shared_ptr< HBondingInteractionScore > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated HBondingInteractionScore instance...
Definition: HBondingInteractionScore.hpp:65
CVector< double, 3 > Vector3D
Bounded 3 element vector holding floating point values of type double.
Definition: Vector.hpp:2937
The namespace of the Chemical Data Processing Library.