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

.. oe:namespace:: OEMedChem


.. meta::
   :keywords: OEMatchedPairTransformExtractOptions, MatchedPairTransformExtractOptions


.. _OEMedChem_OEMatchedPairTransformExtractOptions:

.. oe:class:: OEMatchedPairTransformExtractOptions

   .. oe:api::

      class OEMatchedPairTransformExtractOptions

   Encapsulates the properties that control extraction of matched molecular pair transformations.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
      * :oe:func:`OEMedChem::OEMatchedPairGetTransforms` function

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMatchedPairTransformExtractOptions(int context = OEMatchedPairContext::Default,
                                                 unsigned int options = OEMatchedPairTransformExtractMode::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairTransformExtractOptions(context: int, options: int) -> OEMatchedPairTransformExtractOptions

      Default constructor that initializes an :ref:`OEMatchedPairTransformExtractOptions <OEMedChem_OEMatchedPairTransformExtractOptions>`
      object with the following properties:

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

         * - Property
           - Default value

         * - transformation context
           - :oe:const:`OEMedChem::OEMatchedPairContext::Default`

         * - extraction options
           - :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Default`

         * - maximum matched pair core structure substituents
           - 200

         * - skip maximum matched pair core index nodes exceeding substituent limit
           - false

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

         .. oe:api::

            OEMatchedPairTransformExtractOptions(const OEMatchedPairTransformExtractOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairTransformExtractOptions(rhs: OEMatchedPairTransformExtractOptions) -> OEMatchedPairTransformExtractOptions

      Copy constructor.

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

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

      .. oe:api::

         OEMatchedPairTransformExtractOptions &operator=(const OEMatchedPairTransformExtractOptions &rhs)

      Assignment operator.

   .. ################################################################
      # GetAttachmentPoints
      ################################################################

   .. oe:method:: GetAttachmentPoints

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

         .. oe:api::

            bool GetAttachmentPoints() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachmentPoints() -> bool

      Returns the setting that requests the addition of attachment
      points on the matched pair transformation.

   .. ################################################################
      # GetContext
      ################################################################

   .. oe:method:: GetContext

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

         .. oe:api::

            int GetContext() const

      .. oe:language:: python

         .. oe:api:: python

            GetContext() -> int

      Returns the setting that controls the amount
      of core chemistry adjacent to the substituent attachment site
      for the matched pairs.

      .. seealso::

         * :oe:const:`OEMedChem::OEMatchedPairContext::Default`

   .. ################################################################
      # GetDirection
      ################################################################

   .. oe:method:: GetDirection

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

         .. oe:api::

            unsigned int GetDirection() const

      .. oe:language:: python

         .. oe:api:: python

            GetDirection() -> int

      Returns the setting that controls the direction
      for the returned matched pair transformation.
      One of :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Forward`,
      :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Backward`,
      ( :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Forward` |
      :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Backward` )`` (both)
      or :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Sorted`
      are supported.
      For :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Sorted`,
      the transformation is lexically sorted based on
      the reactants and products and may need to be inverted to have
      the transformation represent driving an arbitrary data property
      associated with the matched pair in a desired direction.

      .. seealso::

         * :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Default`
         * :oe:meth:`OEMedChem::OEMatchedPairTransform::Invert`

   .. ################################################################
      # GetIsotopes
      ################################################################

   .. oe:method:: GetIsotopes

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

         .. oe:api::

            bool GetIsotopes() const

      .. oe:language:: python

         .. oe:api:: python

            GetIsotopes() -> bool

      Returns the setting that controls the generalization of the
      returned transformations for isotopic substitutions.

   .. ################################################################
      # GetMCSCorrespondence
      ################################################################

   .. oe:method:: GetMCSCorrespondence

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

         .. oe:api::

            bool GetMCSCorrespondence() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSCorrespondence() -> bool

      Returns the setting that requests the addition of atom-atom
      mapping correspondence to the core of the matched pair transformation.

   .. ################################################################
      # GetMatchedPairData
      ################################################################

   .. oe:method:: GetMatchedPairData

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

         .. oe:api::

            bool GetMatchedPairData() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchedPairData() -> bool

      Returns whether the matched pair data is included in the
      matched pair transformation.  If only the transformation
      itself is required, there may not be a need for extraction
      of related matched pair indexed data.

   .. ################################################################
      # GetMatchedPairs
      ################################################################

   .. oe:method:: GetMatchedPairs

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

         .. oe:api::

            bool GetMatchedPairs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchedPairs() -> bool

      Returns whether the matched pair data ids are returned for the
      matched pair transformation.  If only the transformation
      itself is required, there may not be a need for extraction
      of related matched pair indices.

   .. ################################################################
      # GetMaxMMPLimit
      ################################################################

   .. oe:method:: GetMaxMMPLimit

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

         .. oe:api::

            unsigned int GetMaxMMPLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMMPLimit() -> int

      Returns the requested upper limit of matched pairs for the extracted
      transformations.

   .. ################################################################
      # GetMaxSubstituentLimit
      ################################################################

   .. oe:method:: GetMaxSubstituentLimit

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

         .. oe:api::

            unsigned int GetMaxSubstituentLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSubstituentLimit() -> int

      Returns the setting for the maximum number of indexed
      core substituents that should be processed into matched pair
      transformations.

      .. warning::

         Setting this limit to ``0`` will suppress any core structure
         truncation or skipping activities, but may result in
         extremely poor transformation extraction performance owing to the
         combinatorial explosion of generating all ``NxM`` combinations of matched pairs.

   .. ################################################################
      # GetMaxSubstituentLimitSkip
      ################################################################

   .. oe:method:: GetMaxSubstituentLimitSkip

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

         .. oe:api::

            bool GetMaxSubstituentLimitSkip() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSubstituentLimitSkip() -> bool

      Returns whether the matched pair core structures in the
      index that have more than the :oe:meth:`OEMedChem::OEMatchedPairTransformExtractOptions::GetMaxSubstituentLimit`
      number of substituents are processed into matched pair
      transformation entries.  If the setting is ``true``, cores
      that exceed the limit are skipped, and if ``false``, the
      substituent list is truncated to the first :oe:meth:`OEMedChem::OEMatchedPairTransformExtractOptions::GetMaxSubstituentLimit`
      substituents, if non-zero.

   .. ################################################################
      # GetMinMMPLimit
      ################################################################

   .. oe:method:: GetMinMMPLimit

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

         .. oe:api::

            unsigned int GetMinMMPLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinMMPLimit() -> int

      Returns the requested lower limit of matched pairs for the extracted
      transformations.

   .. ################################################################
      # GetMinSubstituentLimit
      ################################################################

   .. oe:method:: GetMinSubstituentLimit

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

         .. oe:api::

            unsigned int GetMinSubstituentLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinSubstituentLimit() -> int

      Returns the setting for the minimum number of
      core structure substituents for index nodes that should be processed
      into matched pair transformations.

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

   .. oe:method:: GetOptions

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

         .. oe:api::

            unsigned int GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> int

      Returns the bit option settings for the extraction options.

      .. seealso::

         * :oe:constns:`OEMedChem::OEMatchedPairTransformExtractMode`

   .. ################################################################
      # GetSMARTS
      ################################################################

   .. oe:method:: GetSMARTS

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

         .. oe:api::

            bool GetSMARTS() const

      .. oe:language:: python

         .. oe:api:: python

            GetSMARTS() -> bool

      Returns whether the matched pair transformations are annotated
      with additional SMARTS qualifiers to make the transformations more
      chemically relevant when used for generating chemical transformations
      from extracted matched pairs.

   .. ################################################################
      # SetAttachmentPoints
      ################################################################

   .. oe:method:: SetAttachmentPoints

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

         .. oe:api::

            bool SetAttachmentPoints(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetAttachmentPoints(val: bool) -> bool

      Set the option that controls the addition of attachment points on the
      matched pair transformation.

   .. ################################################################
      # SetContext
      ################################################################

   .. oe:method:: SetContext

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

         .. oe:api::

            bool SetContext(int context)

      .. oe:language:: python

         .. oe:api:: python

            SetContext(context: int) -> bool

      Sets the option that that controls the amount
      of core chemistry adjacent to the substituent attachment site
      in then matched pair transformation.

      .. seealso::

         * :oe:const:`OEMedChem::OEMatchedPairContext::Default`

   .. ################################################################
      # SetDirection
      ################################################################

   .. oe:method:: SetDirection

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

         .. oe:api::

            bool SetDirection(unsigned int direction)

      .. oe:language:: python

         .. oe:api:: python

            SetDirection(direction: int) -> bool

      Sets the specified transformation direction for the returned matched
      pair transformation.  One of ``Forward``,
      ``Backward``, ``(Forward | Backward)`` (both) or ``Sorted`` are supported.
      For ``Sorted``, the transformation is lexically sorted based on
      the reactants and products and may need to be inverted to have
      the transformation represent driving an arbitrary data property
      associated with the matched pair in a desired direction.

      .. seealso::

         * :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Default`
         * :oe:meth:`OEMedChem::OEMatchedPairTransform::Invert`

   .. ################################################################
      # SetIsotopes
      ################################################################

   .. oe:method:: SetIsotopes

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

         .. oe:api::

            bool SetIsotopes(bool require)

      .. oe:language:: python

         .. oe:api:: python

            SetIsotopes(val: bool) -> bool

      Sets the option that controls whether the transformation
      is allowed to be generalized for isotopic substitutions.  If
      ``true``, isotopic information will be included in the transformations
      for the chemical modifications.

   .. ################################################################
      # SetMCSCorrespondence
      ################################################################

   .. oe:method:: SetMCSCorrespondence

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

         .. oe:api::

            bool SetMCSCorrespondence(bool add)

      .. oe:language:: python

         .. oe:api:: python

            SetMCSCorrespondence(val: bool) -> bool

      Sets the option that requests the addition of atom-atom
      mapping correspondence to the core of the matched pair transformation.

   .. ################################################################
      # SetMatchedPairData
      ################################################################

   .. oe:method:: SetMatchedPairData

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

         .. oe:api::

            bool SetMatchedPairData(bool enable)

      .. oe:language:: python

         .. oe:api:: python

            SetMatchedPairData(val: bool) -> bool

      Sets the option that requests matched pair data be
      included in the matched pair transformation.  If only the transformation
      itself is required, there may not be a need for extraction
      of related matched pair indexed data, so the data extraction can be disabled.

   .. ################################################################
      # SetMatchedPairs
      ################################################################

   .. oe:method:: SetMatchedPairs

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

         .. oe:api::

            bool SetMatchedPairs(bool enable)

      .. oe:language:: python

         .. oe:api:: python

            SetMatchedPairs(val: bool) -> bool

      Sets the option that requests that matched pair structure ids are returned for the
      matched pair transformation.  If only the transformation
      itself is required, there may not be a need for extraction
      of related matched pair structure indices.

   .. ################################################################
      # SetMaxSubstituentLimitSkip
      ################################################################

   .. oe:method:: SetMaxSubstituentLimitSkip

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

         .. oe:api::

            bool SetMaxSubstituentLimitSkip(bool skip)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSubstituentLimitSkip(val: bool) -> bool

      Sets the option that controls whether the matched pair core structures in the
      index that have more than the :oe:meth:`OEMedChem::OEMatchedPairTransformExtractOptions::GetMaxSubstituentLimit`
      number of substituents are processed into matched pair
      transformation entries.  If the setting is ``true``, cores
      that exceed the limit are skipped, and if ``false``, the
      substituent list is truncated to the first :oe:meth:`OEMedChem::OEMatchedPairTransformExtractOptions::GetMaxSubstituentLimit`
      substituents, if non-zero.

   .. ################################################################
      # SetMMPLimit
      ################################################################

   .. oe:method:: SetMMPLimit

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

         .. oe:api::

            bool SetMMPLimit(unsigned int atLeast, unsigned int atMost = 0u)

      .. oe:language:: python

         .. oe:api:: python

            SetMMPLimit(atLeast: int, atMost: int = 0) -> bool

      Sets the requested range limits for the number matched pairs in the extracted
      transformations.

   .. ################################################################
      # SetSubstituentLimit
      ################################################################

   .. oe:method:: SetSubstituentLimit

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

         .. oe:api::

            bool SetSubstituentLimit(unsigned int atLeast,
                                     unsigned int atMost = 0u)

      .. oe:language:: python

         .. oe:api:: python

            SetSubstituentLimit(atLeast: int, atMost: int = 0) -> bool

      Sets the requested range limits for the core structure index nodes to constrain
      processing to core index nodes matching the specified range.

      .. warning::

         Setting the maximum limit to ``0`` will suppress any core structure
         truncation or skipping activities, but may result in
         extremely poor transformation extraction performance owing to the
         combinatorial explosion of generating all ``NxM`` combinations of matched pairs
         and their associated transformations and data.

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

   .. oe:method:: SetOptions

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

         .. oe:api::

            bool SetOptions(unsigned int options)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(opts: int) -> bool

      Sets the bit option settings that control the transformation extraction activities.

      .. seealso::

         * :oe:constns:`OEMedChem::OEMatchedPairTransformExtractMode`

   .. ################################################################
      # SetSMARTS
      ################################################################

   .. oe:method:: SetSMARTS

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

         .. oe:api::

            bool SetSMARTS(bool enable)

      .. oe:language:: python

         .. oe:api:: python

            SetSMARTS(val: bool) -> bool

      Sets the option that indicates that matched pair transformations should be annotated
      with additional SMARTS qualifiers to make the transformations more
      chemically relevant when used for generating chemical transformations
      from extracted matched pairs.
