.. oe:namespace:: OEChem

.. meta::
   :keywords: OESimilarByRMSD, SimilarByRMSD


.. _OEChem_OESimilarByRMSD:

.. oe:class:: OESimilarByRMSD

   .. oe:api::

      class OESimilarByRMSD : public OESystem::OEBinaryPredicate<OEChem::OEConfBase, OEChem::OEConfBase>

   This class represents `SimilarByRMSD`, a functor that identifies if two conformers (:ref:`OEConfBase <OEChem_OEConfBase>`)
   are similar.

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================== ==============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>`  :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`
   ============================================================== ==============================================================
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESimilarByRMSD(const OESimilarByRMSD&)
            OESimilarByRMSD(const double rmsd)

      .. oe:language:: python

         .. oe:api:: python

            OESimilarByRMSD(argRmsd: float) -> OESimilarByRMSD
            OESimilarByRMSD(argPredicate: OESimilarByRMSD) -> OESimilarByRMSD

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESimilarByRMSD &operator=(const OESimilarByRMSD&)

      Assignment operator.


   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEConfBase& conf1, const OEChem::OEConfBase& conf2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(argConf1: OEConfBase, argConf2: OEConfBase) -> bool

      Returns ``true``, if the two specified conformers are similar within the specified RMSD, i.e.,
      if the RMSD between the two conformers is smaller or equal to the specified value.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEBinaryFunction<OEChem::OEConfBase, OEChem::OEConfBase, bool> * CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESimilarByRMSD

      Deep copy constructor that returns a copy of the object.
      The memory for the returned `OESimilarByRMSD` 
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 
