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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEHitlistBase, HitlistBase


.. _OEBioisostere_OEHitlistBase:

.. oe:class:: OEHitlistBase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHitlistBase

   This is an abstract base class for hit list management that defines the common
   interface for collecting and filtering bioisosteric hits. 

   The following classes have been derived from this class:
    * :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>`
    * :ref:`OEBroodHitlist <OEBioisostere_OEBroodHitlist>`


   The :ref:`OEHitlistBase <OEBioisostere_OEHitlistBase>` class defines the following public methods:

    * :oe:meth:`Build<OEBioisostere::OEHitlistBase::Build>`
    * :oe:meth:`GetAddCount<OEBioisostere::OEHitlistBase::GetAddCount>`
    * :oe:meth:`GetDuplicateCount<OEBioisostere::OEHitlistBase::GetDuplicateCount>`
    * :oe:meth:`GetHitCount<OEBioisostere::OEHitlistBase::GetHitCount>`


   .. _OEBioisostere_OEHitlistBase_Build:

   .. oe:method:: Build

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

         .. oe:api::

            virtual bool Build(const bool final = true) = 0

      .. oe:language:: python

         .. oe:api:: python

            Build(final: bool = True) -> bool

      This method builds and finalizes the hit list, performing duplicate filtering and
      hit list creation. The ``final`` parameter controls whether this is the final
      build (``true``) or an intermediate build (``false``).


   .. _OEBioisostere_OEHitlistBase_GetAddCount:

   .. oe:method:: GetAddCount

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

         .. oe:api::

            unsigned GetAddCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddCount() -> int

      This method returns the total number of entries submitted to the hit list.


   .. _OEBioisostere_OEHitlistBase_GetDuplicateCount:

   .. oe:method:: GetDuplicateCount

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

         .. oe:api::

            unsigned GetDuplicateCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetDuplicateCount() -> int

      This method returns the number of entries recognized as duplicates.


   .. _OEBioisostere_OEHitlistBase_GetHitCount:

   .. oe:method:: GetHitCount

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

         .. oe:api::

            unsigned GetHitCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHitCount() -> int

      This method returns the number of retained hits currently in the hit list.

