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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEHitlistBuilder, HitlistBuilder


.. _OEBioisostere_OEHitlistBuilder:

.. oe:class:: OEHitlistBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHitlistBuilder

   This class defines an interface for generating a hit list from calculated
   :ref:`Brood scores <OEBioisostere_OEBroodScore>`.

   The :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>` class defines the following public methods:
    * :oe:meth:`AddScores<OEBioisostere::OEHitlistBuilder::AddScores>`
    * :oe:meth:`Build<OEBioisostere::OEHitlistBuilder::Build>`
    * :oe:meth:`GetAddCount<OEBioisostere::OEHitlistBuilder::GetAddCount>`
    * :oe:meth:`GetBumpCount<OEBioisostere::OEHitlistBuilder::GetBumpCount>`
    * :oe:meth:`GetDeleteCount<OEBioisostere::OEHitlistBuilder::GetDeleteCount>`
    * :oe:meth:`GetDuplicateCount<OEBioisostere::OEHitlistBuilder::GetDuplicateCount>`
    * :oe:meth:`GetFailedCount<OEBioisostere::OEHitlistBuilder::GetFailedCount>`
    * :oe:meth:`GetHitCount<OEBioisostere::OEHitlistBuilder::GetHitCount>`
    * :oe:meth:`GetHits<OEBioisostere::OEHitlistBuilder::GetHits>`
    * :oe:meth:`GetInitHitCount<OEBioisostere::OEHitlistBuilder::GetInitHitCount>`
    * :oe:meth:`GetMatchCount<OEBioisostere::OEHitlistBuilder::GetMatchCount>`
    * :oe:meth:`GetSelectCount<OEBioisostere::OEHitlistBuilder::GetSelectCount>`
    * :oe:meth:`GetSecDuplicateCount<OEBioisostere::OEHitlistBuilder::GetSecDuplicateCount>`
    * :oe:meth:`GetStrainCount<OEBioisostere::OEHitlistBuilder::GetStrainCount>`
    * :oe:meth:`GetUnstableCount<OEBioisostere::OEHitlistBuilder::GetUnstableCount>`


   .. _OEBioisostere_OEHitlistBuilder_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEHitlistBuilder(const OEBroodQuery& query,
                             const OEHitlistBuilderOptions& options)
            OEHitlistBuilder(const OEBroodQuery& query,
                             const OEBroodGeneralOptions& genOpts = OEBroodGeneralOptions(),
                             const OEBroodHitlistOptions& options = OEBroodHitlistOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEHitlistBuilder(query: OEBroodQuery,
                             options: OEHitlistBuilderOptions) -> OEHitlistBuilder
            OEHitlistBuilder(query: OEBroodQuery,
                             genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
                             options: OEBroodHitlistOptions = OEBroodHitlistOptions()) -> OEHitlistBuilder

      Default and copy constructors.

   .. _OEBioisostere_OEHitlistBuilder_AddScores:

   .. oe:method:: AddScores

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

         .. oe:api::

            bool AddScores(const std::vector<OEBroodScore> &)

      .. oe:language:: python

         .. oe:api:: python

            AddScores(arg2: OEBroodScoreVector) -> bool

      This method adds the specified scores for building the hit list.

   .. _OEBioisostere_OEHitlistBuilder_Build:

   .. oe:method:: Build

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

         .. oe:api::

            bool Build(OESystem::OETracerBase& tracer = OESystem::OENoTracer)

      .. oe:language:: python

         .. oe:api:: python

            Build(tracer: OETracerBase = OENoTracer) -> bool

      This method builds the hit list. This method should be called after all scores have
      been added
      via :oe:meth:`AddScores<OEBioisostere::OEHitlistBuilder::AddScores>`.

   .. _OEBioisostere_OEHitlistBuilder_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 scores added.

   .. _OEBioisostere_OEHitlistBuilder_GetBumpCount: 

   .. oe:method:: GetBumpCount

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

         .. oe:api::

            unsigned GetBumpCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetBumpCount() -> int

      This method returns the total number of matches that were rejected due to bumping with protein.

   .. _OEBioisostere_OEHitlistBuilder_GetDeleteCount: 

   .. oe:method:: GetDeleteCount

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

         .. oe:api::

            unsigned GetDeleteCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteCount() -> int

      This method returns the total number of matches that were deleted.

   .. _OEBioisostere_OEHitlistBuilder_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 total number of matches that were marked as duplicates.

   .. _OEBioisostere_OEHitlistBuilder_GetFailedCount: 

   .. oe:method:: GetFailedCount

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

         .. oe:api::

            unsigned GetFailedCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetFailedCount() -> int

      This method returns the total number of matches that were failed due to reasons other than
      being duplicated or having excessive strain, an unstable bond, or a protein clash. 
      These are failed whether due to unsuccessful protonation, elongated bond, 
      or the inability to calculate or attach the medicinal chemistry data.

   .. _OEBioisostere_OEHitlistBuilder_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 total number of generated hits in the hit list.

   .. _OEBioisostere_OEHitlistBuilder_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 the generated hits.

   .. _OEBioisostere_OEHitlistBuilder_GetInitHitCount:
   
   .. oe:method:: GetInitHitCount

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

         .. oe:api::

            unsigned GetInitHitCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitHitCount() -> int

      This method returns the initial size of the hit list.

   .. _OEBioisostere_OEHitlistBuilder_GetMatchCount: 

   .. oe:method:: GetMatchCount

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

         .. oe:api::

            unsigned GetMatchCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchCount() -> int

      This method returns the total number of matches found.

   .. _OEBioisostere_OEHitlistBuilder_GetSelectCount:

   .. oe:method:: GetSelectCount

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

         .. oe:api::

            unsigned GetSelectCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetSelectCount() -> int

      This method returns the number of matches rejected with
      :oe:const:`OEBioisostere::OEBroodStatusCode::SelectFail` during build.

   .. _OEBioisostere_OEHitlistBuilder_GetSecDuplicateCount:

   .. oe:method:: GetSecDuplicateCount

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

         .. oe:api::

            unsigned GetSecDuplicateCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetSecDuplicateCount() -> int

      This method returns the number of secondary duplicates.


   .. _OEBioisostere_OEHitlistBuilder_GetStrainCount:

   .. oe:method:: GetStrainCount

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

         .. oe:api::

            unsigned GetStrainCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrainCount() -> int

      This method returns the number of matches rejected due to strain.


   .. _OEBioisostere_OEHitlistBuilder_GetUnstableCount:

   .. oe:method:: GetUnstableCount

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

         .. oe:api::

            unsigned GetUnstableCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnstableCount() -> int

      This method returns the number of matches rejected due to unstable bonds.
