.. oe:namespace:: OEGraphSim



.. meta::
   :keywords: OESimFuncBase, SimFuncBase


.. _OEGraphSim_OESimFuncBase:

.. oe:class:: OESimFuncBase

   .. oe:api::

      class OESimFuncBase

   :ref:`OESimFuncBase <OEGraphSim_OESimFuncBase>` is an abstract base class which
   defines the interface necessary to perform similarity calculations
   of :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   .. seealso::

      * :ref:`section_measure_user_defined` section


   The following classes derive from this class:

    * :ref:`OETanimotoSim <OEGraphSim_OETanimotoSim>`
    * :ref:`OETverskySim <OEGraphSim_OETverskySim>`


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

   .. oe:method:: Constructors

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

         .. oe:api::

            OESimFuncBase()

      .. oe:language:: python

         .. oe:api:: python

            OESimFuncBase() -> OESimFuncBase

      Default constructor.


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

   .. oe:method:: operator()

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

         .. oe:api::

            float operator()(const OEGraphSim::OEFingerPrint& fpA, const OEGraphSim::OEFingerPrint& fpB) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(fpA: OEFingerPrint, fpB: OEFingerPrint) -> float

   Virtual *const* operator that takes two
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects and returns their
   evaluated similarity value.


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

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESimFuncBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESimFuncBase

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


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

   .. oe:method:: GetSimTypeString

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

         .. oe:api::

            std::string GetSimTypeString() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetSimTypeString() -> str

   Returns a string representation of the concrete derived class.
