.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEShape


.. _OEShape_OEHermiteOptions:

.. oe:class:: OEHermiteOptions

   .. oe:api::

      class OEHermiteOptions

   This is an option class for the :ref:`OEHermite <OEShape_OEHermite>` class. It
   allows the user to input the level of the :ref:`Hermite expansion <shapetk_hermite_section>` 
   NPolyMax, the parameters :math:`\lambda_x, \lambda_y, \lambda_z`, and whether or not the
   parameters need to be optimized inside the :ref:`OEHermite <OEShape_OEHermite>` class.

   .. seealso::

      * :ref:`shapetk_hermite_section` section
      * :ref:`chapter_hermite_shape_examples` examples

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHermiteOptions()
            OEHermiteOptions(const OEHermiteOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEHermiteOptions() -> OEHermiteOptions
            OEHermiteOptions(arg2: OEHermiteOptions) -> OEHermiteOptions

      Default and copy constructors.

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

      .. oe:api::

         OEHermiteOptions &operator=(const OEHermiteOptions &)


.. _OEShape_OEHermiteOptions_GetLambdaX:

      Assignment operator.



   .. oe:method:: GetLambdaX

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

         .. oe:api::

            double GetLambdaX() const

      .. oe:language:: python

         .. oe:api:: python

            GetLambdaX() -> float

      Returns the value of the :math:`\lambda_x` parameter.

.. _OEShape_OEHermiteOptions_GetLambdaY:


   .. oe:method:: GetLambdaY

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

         .. oe:api::

            double GetLambdaY() const

      .. oe:language:: python

         .. oe:api:: python

            GetLambdaY() -> float

      Returns the value of the :math:`\lambda_y` parameter.

.. _OEShape_OEHermiteOptions_GetLambdaZ:


   .. oe:method:: GetLambdaZ

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

         .. oe:api::

            double GetLambdaZ() const

      .. oe:language:: python

         .. oe:api:: python

            GetLambdaZ() -> float

      Returns the value of the :math:`\lambda_z` parameter.

.. _OEShape_OEHermiteOptions_GetNPolyMax:


   .. oe:method:: GetNPolyMax

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

         .. oe:api::

            unsigned int GetNPolyMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetNPolyMax() -> int

      Returns the value of the NPolyMax parameter, which controls the level of
      Hermite expansion. In particular, the lowest value `0` corresponds to a
      very inaccurate expansion, approximating the entire molecule by a
      single Gaussian. In the limit NPolyMax :math:`\rightarrow \infty`,
      we obtain exact equivalence of the Hermite expansion to the original
      representation of the molecule.

.. _OEShape_OEHermiteOptions_GetUseOptimalLambdas:


   .. oe:method:: GetUseOptimalLambdas

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

         .. oe:api::

            bool GetUseOptimalLambdas() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseOptimalLambdas() -> bool

      When `UseOptimalLambdas` is `True`, the parameters :math:`\lambda_x, \lambda_y, \lambda_z`
      of the Hermite expansion will be chosen automatically based on the molecule input and 
      resolution of expansion. Alternatively, when `UseOptimalLambdas` is `False`, the 
      current values of the :math:`\,\lambda_{x,y,z}\,` parameters will be used instead. 
      Note that the Hermite expansion will converge regardless of the choice of 
      :math:`\,\lambda_{x,y,z}\,` as long as NPolyMax is high enough, 
      but in practice, at a given low resolution of Hermite expansion, it is useful
      to use optimal :math:`\,\lambda_{x,y,z}\,` parameters for faster convergence.

.. _OEShape_OEHermiteOptions_SetLambdaX:


   .. oe:method:: SetLambdaX

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

         .. oe:api::

            bool SetLambdaX(double)

      .. oe:language:: python

         .. oe:api:: python

            SetLambdaX(value: float) -> bool

      Sets the value of the :math:`\lambda_x` parameter. Default: `0.5`.

.. _OEShape_OEHermiteOptions_SetLambdaY:


   .. oe:method:: SetLambdaY

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

         .. oe:api::

            bool SetLambdaY(double)

      .. oe:language:: python

         .. oe:api:: python

            SetLambdaY(value: float) -> bool

      Sets the value of the :math:`\lambda_y` parameter. Default: `0.5`.

.. _OEShape_OEHermiteOptions_SetLambdaZ:


   .. oe:method:: SetLambdaZ

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

         .. oe:api::

            bool SetLambdaZ(double)

      .. oe:language:: python

         .. oe:api:: python

            SetLambdaZ(value: float) -> bool

      Sets the value of the :math:`\lambda_z` parameter. Default: `0.5`.

.. _OEShape_OEHermiteOptions_SetNPolyMax:


   .. oe:method:: SetNPolyMax

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

         .. oe:api::

            bool SetNPolyMax(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetNPolyMax(value: int) -> bool

      Sets the value of the NPolyMax parameter. Default: `4`.

.. _OEShape_OEHermiteOptions_SetUseOptimalLambdas:


   .. oe:method:: SetUseOptimalLambdas

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

         .. oe:api::

            bool SetUseOptimalLambdas(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseOptimalLambdas(value: bool) -> bool

      Sets the value of the `UseOptimalLambdas` parameter. Default: `True`.
