.. oe:namespace:: OEMedChem



.. meta::
   :keywords: OEMatchedPairAnalyzer, MatchedPairAnalyzer


.. _OEMedChem_OEMatchedPairAnalyzer:

.. oe:class:: OEMatchedPairAnalyzer

   .. oe:api::

      class OEMatchedPairAnalyzer

   Performs a matched pair indexing analysis on an input set of structures.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMatchedPairAnalyzer(const OEMatchedPairAnalyzerOptions& opts = OEMatchedPairAnalyzerOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairAnalyzer(opts: OEMatchedPairAnalyzerOptions = OEMatchedPairAnalyzerOptions()) -> OEMatchedPairAnalyzer

      Default constructor that initializes the analysis engine with the default options defined by
      :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>`.

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

         .. oe:api::

            OEMatchedPairAnalyzer(const OEMatchedPairAnalyzerOptions& opts = OEMatchedPairAnalyzerOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairAnalyzer(opts: OEMatchedPairAnalyzerOptions = OEMatchedPairAnalyzerOptions()) -> OEMatchedPairAnalyzer

      Constructor that initializes the analysis engine with the options defined by
      the :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` argument.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMatchedPairAnalyzer & operator=(const OEMatchedPairAnalyzer & rhs)

      Assignment operator.


   .. oe:method:: AddMol

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

         .. oe:api::

            int AddMol(const OEChem::OEMolBase& inmol, int recordID = (-1))

      .. oe:language:: python

         .. oe:api:: python

            AddMol(inmol: Union[OEGraphMol,OEMol,OEQMol], recID: int = -1) -> int

      Add the molecule to the index and return the 0-based recordID
      if the structure was successfully added, or a negative index if the structure
      was unable to be indexed. Negative values can be used to retrieve
      status information detail for indexing failures. The optional user-defined
      recordID is provided to allow indexed matched pairs to be referenced
      to externally maintained data structures.  If the provided recordID is
      less than zero, an autogenerated index is returned which is
      an index greater than all ids seen so far.

   .. seealso::

      * :oe:constns:`OEMedChem::OEMatchedPairIndexStatus`
      * :oe:func:`OEMedChem::OEMatchedPairIndexStatusName`

   .. oe:method:: GetMaxMolIdx

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

         .. oe:api::

            unsigned int GetMaxMolIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMolIdx() -> int

      Returns one more than the maximum molecule index this Matched Pair index
      currently contains.

   .. oe:method:: GetMolecule

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

         .. oe:api::

            bool GetMolecule(OEChem::OEMolBase& mol, unsigned int molID,
                             bool includeData = true) const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule(mol: Union[OEGraphMol,OEMol,OEQMol], recID: int,
                        includeData: bool = True) -> bool

      Returns the molecule referenced by ``molID`` in the index.  An optional `includeData` argument controls whether
      generic data present on the molecule at index time is also returned.

   .. oe:method:: GetOptions

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

         .. oe:api::

            const OEMatchedPairAnalyzerOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEMatchedPairAnalyzerOptions

   .. seealso::

      * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class

   .. oe:method:: GetProcessorID

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

         .. oe:api::

            const char* GetProcessorID() const

      .. oe:language:: python

         .. oe:api:: python

            GetProcessorID() -> str

      Returns a character string name of the processor type.

   .. seealso::

      * :oe:func:`OEMedChem::OEMatchedPairProcessorName` class

   .. oe:method:: GetProcessorType

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

         .. oe:api::

            unsigned int GetProcessorType() const

      .. oe:language:: python

         .. oe:api:: python

            GetProcessorType() -> int

      Returns a constant representing the processor type in use.

   .. seealso::

      * :oe:constns:`OEMedChem::OEMatchedPairProcessor`

   .. oe:method:: IsIndexed

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

         .. oe:api::

            bool IsIndexed(unsigned int recordID) const

      .. oe:language:: python

         .. oe:api:: python

            IsIndexed(recID: int) -> bool

      Returns whether the specified record id has been indexed.

   .. oe:method:: NumIndexNodes

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

         .. oe:api::

            unsigned int NumIndexNodes() const

      .. oe:language:: python

         .. oe:api:: python

            NumIndexNodes() -> int

      Return a count of the number of index nodes
      currently present in the index.

   .. oe:method:: NumMatchedPairs

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

         .. oe:api::

            unsigned int NumMatchedPairs() const

      .. oe:language:: python

         .. oe:api:: python

            NumMatchedPairs() -> int

      Return a count of the number of matched molecular pairs
      currently present in the index.

   .. oe:method:: NumMols

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

         .. oe:api::

            unsigned int NumMols() const

      .. oe:language:: python

         .. oe:api:: python

            NumMols() -> int

      Return a count of the number of molecules that have currently
      been added to the index.

   .. oe:method:: ModifyOptions

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

         .. oe:api::

            bool ModifyOptions(unsigned int addopts, unsigned int delopts)

      .. oe:language:: python

         .. oe:api:: python

            ModifyOptions(addopts: int, delopts: int) -> bool

      An active analyzer has a limited set of options that can be
      altered once it has been instantiated as many of the options
      affect the internal indexing contents.  This method can be used
      to alter any options that do not affect the internal index state.

   .. seealso::

      * :oe:constns:`OEMedChem::OEMatchedPairOptions`
