.. oe:namespace:: OEFastROCS


.. oe:constnamespace:: OEShapeDatabaseType

   This namespace is used to control whether a
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object should store the data
   necessary to calculate the following components of the output
   score:
   :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeTanimoto` and
   :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorTanimoto`. Each
   component has an associated memory and calculation overhead that
   can be avoided is desired. For example, passing
   :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` to the
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` constructor will cut memory
   consumption roughly in half and skip calculating static color scores.

   .. seealso::

      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::Constructors`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetScoreType`

   .. oe:constant:: Color

      Instructs :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` to cache the
      necessary color information so that a subsequent search with
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` will
      yield color scores. It is possible to pass this value into the
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` constructor and then turn
      it off for searches so the same database can be used for
      shape-only and shape+color searches. To turn off the color term
      for only a specific search, pass
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` into the
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetScoreType`
      method, then pass that options object into either
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`.

   .. oe:constant:: Combo

      The combination of
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` and
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Color` as a
      convenience using the name most often used. This is a synonym of
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`.

   .. oe:constant:: Default

      The default setting for :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` is
      to calculate both "Color" and "Shape" scores.  The combination
      of both scores shows very good results for virtual screening
      performance.

   .. oe:constant:: Shape

      Must be specified as part of the
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` constructor or as a term
      in the :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>`
      class.

      .. warning::

         Color-only functionality is currently not supported.

   .. oe:constant:: Sitehopper

      Must be specified as part of the
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` constructor to run a
      Sitehopper calculation.

      .. warning::
         Sitehopper functionality requires a Sitehopper license in
         addition to a FastROCS license.
