Chemical Data Processing Library C++ API - Version 1.4.0
ConfGen/MolecularGraphFunctions.hpp
Go to the documentation of this file.
1 /*
2  * MolecularGraphFunctions.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_CONFGEN_MOLECULARGRAPHFUNCTIONS_HPP
30 #define CDPL_CONFGEN_MOLECULARGRAPHFUNCTIONS_HPP
31 
32 #include <cstddef>
33 
36 #include "CDPL/Util/BitSet.hpp"
37 
38 
39 namespace CDPL
40 {
41 
42  namespace Chem
43  {
44 
45  class MolecularGraph;
46  class Fragment;
47  class SubstructureSearch;
48  class CommonConnectedSubstructureSearch;
49  }
50 
51  namespace ForceField
52  {
53 
54  class MMFF94InteractionData;
55  class MMFF94InteractionParameterizer;
56  } // namespace ForceField
57 
58  namespace ConfGen
59  {
60 
68  CDPL_CONFGEN_API std::size_t createFragmentLinkBondMask(const Chem::MolecularGraph& molgraph, Util::BitSet& bond_mask, bool reset = true);
69 
79  bool het_h_rotors, bool reset = true);
80 
90  CDPL_CONFGEN_API std::size_t createRotatableBondMask(const Chem::MolecularGraph& molgraph, const Util::BitSet& excl_bond_mask,
91  Util::BitSet& bond_mask, bool het_h_rotors, bool reset = true);
92 
99  CDPL_CONFGEN_API std::size_t getRotatableBondCount(const Chem::MolecularGraph& molgraph, bool het_h_rotors);
100 
107 
122  ForceField::MMFF94InteractionData& param_data, unsigned int ff_type,
123  bool strict, double estat_de_const, double estat_dist_expo);
124 
131 
142  CDPL_CONFGEN_API std::size_t setupFixedSubstructureData(const Chem::SubstructureSearch& sub_search, std::size_t max_num_matches,
143  Chem::MolecularGraph& molgraph, Chem::Fragment& fixed_substr,
144  Math::Vector3DArray* fixed_substr_coords);
156  std::size_t max_num_matches, Chem::MolecularGraph& molgraph,
157  Chem::Fragment& fixed_substr, Math::Vector3DArray* fixed_substr_coords);
165 
174 
175  } // namespace ConfGen
176 } // namespace CDPL
177 
178 #endif // CDPL_CONFGEN_MOLECULARGRAPHFUNCTIONS_HPP
Declaration of type CDPL::Util::BitSet.
Definition of the preprocessor macro CDPL_CONFGEN_API.
#define CDPL_CONFGEN_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Definition of the type CDPL::ConfGen::ConformerDataArray.
Enumerates all maximal common connected substructures shared between a query and a target molecular g...
Definition: CommonConnectedSubstructureSearch.hpp:74
Concrete Chem::MolecularGraph implementation that stores references to a selectable subset of atoms a...
Definition: Fragment.hpp:57
Abstract base class for representations of a chemical structure as a graph of bonded atoms.
Definition: MolecularGraph.hpp:57
Subgraph-isomorphism search of a query molecular graph against a target molecular graph,...
Definition: SubstructureSearch.hpp:74
Container holding the full set of MMFF94 interaction parameters for a molecular graph.
Definition: MMFF94InteractionData.hpp:60
One-stop MMFF94 parameterizer that combines atom typing, bond typing, partial-charge assignment and p...
Definition: MMFF94InteractionParameterizer.hpp:100
CDPL_CONFGEN_API unsigned int parameterizeMMFF94Interactions(const Chem::MolecularGraph &molgraph, ForceField::MMFF94InteractionParameterizer &parameterizer, ForceField::MMFF94InteractionData &param_data, unsigned int ff_type, bool strict, double estat_de_const, double estat_dist_expo)
Parameterizes the MMFF94 interactions of molgraph via parameterizer and stores them in param_data.
CDPL_CONFGEN_API std::size_t createRotatableBondMask(const Chem::MolecularGraph &molgraph, Util::BitSet &bond_mask, bool het_h_rotors, bool reset=true)
Sets bits in bond_mask for every rotatable bond of molgraph (see ConfGen::isRotatableBond()).
CDPL_CONFGEN_API bool initFixedSubstructurePattern(Chem::MolecularGraph &molgraph, const Chem::MolecularGraph *tmplt)
Initializes molgraph as a fixed-substructure pattern matched against the supplied tmplt template.
std::vector< ConformerData::SharedPointer > ConformerDataArray
Dynamically-sized array of shared pointers to ConfGen::ConformerData objects.
Definition: ConformerDataArray.hpp:46
CDPL_CONFGEN_API void initFixedSubstructureTemplate(Chem::MolecularGraph &molgraph, bool init_match_expr)
Initializes molgraph as a fixed-substructure template (perception of atom/bond properties and optiona...
CDPL_CONFGEN_API unsigned int perceiveFragmentType(const Chem::MolecularGraph &molgraph)
Classifies molgraph as a ConfGen::FragmentType (chain, flexible ring, rigid ring, etc....
CDPL_CONFGEN_API std::size_t setupFixedSubstructureData(const Chem::SubstructureSearch &sub_search, std::size_t max_num_matches, Chem::MolecularGraph &molgraph, Chem::Fragment &fixed_substr, Math::Vector3DArray *fixed_substr_coords)
Configures the fixed-substructure handling of molgraph using the matches produced by sub_search.
CDPL_CONFGEN_API std::size_t createFragmentLinkBondMask(const Chem::MolecularGraph &molgraph, Util::BitSet &bond_mask, bool reset=true)
Sets bits in bond_mask for every fragment-link bond of molgraph (see ConfGen::isFragmentLinkBond()).
CDPL_CONFGEN_API std::size_t getRotatableBondCount(const Chem::MolecularGraph &molgraph, bool het_h_rotors)
Returns the number of rotatable bonds in molgraph (see ConfGen::isRotatableBond()).
CDPL_CONFGEN_API void setConformers(Chem::MolecularGraph &molgraph, const ConformerDataArray &conf_array)
Transfers the conformer ensemble stored in conf_array onto molgraph (sets the per-atom 3D coordinates...
VectorArray< Vector3D > Vector3DArray
Array storing vectors of type Math::Vector3D.
Definition: VectorArray.hpp:85
boost::dynamic_bitset BitSet
Dynamic bitset class.
Definition: BitSet.hpp:46
The namespace of the Chemical Data Processing Library.