.. ################################################################
   # version0_9_6
   ################################################################

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEReadMatchedPairAnalyzer ReadMatchedPairAnalyzer deserialize

.. oe:function:: OEReadMatchedPairAnalyzer

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

      .. oe:api::

         bool OEReadMatchedPairAnalyzer(const std::string& fname,
                                        OEMatchedPairAnalyzer& mmpindex,
                                        bool enableMerge = false,
                                        bool regenHMemberKeys = false)
         bool OEReadMatchedPairAnalyzer(OEPlatform::oeistream& ifs,
                                        OEMatchedPairAnalyzer& mmpindex,
                                        bool enableMerge = false,
                                        bool regenHMemberKeys = false)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMatchedPairAnalyzer(fname: str, mmpindex: OEMatchedPairAnalyzer,
                                   enableMerge: bool = False,
                                   regenHKeys: bool = False) -> bool
         OEReadMatchedPairAnalyzer(ifs: oeistream,
                                   mmpindex: OEMatchedPairAnalyzer,
                                   enableMerge: bool = False,
                                   regenHKeys: bool = False) -> bool

   This function reads the serialized contents of a matched pair index and populates the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance
   as below.  An ``enableMerge`` argument of ``false`` is used to indicate that the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance should be cleared
   before the read, or ``true`` to indicate that the read index information should add (and update) existing data. If the ``regenHMemberKeys`` argument
   is ``true`` and the index includes extra H-member indexing information, the serialized H-member information will be ignored and regenerated during the read.

   .. oe:source:: SerializeIndex.cpp
      :language: c++
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-DESERIALIZE-INDEX

   .. oe:source:: SerializeIndex.py
      :language: python
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-DESERIALIZE-INDEX

   .. oe:source:: SerializeIndex.java
      :language: java
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-DESERIALIZE-INDEX

   .. oe:source:: SerializeIndex.cs
      :language: csharp
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-DESERIALIZE-INDEX

   .. seealso::

      * :oe:func:`OEMedChem::OEIsReadableMatchedPairAnalyzer`
      * :oe:func:`OEMedChem::OEWriteMatchedPairAnalyzer`


