Chemical Data Processing Library C++ API - Version 1.4.0
OrthogonalPiPiInteractionConstraint.hpp
Go to the documentation of this file.
1 /*
2  * OrthogonalPiPiInteractionConstraint.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_ORTHOGONALPIPIINTERACTIONCONSTRAINT_HPP
30 #define CDPL_PHARM_ORTHOGONALPIPIINTERACTIONCONSTRAINT_HPP
31 
32 #include "CDPL/Pharm/APIPrefix.hpp"
33 #include "CDPL/Math/Vector.hpp"
34 
35 
36 namespace CDPL
37 {
38 
39  namespace Pharm
40  {
41 
42  class Feature;
43 
49  {
50 
51  public:
53  static constexpr double DEF_MAX_V_DISTANCE = 1.4;
55  static constexpr double DEF_MIN_H_DISTANCE = 4.0;
57  static constexpr double DEF_MAX_H_DISTANCE = 6.0;
59  static constexpr double DEF_MAX_ANGLE = 30.0;
60 
68  OrthogonalPiPiInteractionConstraint(double min_h_dist = DEF_MIN_H_DISTANCE, double max_h_dist = DEF_MAX_H_DISTANCE,
69  double max_v_dist = DEF_MAX_V_DISTANCE, double max_ang = DEF_MAX_ANGLE):
70  minHDist(min_h_dist),
71  maxHDist(max_h_dist), maxVDist(max_v_dist), maxAngle(max_ang) {}
72 
77  double getMinHDistance() const;
78 
83  double getMaxHDistance() const;
84 
89  double getMaxVDistance() const;
90 
95  double getMaxAngle() const;
96 
103  bool operator()(const Feature& ftr1, const Feature& ftr2) const;
104 
105  private:
106  bool checkDistances(const Math::Vector3D&, const Math::Vector3D&) const;
107 
108  double minHDist;
109  double maxHDist;
110  double maxVDist;
111  double maxAngle;
112  };
113  } // namespace Pharm
114 } // namespace CDPL
115 
116 #endif // CDPL_PHARM_ORTHOGONALPIPIINTERACTIONCONSTRAINT_HPP
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.
Definition of vector data types.
Abstract base class representing a single pharmacophore feature within a parent Pharm::Pharmacophore.
Definition: Feature.hpp:48
Constraint functor that tests whether an aromatic feature pair satisfies the geometric criteria for a...
Definition: OrthogonalPiPiInteractionConstraint.hpp:49
OrthogonalPiPiInteractionConstraint(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 OrthogonalPiPiInteractionConstraint functor with the specified constraints.
Definition: OrthogonalPiPiInteractionConstraint.hpp:68
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...
double getMaxHDistance() const
Returns the currently configured maximum horizontal ring-center separation.
double getMaxVDistance() const
Returns the currently configured maximum vertical ring-center separation.
bool operator()(const Feature &ftr1, const Feature &ftr2) const
Tests whether ftr1 and ftr2 satisfy the geometric orthogonal π-π criteria.
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.