.. oe:namespace:: OEFastROCS


.. oe:constnamespace:: OEShapeSimFuncType

   This namespace is used to set which similarity function,
   'Tanimoto' or 'Tversky', :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` objects use to score search
   results.  The default option is :oe:constns:`OEFastROCS::OEShapeSimFuncType::Tanimoto`.
   Tversky scoring is set using the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetSimFunc`
   member function of :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>`.

   .. note::
 
      Tanimoto and Tversky scoring options are mutually exclusive therefore, 
      whichever function was previously selected before performing a search 
      will be the one used to calculate the subsequent score. If no function
      is set the default function is used. 
 
   .. seealso::

      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetSimFunc`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetSimFunc`

   .. oe:constant:: Default 

      Set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to instruct
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` to
      calculate scores for search results using the tanimoto similarity
      function. See :oe:constns:`OEFastROCS::OEShapeSimFuncType::Tanimoto` for more
      details on usage.

   .. oe:constant:: Tanimoto

      Set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to instruct
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` to
      calculate scores for search results using the tanimoto similarity
      function.
      To retrieve the "shape" tanimoto score use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeTanimoto` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeScore`.
      To retrieve the "color" tanimoto score use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorTanimoto` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorScore`.
      To retrieve the combined "shape" and "color" tanimoto scores use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetScore`.

   .. oe:constant:: Tversky

      Set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to instruct
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` to
      calculate scores for search results using the tversky similarity
      function.
      To retrieve the "shape" tversky score use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeTversky` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeScore`.
      To retrieve the "color" tversky score use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorTversky` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorScore`.
      To retrieve the combined "shape" and "color" tversky scores use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTverskyCombo` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetScore`.

   .. warning::

      If using the :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorScore`, 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeScore` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetScore` methods to retrieve scores it
      is advised that the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetSimFunc` method
      is used to determine which similarity function the scores were calculated with. 

   .. note::

      See :oe:constns:`OEFastROCS::OEShapeDatabaseType` for details 
      of how to set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to
      store only "shape" scores or both "shape" and "color" scores. 

   .. warning::

      Color-only functionality is currently not supported.

   See :ref:`molecular_shape_section` section in the **Shape TK** theory documentation for a 
   description of the Tanimoto and Tversky similarity functions.
