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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodHitlist, BroodHitlist


.. _OEBioisostere_OEBroodHitlist:

.. oe:class:: OEBroodHitlist

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodHitlist: public OEHitlistBase

   This class manages curated, built
   :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` objects and provides final
   hit list filtering behavior for molecule-level results.

   The :ref:`OEBroodHitlist <OEBioisostere_OEBroodHitlist>` class defines the following public methods:
    * :oe:meth:`AddHits<OEBioisostere::OEBroodHitlist::AddHits>`
    * :oe:meth:`Build<OEBioisostere::OEBroodHitlist::Build>`
    * :oe:meth:`GetHits<OEBioisostere::OEBroodHitlist::GetHits>`



   .. _OEBioisostere_OEBroodHitlist_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodHitlist()
            OEBroodHitlist(const OEChem::OEMolBase& mol,
                           const OEBroodHitlistOptions& options = OEBroodHitlistOptions())
            OEBroodHitlist(const OEBroodQuery& query,
                           const OEBroodHitlistOptions& options = OEBroodHitlistOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEBroodHitlist() -> OEBroodHitlist
            OEBroodHitlist(query: OEBroodQuery,
                           options: OEBroodHitlistOptions = OEBroodHitlistOptions()) -> OEBroodHitlist
            OEBroodHitlist(mol: Union[OEGraphMol,OEMol,OEQMol],
                           options: OEBroodHitlistOptions = OEBroodHitlistOptions()) -> OEBroodHitlist

      This method constructs an :ref:`OEBroodHitlist <OEBioisostere_OEBroodHitlist>` either
      with no arguments (default), with a query molecule and options, or with
      an :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` and options.


   .. _OEBioisostere_OEBroodHitlist_AddHits:

   .. oe:method:: AddHits

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

         .. oe:api::

            bool AddHits(const std::vector<OEBroodHit>&)

      .. oe:language:: python

         .. oe:api:: python

            AddHits(arg2: OEBroodHitVector) -> bool

      This method adds a batch of :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` objects to
      the hit list.


   .. _OEBioisostere_OEBroodHitlist_Build:

   .. oe:method:: Build

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

         .. oe:api::

            bool Build(const bool final = true) override

      .. oe:language:: python

         .. oe:api:: python

            Build(final: bool = True) -> bool

      This method builds the final hit list from all added hits, filtering duplicates
      and applying scored-based filtering if configured.


   .. _OEBioisostere_OEBroodHitlist_GetHits:

   .. oe:method:: GetHits

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

         .. oe:api::

            const std::vector<OEBroodHit>& GetHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetHits() -> OEBroodHitVector

      This method returns a reference to the vector of final :ref:`OEBroodHit <OEBioisostere_OEBroodHit>`
      objects after building and filtering.

