Chemical Data Processing Library C++ API - Version 1.4.0
MolecularGraphComponentGroupingMatchExpression.hpp
Go to the documentation of this file.
1 /*
2  * MolecularGraphComponentGroupingMatchExpression.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_CHEM_MOLECULARGRAPHCOMPONENTGROUPINGMATCHEXPRESSION_HPP
30 #define CDPL_CHEM_MOLECULARGRAPHCOMPONENTGROUPINGMATCHEXPRESSION_HPP
31 
32 #include <vector>
33 #include <mutex>
34 #include <memory>
35 
36 #include "CDPL/Chem/APIPrefix.hpp"
39 
40 
41 namespace CDPL
42 {
43 
44  namespace Chem
45  {
46 
53  {
54 
55  public:
60  typedef std::shared_ptr<MolecularGraphComponentGroupingMatchExpression> SharedPointer;
61 
67 
73 
95  bool operator()(const MolecularGraph& query_molgraph, const MolecularGraph& target_molgraph,
96  const AtomBondMapping& mapping, const Base::Any& aux_data) const;
97 
103 
110 
111  private:
112  typedef std::vector<const Fragment*> ComponentList;
113 
114  FragmentList::SharedPointer compGrouping;
115  mutable ComponentList compList;
116  mutable std::mutex mutex;
117  };
118  } // namespace Chem
119 } // namespace CDPL
120 
121 #endif // CDPL_CHEM_MOLECULARGRAPHCOMPONENTGROUPINGMATCHEXPRESSION_HPP
Definition of the preprocessor macro CDPL_CHEM_API.
#define CDPL_CHEM_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Definition of class CDPL::Chem::FragmentList.
Definition of class CDPL::Chem::MatchExpression.
Safe, type checked container for arbitrary data of variable type.
Definition: Any.hpp:60
Data structure for the common storage of related atom to atom and bond to bond mappings.
Definition: AtomBondMapping.hpp:55
std::shared_ptr< FragmentList > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated FragmentList instances.
Definition: FragmentList.hpp:53
Generic boolean expression interface for the implementation of query/target object equivalence tests ...
Definition: MatchExpression.hpp:75
Chem::MatchExpression that constrains the substructure mapping by the query's component-level groupin...
Definition: MolecularGraphComponentGroupingMatchExpression.hpp:53
std::shared_ptr< MolecularGraphComponentGroupingMatchExpression > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated MolecularGraphComponentGroupingMa...
Definition: MolecularGraphComponentGroupingMatchExpression.hpp:60
bool operator()(const MolecularGraph &query_molgraph, const MolecularGraph &target_molgraph, const AtomBondMapping &mapping, const Base::Any &aux_data) const
Checks whether the provided query to target atom/bond mapping candidate statisfies the component-leve...
MolecularGraphComponentGroupingMatchExpression(const MolecularGraphComponentGroupingMatchExpression &rhs)
Copy-constructs the expression from rhs (the per-evaluation working storage is left in an unspecified...
MolecularGraphComponentGroupingMatchExpression & operator=(const MolecularGraphComponentGroupingMatchExpression &rhs)
Copy-assigns the component-level grouping constraints from rhs.
MolecularGraphComponentGroupingMatchExpression(const FragmentList::SharedPointer &comp_grouping)
Constructs a MolecularGraphComponentGroupingMatchExpression instance for the specified component-leve...
bool requiresAtomBondMapping() const
Returns true to indicate that the expression requires a query to target atom/bond mapping candidate f...
Abstract base class for representations of a chemical structure as a graph of bonded atoms.
Definition: MolecularGraph.hpp:57
The namespace of the Chemical Data Processing Library.