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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodCluster, BroodCluster


.. _OEBioisostere_OEBroodCluster:

.. oe:class:: OEBroodCluster

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodCluster

   This class represents a cluster of bioisosteric hits grouped by structural
   similarity. Each cluster has a head hit and optional member hits that are
   considered similar to that head under the clustering mode.

   The :ref:`OEBroodCluster <OEBioisostere_OEBroodCluster>` class defines the following public methods:
    * :oe:meth:`Count<OEBioisostere::OEBroodCluster::Count>`
    * :oe:meth:`GetHead<OEBioisostere::OEBroodCluster::GetHead>`
    * :oe:meth:`GetInterest<OEBioisostere::OEBroodCluster::GetInterest>`
    * :oe:meth:`GetMembers<OEBioisostere::OEBroodCluster::GetMembers>`
    * :oe:meth:`GetRank<OEBioisostere::OEBroodCluster::GetRank>`
    * :oe:meth:`operator<OEBioisostere::OEBroodCluster::operator>`



   .. _OEBioisostere_OEBroodCluster_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodCluster()
            OEBroodCluster(const OEBroodCluster&)
            OEBroodCluster& operator=(const OEBroodCluster&)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodCluster() -> OEBroodCluster
            OEBroodCluster(arg2: OEBroodCluster) -> OEBroodCluster

      Default and copy constructors.


   .. _OEBioisostere_OEBroodCluster_Count:
   .. oe:method:: Count

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

         .. oe:api::

            unsigned Count() const

      .. oe:language:: python

         .. oe:api:: python

            Count() -> int

      This method returns the total number of hits in the cluster (head + members).


   .. _OEBioisostere_OEBroodCluster_GetHead:
   .. oe:method:: GetHead

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

         .. oe:api::

            const OEBroodHit& GetHead() const

      .. oe:language:: python

         .. oe:api:: python

            GetHead() -> OEBroodHit

      This method returns the cluster head hit, which serves as the representative hit for
      the cluster.


   .. _OEBioisostere_OEBroodCluster_GetInterest:
   .. oe:method:: GetInterest

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

         .. oe:api::

            double GetInterest() const

      .. oe:language:: python

         .. oe:api:: python

            GetInterest() -> float

      This method returns the computed interest score used to prioritize this cluster during
      ranking. Larger values indicate clusters that are more favorable for
      follow-up inspection.


   .. _OEBioisostere_OEBroodCluster_GetMembers:
   .. oe:method:: GetMembers

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            GetMembers() -> OEBroodHitVector

      This method returns a reference to the vector of member hits in the cluster.


   .. _OEBioisostere_OEBroodCluster_GetRank:
   .. oe:method:: GetRank

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

         .. oe:api::

            unsigned GetRank() const

      .. oe:language:: python

         .. oe:api:: python

            GetRank() -> int

      This method returns the rank assigned by
      :oe:meth:`Rank<OEBioisostere::OEBroodClusterBuilder::Rank>`.


   .. _OEBioisostere_OEBroodCluster_operator:
   .. oe:method:: operator

      .. oe:language:: c++

         .. oe:api::

            bool operator>(const OEBroodCluster& rhs) const

      This is a comparison operator for sorting clusters by interest score (higher
      interest ranks ahead of lower interest).

