.. oe:namespace:: OEShape


.. _OEShape_OEHermiteShapeFunc:

.. oe:class:: OEHermiteShapeFunc

   .. oe:api::

      class OEHermiteShapeFunc : public OEShapeFunc

   This class is derived from :ref:`OEShapeFunc <OEShape_OEShapeFunc>` and is used to approximate
   Tanimoto shape-similarity coefficient based on Hermite representation of molecules.

   .. _figure_OEHermiteShapeFunc_Hierarchy:

   .. figure:: ../images/OEHermiteShapeFunc.*
      :align:  center

   .. seealso::

      * :ref:`shapetk_hermite_section` section
      * :ref:`OEHermite <OEShape_OEHermite>` class
      * :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` class
      * :ref:`chapter_hermite_shape_examples` examples

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following methods are publicly inherited from :ref:`OEShapeFunc <OEShape_OEShapeFunc>`:
    * :oe:meth:`GetShapeOptions<OEShape::OEShapeFunc::GetShapeOptions>`

   The :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>` class defines the following public methods:
    * :oe:meth:`GetFitHermiteOptions<OEShape::OEHermiteShapeFunc::GetFitHermiteOptions>`
    * :oe:meth:`GetRefHermiteOptions<OEShape::OEHermiteShapeFunc::GetRefHermiteOptions>`

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEHermiteShapeFunc(const OEHermiteShapeFunc &)
            OEHermiteShapeFunc(const OEShapeOptions& argOptions = OEShapeOptions())
            OEHermiteShapeFunc(const OEHermiteOptions& HermOptRef,
                               const OEHermiteOptions& HermOptFit)
            OEHermiteShapeFunc(const OEShapeOptions& argOptions,
                               const OEHermiteOptions& HermOptRef,
                               const OEHermiteOptions& HermOptFit)

      .. oe:language:: python

         .. oe:api:: python

            OEHermiteShapeFunc(argOptions: OEShapeOptions = OEShapeOptions()) -> OEHermiteShapeFunc
            OEHermiteShapeFunc(HermOptRef: OEHermiteOptions,
                               HermOptFit: OEHermiteOptions) -> OEHermiteShapeFunc
            OEHermiteShapeFunc(argOptions: OEShapeOptions,
                               HermOptRef: OEHermiteOptions,
                               HermOptFit: OEHermiteOptions) -> OEHermiteShapeFunc
            OEHermiteShapeFunc(arg2: OEHermiteShapeFunc) -> OEHermiteShapeFunc

      The four constructors are in the respective order: a standard
      copy constructor, a constructor that inputs a
      :ref:`OEShapeOptions <OEShape_OEShapeOptions>` object, a constructor that
      inputs two :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` objects, one for
      reference and one for fit molecules, and finally a constructor
      that inputs :ref:`OEShapeOptions <OEShape_OEShapeOptions>` object along with
      two :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` objects, one for
      reference and one for fit molecules.

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

      .. oe:api::

         OEHermiteShapeFunc &operator=(const OEHermiteShapeFunc &)

      The assignment operator.

      Assignment operator.


   .. oe:method:: GetFitHermiteOptions

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

         .. oe:api::

            const OEHermiteOptions& GetFitHermiteOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitHermiteOptions() -> OEHermiteOptions

      This method returns :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` class currently being used for the fit molecule.

   .. oe:method:: GetRefHermiteOptions

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

         .. oe:api::

            const OEHermiteOptions& GetRefHermiteOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefHermiteOptions() -> OEHermiteOptions

      This method returns :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` class currently being used for the reference molecule.
