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

.. oe:namespace:: OEMedChem


.. meta::
   :keywords: OEMCSFragDatabaseOptions, MCSFragDatabaseOptions


.. _OEMedChem_OEMCSFragDatabaseOptions:

.. oe:class:: OEMCSFragDatabaseOptions

   .. oe:api::

      class OEMCSFragDatabaseOptions

   Encapsulates the properties that control MCS fragmentation indexing.


   .. seealso::

      * :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMCSFragDatabaseOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEMCSFragDatabaseOptions() -> OEMCSFragDatabaseOptions

      Default constructor that initializes an :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>`
      object with the following properties:

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

         * - Property
           - Default value

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

         * - maximum allowed fragmentation bonds for indexed molecules
           - 20

         * - maximum allowed heavy atoms for indexed molecules
           - 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::

            OEMCSFragDatabaseOptions(const OEMCSFragDatabaseOptions& options)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSFragDatabaseOptions(arg2: OEMCSFragDatabaseOptions) -> OEMCSFragDatabaseOptions

      Copy constructor.

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

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

      .. oe:api::

         OEMCSFragDatabaseOptions &operator=(const OEMCSFragDatabaseOptions &rhs)

      Assignment operator.

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

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

      .. oe:api::

         bool operator==(const OEMCSFragDatabaseOptions &rhs)

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

   .. ################################################################
      # GetMaxFragLimit
      ################################################################

   .. oe:method:: GetMaxFragLimit

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

         .. oe:api::

            unsigned int GetMaxFragLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxFragLimit() -> int

      Return the maximum number of fragmentation bonds that are
      allowed to be cut. Structures with more than this limit
      are not fragmented.

   .. ################################################################
      # GetMinFragLimit
      ################################################################

   .. oe:method:: GetMinFragLimit

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

         .. oe:api::

            unsigned int GetMinFragLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinFragLimit() -> int

      Return the minimum number of fragmentation bonds that are
      allowed to be cut. Structures with less than this limit
      are not fragmented.

   .. ################################################################
      # 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::DefaultFragIndex`.

   .. ################################################################
      # GetRingFragLimit
      ################################################################

   .. oe:method:: GetRingFragLimit

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

         .. oe:api::

            unsigned int GetRingFragLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetRingFragLimit() -> int

      Return the maximum number of ring fragmentation bonds that are
      allowed to be cut. Structures with more possible ring bonds
      than this limit will not have ring bonds fragmented.

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

   .. ################################################################
      # SetFragLimits
      ################################################################

   .. oe:method:: SetFragLimits

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

         .. oe:api::

            bool SetFragLimits(unsigned int minval, unsigned int maxval)

      .. oe:language:: python

         .. oe:api:: python

            SetFragLimits(minval: int, maxval: int) -> bool

      Sets the min and max range of fragmentation bond cuts.

      .. warning::

         Very high limits for the allowed number of fragmentation bonds
         will have severe performance implications for indexing due to
         the combinatorial explosion in the number of fragmentation
         cores generated.

   .. ################################################################
      # 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::DefaultFragIndex`.

   .. ################################################################
      # SetRingFragLimit
      ################################################################

   .. oe:method:: SetRingFragLimit

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

         .. oe:api::

            bool SetRingFragLimit(unsigned int maxringcuts)

      .. oe:language:: python

         .. oe:api:: python

            SetRingFragLimit(val: int) -> bool

      Sets maximum number of ring cuts allowed.
      Structures with more possible ring bonds
      than this limit will not have ring bonds fragmented.

      .. warning::

         Very high limits for the allowed number of ring fragmentation bonds
         will have severe performance implications for indexing due to
         the combinatorial explosion in the number of fragmentation
         cores generated.
