.. oe:namespace:: OESz

.. meta::
   :keywords: OEEntropyResults, EntropyResults


.. _OESz_OEEntropyResults:

.. oe:class:: OEEntropyResults

   .. oe:api::

      class OEEntropyResults

   Container for entropy estimation results returned by
   :oe:func:`OESz::OELigandEntropy` and :oe:func:`OESz::OEBoundLigandEntropy`.

   .. seealso::

      * :ref:`OEBoundEntropyOptions <OESz_OEBoundEntropyOptions>` class
      * :ref:`OELigandEntropyOptions <OESz_OELigandEntropyOptions>` class 
      * :oe:func:`OESz::OEBoundLigandEntropy` function
      * :oe:func:`OESz::OELigandEntropy` function
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEEntropyResults()
            OEEntropyResults(const OEEntropyResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEEntropyResults() -> OEEntropyResults
            OEEntropyResults(arg2: OEEntropyResults) -> OEEntropyResults

      Default and copy constructors.

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

      .. oe:api::

         OEEntropyResults& operator=(const OEEntropyResults&)

      Assignment operator.

   .. oe:method:: GetTotalEntropy in J/(mol K).
    
      .. oe:api::

         double GetTotalEntropy() const

      Returns the value of total ligand entropy. 

   .. oe:method:: GetConfigurationalEntropy

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

         .. oe:api::

            double GetConfigurationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfigurationalEntropy() -> float

      Returns the value of configurational entropy in J/(mol K).

   .. oe:method:: GetTranslationalEntropy

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

         .. oe:api::

            double GetTranslationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslationalEntropy() -> float

      Returns the value of translational entropy in J/(mol K).

   .. oe:method:: GetVibrationalRotationalEntropy

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

         .. oe:api::

            double GetVibrationalRotationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetVibrationalRotationalEntropy() -> float

      Returns a sum of vibrational and rotational entropy in J/(mol K).

   .. oe:method:: GetSolvationEntropy

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

         .. oe:api::

            double GetSolvationEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolvationEntropy() -> float

      Returns the value of solvation entropy in J/(mol K).

   .. oe:method:: SetResults

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

         .. oe:api::

            void SetResults(const double data[], unsigned int nterms = 4)

      .. oe:language:: python

         .. oe:api:: python

            SetResults([]: float, nterms: int = 4) -> None

      Allows to set the `OEEntropyResults <OESz_OEEntropyResults>` object with numeric
      values of entropy components by passing a pointer to the array of doubles in the
      following order: data[0]: total entropy, data[1] = translational entropy,
      data[2] = rotvib entropy and data[3]: solvation entropy
      
