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

.. oe:namespace:: OEMedChem


.. meta::
   :keywords: OEMatchedPairAnalyzerOptions, MatchedPairAnalyzerOptions


.. _OEMedChem_OEMatchedPairAnalyzerOptions:

.. oe:class:: OEMatchedPairAnalyzerOptions

   .. oe:api::

      class OEMatchedPairAnalyzerOptions

   Encapsulates the properties that control a matched pair analysis.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMatchedPairAnalyzerOptions(unsigned int processorType = OEMatchedPairProcessor::Default)
            OEMatchedPairAnalyzerOptions(const OEMatchedPairAnalyzerOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairAnalyzerOptions(processorType: int) -> OEMatchedPairAnalyzerOptions

      Default constructor that initializes an :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>`
      object with 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%

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

         .. oe:api::

            OEMatchedPairAnalyzerOptions(const OEMatchedPairAnalyzerOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairAnalyzerOptions(rhs: OEMatchedPairAnalyzerOptions) -> OEMatchedPairAnalyzerOptions

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

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

      .. oe:api::

         OEMatchedPairAnalyzerOptions &operator=(const OEMatchedPairAnalyzerOptions &rhs)

      Assignment operator.

   .. ################################################################
      # ClearIndexableFragmentRange
      ################################################################

   .. oe:method:: ClearIndexableFragmentRange

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

         .. oe:api::

            void ClearIndexableFragmentRange()

      .. oe:language:: python

         .. oe:api:: python

            ClearIndexableFragmentRange() -> None

      Clears the min-max range, which removes the fragment range filter
      and results in indexing fragments of all sizes.

   .. ################################################################
      # GetFragmentationLimit
      ################################################################

   .. oe:method:: GetFragmentationLimit

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

         .. oe:api::

            unsigned int GetFragmentationLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragmentationLimit() -> int

      Return the bond fragmentation limit value.

   .. ################################################################
      # GetIndexableFragmentRangeMax
      ################################################################

   .. oe:method:: GetIndexableFragmentRangeMax

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

         .. oe:api::

            float GetIndexableFragmentRangeMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetIndexableFragmentRangeMax() -> float

      Return the maximum range of the indexable fragment filter.

   .. ################################################################
      # GetIndexableFragmentRangeMin
      ################################################################

   .. oe:method:: GetIndexableFragmentRangeMin

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

         .. oe:api::

            float GetIndexableFragmentRangeMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetIndexableFragmentRangeMin() -> float

      Return the minimum range of the indexable fragment filter.

   .. ################################################################
      # GetMaxAtomFilter
      ################################################################

   .. oe:method:: GetMaxAtomFilter

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

         .. oe:api::

            unsigned int GetMaxAtomFilter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAtomFilter() -> int

      Return the maximum heavy atom filter value.  Input structures
      with more than this number of heavy atoms will be rejected.

   .. ################################################################
      # GetOptions
      ################################################################

   .. oe:method:: GetOptions

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

         .. oe:api::

            unsigned int GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> int

      Return the options setting value.  The default is
      :oe:const:`OEMedChem::OEMatchedPairOptions::Default`.

   .. ################################################################
      # GetProcessorType
      ################################################################

   .. oe:method:: GetProcessorType

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

         .. oe:api::

            unsigned int GetProcessorType() const

      .. oe:language:: python

         .. oe:api:: python

            GetProcessorType() -> int

      Return the processor type.  The type using the
      default constructor is
      :oe:const:`OEMedChem::OEMatchedPairProcessor::Default`

   .. ################################################################
      # HasIndexableFragmentHeavyAtomRange
      ################################################################

   .. oe:method:: HasIndexableFragmentHeavyAtomRange

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

         .. oe:api::

            bool HasIndexableFragmentHeavyAtomRange() const

      .. oe:language:: python

         .. oe:api:: python

            HasIndexableFragmentHeavyAtomRange() -> bool

      Returns whether a min-max range has been specified.

   .. ################################################################
      # ModifyOptions
      ################################################################

   .. 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.

   .. ################################################################
      # SetFragmentationLimit
      ################################################################

   .. oe:method:: SetFragmentationLimit

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

         .. oe:api::

            bool SetFragmentationLimit(unsigned int limit)

      .. oe:language:: python

         .. oe:api:: python

            SetFragmentationLimit(limit: int) -> bool

      Set the bond fragmentation limit. Any structures that generate
      more fragmentation bonds than this limit are rejected.

   .. ################################################################
      # SetIndexableFragmentRange
      ################################################################

   .. oe:method:: SetIndexableFragmentRange

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

         .. oe:api::

            bool SetIndexableFragmentRange(float minHeavyAtomPercent,
                                           float maxHeavyAtomPercent)

      .. oe:language:: python

         .. oe:api:: python

            SetIndexableFragmentRange(minHeavyAtomPercent: float,
                                      maxHeavyAtomPercent: float) -> bool

      Sets the min-max heavy atom percentage range to request which
      fragment sizes should be indexed.  The default is 85-100% of the
      input structures.

   .. ################################################################
      # SetMaxAtomFilter
      ################################################################

   .. oe:method:: SetMaxAtomFilter

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

         .. oe:api::

            bool SetMaxAtomFilter(unsigned int numAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxAtomFilter(numAtoms: int) -> bool

      Sets the maximum heavy atom filter value.  Input structures with
      more than this number of heavy atoms will be rejected for
      indexing.

   .. ################################################################
      # SetOptions
      ################################################################

   .. oe:method:: SetOptions

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

         .. oe:api::

            bool SetOptions(unsigned int opts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(opts: int) -> bool

      Set the options value.  The default is
      :oe:const:`OEMedChem::OEMatchedPairOptions::Default`.

   .. ################################################################
      # SetProcessorType
      ################################################################

   .. oe:method:: SetProcessorType

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

         .. oe:api::

            bool SetProcessorType(unsigned int processorType = OEMatchedPairProcessor::Default)

      .. oe:language:: python

         .. oe:api:: python

            SetProcessorType(processorType: int) -> bool

      Sets the index processor type to the requested value.

      .. seealso::

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