
.. _section_szybki_releasenotes_182:

Szybki TK 1.8.2
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OESz::OEEstimateSolvFreeEnergy` and
  :oe:func:`OESz::OEEstimateConfFreeEnergies` added to perform FreeForm
  calculations. Their usage requires passing instances of the
  following classes:

  - :ref:`OEFreeFormSolvOptions <OESz_OEFreeFormSolvOptions>`
  - :ref:`OEFreeFormConfOptions <OESz_OEFreeFormConfOptions>`
  - :ref:`OEFreeFormSolvResults <OESz_OEFreeFormSolvResults>`
  - :ref:`OEFreeFormConfResults <OESz_OEFreeFormConfResults>`

* ``OEOpt::OEFunc1::CheckVariablesValidity`` added for checking
  the validity of arguments for the function to be optimized.  The
  users of the all classes derived from :ref:`OEFunc1 <OEOpt_OEFunc1>` can
  implement it according to specific features of their objective
  functions.

* ``OESz::OESzybki::GetSolutionEntropy`` and
  ``OESz::OESzybki::GetProteinBoundLigandEntropy`` have been
  officially deprecated. :oe:meth:`OESz::OESzybki::GetEntropy` that
  returns ``double`` values by reference has also been
  deprecated. Users should switch to using the
  :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` object instead.

Major bug fixes
--------------------------------------------------------------------------------

* Dangling pointer in the implementation of the :oe:meth:`OESz::OESzybki::UnsetProtein`
  has been found and fixed. 

* Setting up a Newton-Raphson optimization on large systems can easily
  exhaust the amount of memory needed because of the O(n^2) Hessian
  matrix. If memory exhaustion is detected, the calculation will now
  error out instead of crashing.

* An exception has been added to catch the memory exhaustion upon Hessian allocation
  used for Newton-Raphson optimization of large systems. That could happen on some
  platforms with limited memory (for example Win32).

.. oe:language:: python java csharp
   
   * :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` can now be passed to the
     :ref:`OESzybki <OESz_OESzybki>` constructor.

   * :oe:constns:`OESz::OEProtFlex` namespace constants are now
     available in Python, Java, and C#. 

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations.

* Verbose mode of some protein-ligand optimization could not report the number of
  cycles at the very end of optimization.

* Warning is issued upon the attempt to remove Coulomb terms from the
  combined force field Amber-MMFF (and Amber-MMFFS) with methods
  ``OESz::OESzybki::SetRemoveCoulombTerms`` and
  ``OESz::OESzybkiOptions::SetRemoveCoulombTerms``.

* Unnecessary and confusing warning ``Warning: Solid-body optimization
  allowed only for ligand in fixed protein`` is eliminated when
  :oe:meth:`OESz::OESzybkiOptions::SetRunType` is used with the
  :oe:const:`OESz::OERunType::SolidBodyOpt` argument.

Documentation fixes
--------------------------------------------------------------------------------

* Examples added to demonstrate how to do an entropy estimation. 

* Examples have been updated to use non-deprecated APIs. 

.. oe:language:: python
   
   * Python examples have been renamed to more accurately reflect
     their function. Some examples added to demonstrate additional
     functionality.
