.. oe:namespace:: OEMedChem


.. oe:constnamespace:: OEMatchedPairOptions

   This namespace contains constants representing various supported
   options to control a matched pair analysis.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AllCuts

      This constant requests analysis of all
      fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ComboCuts

      This constant requests analysis of all single, double, triple
      combination fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      This constant represents the default options setting for
      matched pair analysis which is
      :oe:const:`OEMedChem::OEMatchedPairOptions::AllCuts`,
      :oe:const:`OEMedChem::OEMatchedPairOptions::UniquesOnly`,
      :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` and
      :oe:const:`OEMedChem::OEMatchedPairOptions::ExportHKeys`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DefaultFragIndex

      This constant represents the default options setting
      for MCS fragment database indexing, which is
      :oe:const:`OEMedChem::OEMatchedPairOptions::AllCuts` and
      :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DoubleCuts

      This constant requests analysis of only double
      fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ExportCompression

      This constant affects the serialization of information from
      a :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance.
      If enabled, singleton index nodes are *not* exported, thereby dramatically
      reducing the size of the serialized information.  This option should *only* be used
      to export information from a static index since reading of this
      compressed index information and indexing of additional input structures
      miss valid matched molecular pairs.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ExportHKeys

      This constant affects the serialization of information from
      a :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance.
      If enabled, extra index information that supports
      the :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` capability
      is serialized to the output file to increase index loading performance.
      If this information is suppressed, the serialized file size will be
      10-20% smaller and this information will be regenerated as needed.
      If :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` is not
      enabled, this option has no effect on serialization or deserialization.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IndexHSingleCuts

      This constant activates additional indexing activity in order
      to capture matched pairs that differ by hydrogen presence
      at one or more of the substitution sites for SingleCuts only.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IndexHSites

      This constant activates additional indexing activity in order
      to capture matched pairs that differ by hydrogen presence
      at one or more of the substitution sites for all fragmentation
      cut types.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SingleCuts

      This constant requests analysis of only single
      fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TripleCuts

      This constant requests analysis of only triple
      fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: UniquesOnly

      This constant requests uniqueness checking using canonical
      SMILES of the input structures to avoid duplicated indexed
      fragments.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ValidAlterOpts

      This constant is a bit mask of all the options that can be
      changed on an active :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ValidFragIndexOpts

      This constant is a bit mask of all the valid read-only option values
      for an active :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` instance.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ValidIndexOpts

      This constant is a bit mask of all the valid read-only option values
      for an active :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ValidOptions

      This constant is a bit mask of all the valid option values and
      is a union of :oe:const:`OEMedChem::OEMatchedPairOptions::ValidAlterOpts`
      and :oe:const:`OEMedChem::OEMatchedPairOptions::ValidIndexOpts`

