.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMCSSimFuncBase, MCSSimFuncBase


.. _OEMedChem_OEMCSSimFuncBase:

.. oe:class:: OEMCSSimFuncBase

   .. oe:api::

      class OEMCSSimFuncBase

   :ref:`OEMCSSimFuncBase <OEMedChem_OEMCSSimFuncBase>` is an abstract base class which
   defines the interface necessary to perform similarity calculations
   that populate :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` objects.

   The following classes derive from this class:
    * :ref:`OEMCSTanimotoSim <OEMedChem_OEMCSTanimotoSim>`
    * :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>`

   .. seealso::

      * :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class
      * :oe:meth:`OEMedChem::OEMCSFragDatabase::GetScores` class
      * :oe:meth:`OEMedChem::OEMCSFragDatabase::GetSortedScores` class

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMCSSimFuncBase()

      .. oe:language:: python

         .. oe:api:: python

            OEMCSSimFuncBase() -> OEMCSSimFuncBase

   Default constructor.

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

   .. oe:method:: operator()

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

         .. oe:api::

            double operator() (unsigned int commonAB, unsigned int totalA, unsigned int totalB) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(commonAB: int, totalA: int, totalB: int) -> float

   Virtual *const* operator that takes three count values and computes
   the similarity value.  Depending on the method, the counts
   provided may be either the atom or bond counts for the MCS core,
   query molecule and indexed molecule.

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

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEMCSSimFuncBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMCSSimFuncBase

   :oe:meth:`OEMedChem::OEMCSSimFuncBase::CreateCopy` is a virtual
   constructor which allows copying of concrete derived objects using
   a reference to this base class.

   .. oe:method:: GetMCSSimTypeString

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

         .. oe:api::

            std::string GetMCSSimTypeString() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSSimTypeString() -> str

   Returns a string representation of the concrete derived class.
