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

.. role:: raw-html(raw)
   :format: html

.. oe:namespace:: OEMedChem


.. meta::
   :keywords: OECreateMMPIndexOptions, CreateMMPIndexOptions


.. _OEMedChem_OECreateMMPIndexOptions:

.. oe:class:: OECreateMMPIndexOptions

   .. oe:api::

      class OECreateMMPIndexOptions

   Encapsulates the properties that control a matched pair indexing analysis.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
      * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OECreateMMPIndexOptions()
            OECreateMMPIndexOptions(const OEMatchedPairAnalyzerOptions& mmpopts)

      .. oe:language:: python

         .. oe:api:: python

            OECreateMMPIndexOptions(mmpopts: OEMatchedPairAnalyzerOptions) -> OECreateMMPIndexOptions

      Constructors that initialize an :ref:`OECreateMMPIndexOptions <OEMedChem_OECreateMMPIndexOptions>`
      object.  The default constructor provides the following properties:

      .. list-table::  **Default parameters of OEMatchedPairAnalyzerOptions**
         :widths: 50 50
         :header-rows: 1

         * - Property
           - Default value

         * - processor type
           - :oe:const:`OEMedChem::OEMatchedPairProcessor::Default`

         * - options
           - :oe:const:`OEMedChem::OEMatchedPairOptions::Default`

         * - bond fragmentation limit
           - 20

         * - heavy atom filter
           - 100

         * - indexable fragment filter based on :raw-html:`<br />`
             min,max heavy atom percentage of the :raw-html:`<br />`
             input structure
           - 85-100%


   .. ################################################################
      # GetMaxRecord
      ################################################################

   .. oe:method:: GetMaxRecord

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

         .. oe:api::

            unsigned int GetMaxRecord() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxRecord() -> int

      Return the maximum number of records to index from the input structure file or
      ``0`` to indicate all structures should be indexed.

   .. ################################################################
      # GetMMPOptions
      ################################################################

   .. oe:method:: GetMMPOptions

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

         .. oe:api::

            const OEMatchedPairAnalyzerOptions& GetMMPOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMPOptions() -> OEMatchedPairAnalyzerOptions

      Returns the options controlling the Matched Pair indexing information.

   .. ################################################################
      # GetNumThreads
      ################################################################

   .. oe:method:: GetNumThreads

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

         .. oe:api::

            unsigned int GetNumThreads() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumThreads() -> int

      Returns the number of threads to use during the indexing phase.
      If the number of threads specified is ``0``, :oe:func:`OEPlatform::OEGetNumProcessors`
      will be used to interrogate the maximum threads allowed.

   .. ################################################################
      # GetTracer
      ################################################################

   .. oe:method: GetTracer DO NOT DOCUMENT

      .. oe:api::

         const OESystem::OEDots *GetTracer() const

   .. ################################################################
      # GetVerbose
      ################################################################

   .. oe:method:: GetVerbose

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

         .. oe:api::

            unsigned int GetVerbose() const

      .. oe:language:: python

         .. oe:api:: python

            GetVerbose() -> int

      Return the level of output verbosity during the indexing activity.


   .. ################################################################
      # SetMaxRecord
      ################################################################

   .. oe:method:: SetMaxRecord

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

         .. oe:api::

            void SetMaxRecord(unsigned int maxrec)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxRecord(maxrec: int) -> None

      Sets the maximum number of records to index from the input structure file.
      ``0`` indicates all structures should be indexed.

   .. ################################################################
      # SetNumThreads
      ################################################################

   .. oe:method:: SetNumThreads

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

         .. oe:api::

            void SetNumThreads(unsigned int nthreads)

      .. oe:language:: python

         .. oe:api:: python

            SetNumThreads(nthreads: int) -> None

      Sets the maximum number of threads to use during the indexing phase.
      If ``nthreads`` is set to ``0``, :oe:func:`OEPlatform::OEGetNumProcessors`
      will be used to interrogate the maximum threads allowed.

   .. ################################################################
      # SetTracer
      ################################################################

   .. oe:method:: SetTracer

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

         .. oe:api::

            void SetTracer(const OESystem::OEDots& dots)

      .. oe:language:: python

         .. oe:api:: python

            SetTracer(dots: OEDots) -> None

      Sets a tracer that can be used to show the progress of indexing.

      .. seealso::

         * :ref:`OEDots <OESystem_OEDots>` class in the **OEChem TK** manual

   .. ################################################################
      # SetVerbose
      ################################################################

   .. oe:method:: SetVerbose

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

         .. oe:api::

            void SetVerbose(unsigned int verbose)

      .. oe:language:: python

         .. oe:api:: python

            SetVerbose(verbose: int) -> None

      Sets the level of output verbosity during the indexing activity.
      ``0 (off)``, ``1 (verbose)``, or ``2 (very verbose)`` are sufficient values for output verbosity.
