Chemical Data Processing Library C++ API - Version 1.4.0
OrthogonalPiPiInteractionScore.hpp
Go to the documentation of this file.
1 /*
2  * OrthogonalPiPiInteractionScore.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_ORTHOGONALPIPIINTERACTIONSCORE_HPP
30 #define CDPL_PHARM_ORTHOGONALPIPIINTERACTIONSCORE_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:
56  static constexpr double DEF_MAX_V_DISTANCE = 1.4;
57 
61  static constexpr double DEF_MIN_H_DISTANCE = 4.0;
62 
66  static constexpr double DEF_MAX_H_DISTANCE = 6.0;
67 
71  static constexpr double DEF_MAX_ANGLE = 20.0;
72 
76  typedef std::shared_ptr<OrthogonalPiPiInteractionScore> SharedPointer;
77 
81  typedef std::function<double(double)> DistanceScoringFunction;
82 
86  typedef std::function<double(double)> AngleScoringFunction;
87 
95  OrthogonalPiPiInteractionScore(double min_h_dist = DEF_MIN_H_DISTANCE, double max_h_dist = DEF_MAX_H_DISTANCE,
96  double max_v_dist = DEF_MAX_V_DISTANCE, double max_ang = DEF_MAX_ANGLE);
97 
102  double getMinHDistance() const;
103 
108  double getMaxHDistance() const;
109 
114  double getMaxVDistance() const;
115 
120  double getMaxAngle() const;
121 
127 
133 
140  double operator()(const Feature& ftr1, const Feature& ftr2) const;
141 
148  double operator()(const Math::Vector3D& ftr1_pos, const Feature& ftr2) const;
149 
150  private:
151  double calcDistanceScore(const Math::Vector3D&, const Math::Vector3D&) const;
152 
153  double minHDist;
154  double maxHDist;
155  double maxVDist;
156  double maxAngle;
157  DistanceScoringFunction distScoringFunc;
158  AngleScoringFunction angleScoringFunc;
159  };
160  } // namespace Pharm
161 } // namespace CDPL
162 
163 #endif // CDPL_PHARM_ORTHOGONALPIPIINTERACTIONSCORE_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 an aromatic feature pair for an orthogonal ...
Definition: OrthogonalPiPiInteractionScore.hpp:50
double operator()(const Feature &ftr1, const Feature &ftr2) const
Evaluates the orthogonal π-π interaction score between features ftr1 and ftr2.
double getMinHDistance() const
Returns the currently configured minimum horizontal ring-center separation.
double getMaxAngle() const
Returns the currently configured maximum deviation from a 90° angle between the two ring-plane normal...
std::function< double(double)> AngleScoringFunction
Type of the function mapping a ring-plane angle to its score contribution.
Definition: OrthogonalPiPiInteractionScore.hpp:86
OrthogonalPiPiInteractionScore(double min_h_dist=DEF_MIN_H_DISTANCE, double max_h_dist=DEF_MAX_H_DISTANCE, double max_v_dist=DEF_MAX_V_DISTANCE, double max_ang=DEF_MAX_ANGLE)
Constructs a OrthogonalPiPiInteractionScore functor with the specified constraints.
double getMaxHDistance() const
Returns the currently configured maximum horizontal ring-center separation.
std::function< double(double)> DistanceScoringFunction
Type of the function mapping a feature-pair distance to its score contribution.
Definition: OrthogonalPiPiInteractionScore.hpp:81
std::shared_ptr< OrthogonalPiPiInteractionScore > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated OrthogonalPiPiInteractionScore in...
Definition: OrthogonalPiPiInteractionScore.hpp:76
void setAngleScoringFunction(const AngleScoringFunction &func)
Specifies the function that maps the ring-plane-normal angle to its score contribution.
void setDistanceScoringFunction(const DistanceScoringFunction &func)
Specifies the function that maps a feature-pair distance to its score contribution.
double operator()(const Math::Vector3D &ftr1_pos, const Feature &ftr2) const
Evaluates the orthogonal π-π interaction score with the first feature represented only by its 3D posi...
double getMaxVDistance() const
Returns the currently configured maximum vertical ring-center separation.
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.