Chemical Data Processing Library C++ API - Version 1.2.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 
49  {
50 
51  public:
61 
66 
68 
79 
81 
89 
102  void calculate(const Chem::MolecularGraph& molgraph, Math::DVector& descr);
103 
104  private:
105  BurdenMatrixGenerator burdenMatrixGenerator;
106  Math::DVector bcutDescriptor;
107  Math::DMatrix tmpBurdenMatrix;
108  Math::DMatrix eigenVectors;
109  };
110  } // namespace Descr
111 } // namespace CDPL
112 
113 #endif // CDPL_DESCR_BCUTDESCRIPTORCALCULATOR_HPP
Definition of the 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.
MolecularGraph.
Definition: MolecularGraph.hpp:52
BCUTDescriptorCalculator.
Definition: BCUTDescriptorCalculator.hpp:49
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:65
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:60
void calculate(const Chem::MolecularGraph &molgraph, Math::DVector &descr)
Calculates the BCUT descriptor of the molecular graph molgraph.
BurdenMatrixGenerator.
Definition: BurdenMatrixGenerator.hpp:56
std::function< double(const Chem::Atom &)> AtomWeightFunction
Type of the generic functor class used to store user-defined atom weight functions.
Definition: BurdenMatrixGenerator.hpp:66
The namespace of the Chemical Data Processing Library.