CyclicSubstructure.hpp

Go to the documentation of this file.

/* 
 * CyclicSubstructure.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_CHEM_CYCLICSUBSTRUCTURE_HPP
#define CDPL_CHEM_CYCLICSUBSTRUCTURE_HPP
 
#include <vector>
#include <memory>
 
#include "CDPL/Chem/APIPrefix.hpp"
#include "CDPL/Chem/Fragment.hpp"
#include "CDPL/Util/BitSet.hpp"
 
 
namespace CDPL
{
 
    namespace Chem
    {
 
        class CDPL_CHEM_API CyclicSubstructure : public Fragment
        {
 
          public:
            typedef std::shared_ptr<CyclicSubstructure> SharedPointer;
 
            CyclicSubstructure() {}
 
            CyclicSubstructure(const MolecularGraph& molgraph);
 
            CyclicSubstructure(const CyclicSubstructure&) = delete;
 
            CyclicSubstructure& operator=(const CyclicSubstructure&) = delete;
 
            void perceive(const MolecularGraph& molgraph);
 
          private:
            typedef std::vector<const Atom*> AtomStack;
            typedef std::vector<const Bond*> BondStack;
 
            void init(const MolecularGraph&);
 
            void findRingAtomsAndBonds();
            void findRingAtomsAndBonds(const Atom* atom);
 
            Util::BitSet          visAtomMask;
            Util::BitSet          pathAtomMask;
            AtomStack             atomStack;
            BondStack             bondStack;
            const MolecularGraph* molGraph;
        };
    } // namespace Chem
} // namespace CDPL
 
#endif // CDPL_CHEM_CYCLICSUBSTRUCTURE_HPP