Chemical Data Processing Library C++ API - Version 1.4.0
DGStructureGenerator.hpp
Go to the documentation of this file.
1 /*
2  * DGStructureGenerator.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_DGSTRUCTUREGENERATOR_HPP
30 #define CDPL_CONFGEN_DGSTRUCTUREGENERATOR_HPP
31 
32 #include <cstddef>
33 
34 #include <boost/random/mersenne_twister.hpp>
35 
40 
41 
42 namespace CDPL
43 {
44 
45  namespace Chem
46  {
47 
48  class FragmentList;
49  }
50 
51  namespace ConfGen
52  {
53 
62  {
63 
64  public:
69 
75 
81 
87 
97  void setup(const Chem::MolecularGraph& molgraph);
98 
104  void setup(const Chem::MolecularGraph& molgraph, const ForceField::MMFF94InteractionData& ia_data);
105 
113  void setup(const Chem::MolecularGraph& molgraph, const Chem::FragmentList& fixed_substr_frags,
114  const Math::Vector3DArray& fixed_substr_coords);
115 
124  void setup(const Chem::MolecularGraph& molgraph, const ForceField::MMFF94InteractionData& ia_data,
125  const Chem::FragmentList& fixed_substr_frags, const Math::Vector3DArray& fixed_substr_coords);
126 
133 
140 
147 
152  std::size_t getNumAtomStereoCenters() const;
153 
158  std::size_t getNumBondStereoCenters() const;
159 
165 
166  private:
167  void setup(const Chem::MolecularGraph& molgraph, const ForceField::MMFF94InteractionData* ia_data,
168  const Chem::FragmentList* fixed_substr_frags, const Math::Vector3DArray* fixed_substr_coords);
169 
170  typedef boost::random::mt11213b RandNumEngine;
171 
172  const Chem::MolecularGraph* molGraph;
173  const Chem::FragmentList* fixedSubstructFrags;
174  const Math::Vector3DArray* fixedSubstructCoords;
175  Math::Vector3DArray fixedSubstructFragCtrs;
176  DGConstraintGenerator dgConstraintsGen;
177  Util::DG3DCoordinatesGenerator phase1CoordsGen;
178  Util::DG3DCoordinatesGenerator phase2CoordsGen;
179  RandNumEngine randomEngine;
181  };
182  } // namespace ConfGen
183 } // namespace CDPL
184 
185 #endif // CDPL_CONFGEN_DGSTRUCTUREGENERATOR_HPP
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 class CDPL::ConfGen::DGConstraintGenerator.
Implementation of a distance geometry based coordinates generator.
Definition of class CDPL::ConfGen::DGStructureGeneratorSettings.
Data type for the storage of Chem::Fragment objects.
Definition: FragmentList.hpp:49
Abstract base class for representations of a chemical structure as a graph of bonded atoms.
Definition: MolecularGraph.hpp:57
Constructs geometric constraints (distance, planarity, volume) for distance-geometry-based 3D structu...
Definition: DGConstraintGenerator.hpp:78
Bundle of configuration parameters for raw coordinates generation via class ConfGen::DGStructureGener...
Definition: DGStructureGeneratorSettings.hpp:46
Distance-geometry-based generation of raw 3D structures for molecular graphs.
Definition: DGStructureGenerator.hpp:62
std::size_t getNumBondStereoCenters() const
Returns the number of bond stereo centers in the set-up molecular graph.
std::size_t getNumAtomStereoCenters() const
Returns the number of atom stereo centers in the set-up molecular graph.
DGStructureGeneratorSettings & getSettings()
Returns the current generator settings (mutable).
bool checkAtomConfigurations(Math::Vector3DArray &coords) const
Validates the per-atom stereo-configurations of coords against the perceived stereo descriptors.
void setup(const Chem::MolecularGraph &molgraph)
Sets up the generator for molgraph using geometry defaults derived from each atom's element number an...
const DGConstraintGenerator & getConstraintGenerator() const
Returns the embedded constraint generator used to produce the distance/volume constraints.
void setup(const Chem::MolecularGraph &molgraph, const Chem::FragmentList &fixed_substr_frags, const Math::Vector3DArray &fixed_substr_coords)
Sets up the generator for molgraph while keeping the substructure fragments in fixed_substr_frags at ...
const Util::BitSet & getExcludedHydrogenMask() const
Returns the bit mask of hydrogens excluded from the coordinate-generation step.
void setup(const Chem::MolecularGraph &molgraph, const ForceField::MMFF94InteractionData &ia_data)
Sets up the generator for molgraph using the supplied MMFF94 interaction data.
bool checkBondConfigurations(Math::Vector3DArray &coords) const
Validates the per-bond stereo-configurations of coords against the perceived stereo descriptors.
bool generate(Math::Vector3DArray &coords)
Generates a 3D coordinate set that respects the configured distance constraints.
DGStructureGenerator()
Constructs the DGStructureGenerator instance.
const DGStructureGeneratorSettings & getSettings() const
Returns the current generator settings.
void setup(const Chem::MolecularGraph &molgraph, const ForceField::MMFF94InteractionData &ia_data, const Chem::FragmentList &fixed_substr_frags, const Math::Vector3DArray &fixed_substr_coords)
Sets up the generator for molgraph using the supplied MMFF94 interaction data and fixed-substructure ...
Container holding the full set of MMFF94 interaction parameters for a molecular graph.
Definition: MMFF94InteractionData.hpp:60
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
DGCoordinatesGenerator< 3, double > DG3DCoordinatesGenerator
Convenience alias for the 3D coordinates generator with double-precision values.
Definition: DGCoordinatesGenerator.hpp:544
The namespace of the Chemical Data Processing Library.