.. oe:namespace:: OEGraphSim



.. meta::
   :keywords: OESimScore, SimScore


.. _OEGraphSim_OESimScore:

.. oe:class:: OESimScore

   .. oe:api::

      class OESimScore

   This class represents :ref:`OESimScore <OEGraphSim_OESimScore>` that holds a
   similarity value with an index that identifies the fingerprint in
   the :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object from which the score
   is calculated.

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFPDatabase::GetScores`
      * :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores`


   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OESimScore(size_t i, double s)

      .. oe:language:: python

         .. oe:api:: python

            OESimScore(i: int, s: float) -> OESimScore

      Initializes an :ref:`OESimScore <OEGraphSim_OESimScore>` from an index ``i``
      and a score ``s``.


   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetIdx

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

         .. oe:api::

            size_t GetIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdx() -> int

      Returns the index of the fingerprint corresponding to the
      similarity score.


   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetScore

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

         .. oe:api::

            double GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> float

      Returns the similarity score of the fingerprint corresponding to the
      index.
