Chemical Data Processing Library C++ API - Version 1.4.0
MMFF94VanDerWaalsInteractionParameterizer.hpp
Go to the documentation of this file.
1 /*
2  * MMFF94VanDerWaalsInteractionParameterizer.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_FORCEFIELD_MMFF94VANDERWAALSINTERACTIONPARAMETERIZER_HPP
30 #define CDPL_FORCEFIELD_MMFF94VANDERWAALSINTERACTIONPARAMETERIZER_HPP
31 
32 #include <memory>
33 
40 
41 
42 namespace CDPL
43 {
44 
45  namespace Chem
46  {
47 
48  class MolecularGraph;
49  }
50 
51  namespace ForceField
52  {
53 
62  {
63 
64  public:
66  typedef std::shared_ptr<MMFF94VanDerWaalsInteractionParameterizer> SharedPointer;
67 
72 
82  bool strict);
83 
89 
95 
101 
107 
116  void parameterize(const Chem::MolecularGraph& molgraph, MMFF94VanDerWaalsInteractionList& ia_list, bool strict);
117 
118  private:
119  InteractionFilterFunction2 filterFunc;
123  };
124  } // namespace ForceField
125 } // namespace CDPL
126 
127 #endif // CDPL_FORCEFIELD_MMFF94VANDERWAALSINTERACTIONPARAMETERIZER_HPP
Definition of the preprocessor macro CDPL_FORCEFIELD_API.
#define CDPL_FORCEFIELD_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Type declaration of generic wrapper class types for storing user-defined interaction filtering predic...
Type declaration of generic wrapper classes for storing user-defined functions for the retrieval of M...
Declaration of type CDPL::ForceField::MMFF94VanDerWaalsInteractionList.
Definition of class CDPL::ForceField::MMFF94VanDerWaalsParameterTable.
Type definition of generic wrapper class for storing an user-defined topological atom-pair distance f...
Abstract base class for representations of a chemical structure as a graph of bonded atoms.
Definition: MolecularGraph.hpp:57
Detects and parameterizes the MMFF94 Van der Waals interactions of a molecular graph.
Definition: MMFF94VanDerWaalsInteractionParameterizer.hpp:62
void setVanDerWaalsParameterTable(const MMFF94VanDerWaalsParameterTable::SharedPointer &table)
Sets the table providing MMFF94 numeric atom type Van der Waals parameters and donor/acceptor classif...
void setFilterFunction(const InteractionFilterFunction2 &func)
Sets the filter function used to skip atom pairs during parameterization.
MMFF94VanDerWaalsInteractionParameterizer()
Constructs an MMFF94VanDerWaalsInteractionParameterizer instance using the default MMFF94 parameter t...
void parameterize(const Chem::MolecularGraph &molgraph, MMFF94VanDerWaalsInteractionList &ia_list, bool strict)
Perceives the MMFF94 Van der Waals interactions for molgraph and outputs the corresponding parameter ...
std::shared_ptr< MMFF94VanDerWaalsInteractionParameterizer > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated MMFF94VanDerWaalsInteractionParam...
Definition: MMFF94VanDerWaalsInteractionParameterizer.hpp:66
void setAtomTypeFunction(const MMFF94NumericAtomTypeFunction &func)
Sets the function used to look up the MMFF94 numeric atom type of an atom.
void setTopologicalDistanceFunction(const TopologicalAtomDistanceFunction &func)
Sets the function used to determine the topological distance between two atoms (number of bonds along...
MMFF94VanDerWaalsInteractionParameterizer(const Chem::MolecularGraph &molgraph, MMFF94VanDerWaalsInteractionList &ia_list, bool strict)
Constructs the parameterizer and processes the molecular graph molgraph.
std::shared_ptr< MMFF94VanDerWaalsParameterTable > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated MMFF94VanDerWaalsParameterTable i...
Definition: MMFF94VanDerWaalsParameterTable.hpp:68
std::function< unsigned int(const Chem::Atom &)> MMFF94NumericAtomTypeFunction
Generic wrapper class used to store a user-defined numeric MMFF94 atom type function.
Definition: MMFF94PropertyFunctions.hpp:56
std::function< std::size_t(const Chem::Atom &, const Chem::Atom &, const Chem::MolecularGraph &)> TopologicalAtomDistanceFunction
Generic wrapper class used to store a user-defined topological atom-pair distance function.
Definition: TopologicalAtomDistanceFunction.hpp:53
std::function< bool(const Chem::Atom &, const Chem::Atom &)> InteractionFilterFunction2
Generic wrapper for storing user-defined two-atom interaction filtering functions (see [FUNWRP]).
Definition: InteractionFilterFunctions.hpp:54
The namespace of the Chemical Data Processing Library.