BurdenMatrixGenerator.hpp

Go to the documentation of this file.

/* 
 * BurdenMatrixGenerator.hpp 
 *
 * This file is part of the Chemical Data Processing Toolkit
 *
 * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
 
#ifndef CDPL_DESCR_BURDENMATRIXGENERATOR_HPP
#define CDPL_DESCR_BURDENMATRIXGENERATOR_HPP
 
#include <functional>
 
#include "CDPL/Descr/APIPrefix.hpp"
#include "CDPL/Math/Matrix.hpp"
 
 
namespace CDPL
{
 
    namespace Chem
    {
 
        class MolecularGraph;
        class Atom;
    } // namespace Chem
 
    namespace Descr
    {
 
        class CDPL_DESCR_API BurdenMatrixGenerator
        {
 
          public:
            typedef std::function<double(const Chem::Atom&)> AtomWeightFunction;
 
            BurdenMatrixGenerator();
 
            BurdenMatrixGenerator(const Chem::MolecularGraph& molgraph, Math::DMatrix& mtx);
 
            BurdenMatrixGenerator(const BurdenMatrixGenerator&) = delete;
 
            BurdenMatrixGenerator& operator=(const BurdenMatrixGenerator&) = delete;
 
            void setAtomWeightFunction(const AtomWeightFunction& func);
 
            void generate(const Chem::MolecularGraph& molgraph, Math::DMatrix& mtx);
 
          private:
            AtomWeightFunction atomWeightFunc;
        };
    } // namespace Descr
} // namespace CDPL
 
#endif // CDPL_DESCR_BURDENMATRIXGENERATOR_HPP