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

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEReadMMPIndexMolecules ReadMMPIndexMolecules

.. oe:function:: OEReadMMPIndexMolecules

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

      .. oe:api::

         bool OEReadMMPIndexMolecules(OEPlatform::oeistream& ifs,
                                      OEMatchedPairAnalyzer& mmpindex,
                                      bool regenHKeys = false)
         bool OEReadMMPIndexMolecules(const std::string& fragbytes,
                                      OEMatchedPairAnalyzer& mmpindex,
                                      bool regenHKeys = false)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMMPIndexMolecules(ifs: oeistream,
                                 mmpindex: OEMatchedPairAnalyzer,
                                 regenHKeys: bool = False) -> bool
         OEReadMMPIndexMolecules(fragbytes: str,
                                 mmpindex: OEMatchedPairAnalyzer,
                                 regenHKeys: bool = False) -> bool

   This function deserializes Matched Pair fragmentation information from the passed string or :ref:`oeistream <OEPlatform_oeistream>` and adds the information to the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` provided.

   The goal of this function is to stream the precomputed fragmentation information directly into the Matched Molecular Pair index with maximum efficiency.

   .. seealso::

      * :oe:func:`OEMedChem::OEWriteMMPIndexMolecules`
