.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodOverlayBase, BroodOverlayBase


.. _OEBioisostere_OEBroodOverlayBase:

.. oe:class:: OEBroodOverlayBase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodOverlayBase

   This is a base class for fragment overlay optimization.

   The :ref:`OEBroodOverlayBase <OEBioisostere_OEBroodOverlayBase>` class defines the following public methods:
    * :oe:meth:`Overlay<OEBioisostere::OEBroodOverlayBase::Overlay>`


   .. _OEBioisostere_OEBroodOverlayBase_Overlay:

   .. oe:method:: Overlay

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

         .. oe:api::

            unsigned Overlay(OEChem::OEMCMolBase& fragment, OEBroodScore& score)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(fragment: OEMol, match: OEBroodScore) -> int

      Performs overlay optimization of the specified fragment. Populates the
      provided :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` with optimization
      results. Returns the status of the optimization; see
      :oe:constns:`OEBioisostere::OEBroodStatusCode` for possible values.
