Chemical Data Processing Library C++ API - Version 1.4.0
BCUTDescriptorCalculator.hpp
Go to the documentation of this file.
1 /*
2  * BCUTDescriptorCalculator.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_DESCR_BCUTDESCRIPTORCALCULATOR_HPP
30 #define CDPL_DESCR_BCUTDESCRIPTORCALCULATOR_HPP
31 
32 #include "CDPL/Descr/APIPrefix.hpp"
34 #include "CDPL/Math/Vector.hpp"
35 #include "CDPL/Math/Matrix.hpp"
36 
37 
38 namespace CDPL
39 {
40 
41  namespace Descr
42  {
43 
55  {
56 
57  public:
67 
72 
74 
85 
87 
95 
108  void calculate(const Chem::MolecularGraph& molgraph, Math::DVector& descr);
109 
110  private:
111  BurdenMatrixGenerator burdenMatrixGenerator;
112  Math::DVector bcutDescriptor;
113  Math::DMatrix tmpBurdenMatrix;
114  Math::DMatrix eigenVectors;
115  };
116  } // namespace Descr
117 } // namespace CDPL
118 
119 #endif // CDPL_DESCR_BCUTDESCRIPTORCALCULATOR_HPP
Definition of class CDPL::Descr::BurdenMatrixGenerator.
Definition of the preprocessor macro CDPL_DESCR_API.
#define CDPL_DESCR_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Definition of matrix data types.
Definition of vector data types.
Abstract base class for data structures that represent chemical structures as molecular graphs.
Definition: MolecularGraph.hpp:60
Calculation of the BCUT (Burden-CAS-University-of-Texas) descriptor of a molecular graph.
Definition: BCUTDescriptorCalculator.hpp:55
BCUTDescriptorCalculator & operator=(const BCUTDescriptorCalculator &)=delete
BCUTDescriptorCalculator(const Chem::MolecularGraph &molgraph, Math::DVector &descr)
Constructs the BCUTDescriptorCalculator instance and calculates the BCUT descriptor of the molecular ...
void setAtomWeightFunction(const AtomWeightFunction &func)
Allows to specify a custom atom weight function for the initialization of the underlying Burden matri...
BCUTDescriptorCalculator()
Constructs the BCUTDescriptorCalculator instance.
Definition: BCUTDescriptorCalculator.hpp:71
BCUTDescriptorCalculator(const BCUTDescriptorCalculator &)=delete
BurdenMatrixGenerator::AtomWeightFunction AtomWeightFunction
Type of the generic functor class used to store user-defined atom weight functions for the initializa...
Definition: BCUTDescriptorCalculator.hpp:66
void calculate(const Chem::MolecularGraph &molgraph, Math::DVector &descr)
Calculates the BCUT descriptor of the molecular graph molgraph.
Calculation of the Burden matrix of a molecular graph.
Definition: BurdenMatrixGenerator.hpp:63
std::function< double(const Chem::Atom &)> AtomWeightFunction
Type of the generic functor class used to store user-defined atom weight functions.
Definition: BurdenMatrixGenerator.hpp:73
The namespace of the Chemical Data Processing Library.