.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapResults, OverlapResults


.. _OEShape_OEOverlapResults:

.. oe:class:: OEOverlapResults

   .. oe:api::


      struct OEOverlapResults

   This class represents overlap calculation results between a reference and a fit object.

   The :ref:`OEOverlapResults <OEShape_OEOverlapResults>` class defines the following public methods:
    * :oe:meth:`GetColorScore<OEShape::OEOverlapResults::GetColorScore>`
    * :oe:meth:`GetColorTanimoto<OEShape::OEOverlapResults::GetColorTanimoto>` 
    * :oe:meth:`GetColorTversky<OEShape::OEOverlapResults::GetColorTversky>`
    * :oe:meth:`GetFitColorTversky<OEShape::OEOverlapResults::GetFitColorTversky>` 
    * :oe:meth:`GetFitSelfColor<OEShape::OEOverlapResults::GetFitSelfColor>`
    * :oe:meth:`GetFitSelfOverlap<OEShape::OEOverlapResults::GetFitSelfOverlap>`
    * :oe:meth:`GetFitTversky<OEShape::OEOverlapResults::GetFitTversky>` 
    * :oe:meth:`GetFitTverskyCombo<OEShape::OEOverlapResults::GetFitTverskyCombo>`
    * :oe:meth:`GetOverlap<OEShape::OEOverlapResults::GetOverlap>`
    * :oe:meth:`GetRefColorTversky<OEShape::OEOverlapResults::GetRefColorTversky>` 
    * :oe:meth:`GetRefSelfColor<OEShape::OEOverlapResults::GetRefSelfColor>`
    * :oe:meth:`GetRefSelfOverlap<OEShape::OEOverlapResults::GetRefSelfOverlap>`
    * :oe:meth:`GetRefTversky<OEShape::OEOverlapResults::GetRefTversky>` 
    * :oe:meth:`GetRefTverskyCombo<OEShape::OEOverlapResults::GetRefTverskyCombo>`
    * :oe:meth:`GetTanimoto<OEShape::OEOverlapResults::GetTanimoto>`
    * :oe:meth:`GetTanimotoCombo<OEShape::OEOverlapResults::GetTanimotoCombo>` 
    * :oe:meth:`GetTversky<OEShape::OEOverlapResults::GetTversky>`

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEOverlapResults()
            OEOverlapResults(const OEOverlapResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlapResults() -> OEOverlapResults
            OEOverlapResults(rhs: OEOverlapResults) -> OEOverlapResults

      Default and copy constructors.

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

      .. oe:api::

         OEOverlapResults &operator=(const OEOverlapResults &)

      Assignment operator.


   .. oe:method:: GetColorScore

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

         .. oe:api::

            float GetColorScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorScore() -> float

      Returns the color score (overlap) between the reference and the fit.

   .. oe:method:: GetColorTanimoto

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

         .. oe:api::

            float GetColorTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorTanimoto() -> float

      Returns the color tanimoto.

   .. oe:method:: GetColorTversky

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

         .. oe:api::

            float GetColorTversky(float alpha = 0.95f, float beta = 0.05f) const

      .. oe:language:: python

         .. oe:api:: python

            GetColorTversky(alpha: float = 0.95, beta: float = 0.05) -> float

      Returns the color tversky with the specified alpha and beta.

   .. oe:method:: GetFitColorTversky

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

         .. oe:api::

            float GetFitColorTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitColorTversky() -> float

      Returns the color tversky with beta = 0.95.

   .. oe:method:: GetFitSelfColor

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

         .. oe:api::

            float GetFitSelfColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitSelfColor() -> float

      Returns the self color score for the fit molecule.

   .. oe:method:: GetFitSelfOverlap

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

         .. oe:api::

            float GetFitSelfOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitSelfOverlap() -> float

      Returns the self shape overlap for the fit molecule.

   .. oe:method:: GetFitTversky

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

         .. oe:api::

            float GetFitTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitTversky() -> float

      Returns the shape tversky with beta = 0.95.

   .. oe:method:: GetFitTverskyCombo

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

         .. oe:api::

            float GetFitTverskyCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitTverskyCombo() -> float

      Returns the sum of shape tversky with beta = 0.95, and the color tversky with beta = 0.95.

   .. oe:method:: GetOverlap

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

         .. oe:api::

            float GetOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlap() -> float

      Returns the shape overlap between the reference and the fit.

   .. oe:method:: GetRefColorTversky

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

         .. oe:api::

            float GetRefColorTversky() const
            Returns the color tversky with alpha = 0.95.

      .. oe:language:: python

         .. oe:api:: python

            GetRefColorTversky() -> float

   .. oe:method:: GetRefSelfColor

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

         .. oe:api::

            float GetRefSelfColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfColor() -> float

      Returns the self color score for the reference object.

   .. oe:method:: GetRefSelfOverlap

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

         .. oe:api::

            float GetRefSelfOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfOverlap() -> float

      Returns the self shape overlap for the reference object.

   .. oe:method:: GetRefTversky

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

         .. oe:api::

            float GetRefTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefTversky() -> float

      Returns the shape tversky with alpha = 0.95.

   .. oe:method:: GetRefTverskyCombo

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

         .. oe:api::

            float GetRefTverskyCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefTverskyCombo() -> float

      Returns the sum of shape tversky with alpha = 0.95, and color tversky with alpha = 0.95.

   .. oe:method:: GetTanimoto

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

         .. oe:api::

            float GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      Returns the shape tanimoto.

   .. oe:method:: GetTanimotoCombo

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

         .. oe:api::

            float GetTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimotoCombo() -> float

      Returns the sum of shape tanimoto and color tanimoto.

   .. oe:method:: GetTversky

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

         .. oe:api::

            float GetTversky(float alpha = 0.95f, float beta = 0.05f) const

      .. oe:language:: python

         .. oe:api:: python

            GetTversky(alpha: float = 0.95, beta: float = 0.05) -> float

      Returns the shape tversky with the specified alpha and beta.

