.. oe:namespace:: OEGraphSim


.. meta::
   :keywords: OESimScorePair, SimScorePair


.. _OEGraphSim_OESimScorePair:

.. oe:class:: OESimScorePair

   .. oe:api::

      class OESimScorePair

   This class represents :ref:`OESimScorePair <OEGraphSim_OESimScorePair>` that holds a
   similarity scores with an index ``i`` and an index ``j`` that identifies
   the fingerprints in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object from an
   :math:`NxN` similarity calculation with
   :oe:meth:`OEGraphSim::OEFastFPDatabase::GetSparseMatrix`.

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetSparseMatrix`


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

   .. oe:method:: Constructors

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

         .. oe:api::

            OESimScorePair(size_t i, size_t j, double s)

      .. oe:language:: python

         .. oe:api:: python

            OESimScorePair(i: int, j: int, s: float) -> OESimScorePair

      Initializes an :ref:`OESimScorePair <OEGraphSim_OESimScorePair>` from an
      index ``i``, an index ``j`` and a score ``s``.


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

   .. oe:method:: GetIdxA

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

         .. oe:api::

            size_t GetIdxA() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdxA() -> int

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

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

   .. oe:method:: GetIdxB

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

         .. oe:api::

            size_t GetIdxB() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdxB() -> int

      Returns the index ``j`` 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 ``i`` and index ``j`` fingerprints.
