Chemical Data Processing Library C++ API - Version 1.4.0
CationPiInteractionScore.hpp
Go to the documentation of this file.
1 /*
2  * CationPiInteractionScore.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_CATIONPIINTERACTIONSCORE_HPP
30 #define CDPL_PHARM_CATIONPIINTERACTIONSCORE_HPP
31 
32 #include <functional>
33 
34 #include "CDPL/Pharm/APIPrefix.hpp"
36 
37 
38 namespace CDPL
39 {
40 
41  namespace Pharm
42  {
43 
49  {
50 
51  public:
53  static constexpr double DEF_MIN_DISTANCE = 3.5;
55  static constexpr double DEF_MAX_DISTANCE = 5.5;
57  static constexpr double DEF_MAX_ANGLE = 30.0;
58 
62  typedef std::shared_ptr<CationPiInteractionScore> SharedPointer;
63 
65  typedef std::function<double(double)> DistanceScoringFunction;
67  typedef std::function<double(double)> AngleScoringFunction;
68 
77  CationPiInteractionScore(bool aro_cat, double min_dist = DEF_MIN_DISTANCE, double max_dist = DEF_MAX_DISTANCE,
78  double max_ang = DEF_MAX_ANGLE);
79 
84  double getMinDistance() const;
85 
90  double getMaxDistance() const;
91 
96  double getMaxAngle() const;
97 
103 
109 
116  double operator()(const Feature& ftr1, const Feature& ftr2) const;
117 
124  double operator()(const Math::Vector3D& ftr1_pos, const Feature& ftr2) const;
125 
126  private:
127  bool aroCatOrder;
128  double minDist;
129  double maxDist;
130  double maxAngle;
131  DistanceScoringFunction distScoringFunc;
132  AngleScoringFunction angleScoringFunc;
133  };
134  } // namespace Pharm
135 } // namespace CDPL
136 
137 #endif // CDPL_PHARM_CATIONPIINTERACTIONSCORE_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.
Pharm::FeatureInteractionScore implementation that scores an aromatic/cationic feature pair by combin...
Definition: CationPiInteractionScore.hpp:49
double operator()(const Feature &ftr1, const Feature &ftr2) const
Evaluates the cation-π interaction score between features ftr1 and ftr2.
CationPiInteractionScore(bool aro_cat, double min_dist=DEF_MIN_DISTANCE, double max_dist=DEF_MAX_DISTANCE, double max_ang=DEF_MAX_ANGLE)
Constructs a CationPiInteractionScore functor with the specified constraints.
std::function< double(double)> AngleScoringFunction
Type of the function mapping a cation-displacement angle to its score contribution.
Definition: CationPiInteractionScore.hpp:67
double getMaxAngle() const
Returns the currently configured maximum angle between cation displacement and aromatic-plane normal.
void setAngleScoringFunction(const AngleScoringFunction &func)
Specifies the function that maps the cation-displacement angle to its score contribution.
double getMaxDistance() const
Returns the currently configured maximum cation-aromatic distance.
std::function< double(double)> DistanceScoringFunction
Type of the function mapping a cation-aromatic distance to its score contribution.
Definition: CationPiInteractionScore.hpp:65
std::shared_ptr< CationPiInteractionScore > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated CationPiInteractionScore instance...
Definition: CationPiInteractionScore.hpp:62
double operator()(const Math::Vector3D &ftr1_pos, const Feature &ftr2) const
Evaluates the cation-π interaction score with the first feature represented only by its 3D position f...
double getMinDistance() const
Returns the currently configured minimum cation-aromatic distance.
void setDistanceScoringFunction(const DistanceScoringFunction &func)
Specifies the function that maps the cation-aromatic distance to its score contribution.
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
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.