.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetMatchedMolecularPairs GetMatchedMolecularPairs

.. oe:function:: OEGetMatchedMolecularPairs

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEMedChem::OEMatchedPair> *
      OESystem::OEIterBase<OEMedChem::OEMatchedPair>* OEGetMatchedMolecularPairs(const OEMedChem::OEMatchedPairAnalyzer &mmpindex, unsigned int molID, const OEMedChem::OEMatchedPairTransformExtractOptions &extractOpts=OEMedChem::OEMatchedPairTransformExtractOptions())
         OESystem::OEIterBase<OEMedChem::OEMatchedPair> *
      OESystem::OEIterBase<OEMedChem::OEMatchedPair>* OEGetMatchedMolecularPairs(const OEMedChem::OEMatchedPairAnalyzer &mmpindex, const OEChem::OEMolBase &probe, const OEChem::OEAtomBondSet &probeAttachSites, const OEMedChem::OEMatchedPairTransformExtractOptions &extractOpts=OEMedChem::OEMatchedPairTransformExtractOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEGetMatchedMolecularPairs(mmpindex: OEMatchedPairAnalyzer,
                                    molID: int,
                                    extractOpts: OEMatchedPairTransformExtractOptions = OEMatchedPairTransformExtractOptions()) -> Iterable[OEMatchedPair]
         OEGetMatchedMolecularPairs(mmpindex: OEMatchedPairAnalyzer,
                                    probe: Union[OEGraphMol,OEMol,OEQMol],
                                    probeAttachSites: OEAtomBondSet,
                                    extractOpts: OEMatchedPairTransformExtractOptions = OEMatchedPairTransformExtractOptions()) -> Iterable[OEMatchedPair]

   The first function returns the matched pairs associated with a specific molecule ID in the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` index.

   The second overloaded function returns matched molecular pairs related to changes at specific substitution point(s) on the provided probe structure.
   Additionally, any \*atoms (atomic number 0) on the probe structure can be used to indicate the site(s) that are open valences and which can be arbitrarily substituted.

   .. seealso::

      * :oe:func:`OEMedChem::OEMatchedPairGetTransforms` function
      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
      * :ref:`OEMatchedPairTransformExtractOptions <OEMedChem_OEMatchedPairTransformExtractOptions>` class
      * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` class
