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

.. oe:namespace:: OESz

.. meta::
   :keywords: OETorConstraintOptimizer


.. _OESz_OETorConstraintOptimizer:

.. oe:class:: OETorConstraintOptimizer

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OETorConstraintOptimizer

   This class provides an interface to perform an all-torsion-constrained optimization of a ligand molecule.

   .. seealso::

      * :ref:`OELigandOptResults <OESz_OELigandOptResults>` class

   The :ref:`OETorConstraintOptimizer <OESz_OETorConstraintOptimizer>` class defines the following public methods:
    * :oe:meth:`Setup<OESz::OETorConstraintOptimizer::Setup>`
    * :oe:meth:`Optimize<OESz::OETorConstraintOptimizer::Optimize>`


   .. oe:method:: Constructor

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

         .. oe:api::

            OETorConstraintOptimizer(const OETorConstraintOptOptions& opts = OETorConstraintOptOptions())
            OETorConstraintOptimizer(const OETorConstraintOptimizer&)

      .. oe:language:: python

         .. oe:api:: python

            OETorConstraintOptimizer(opts: OETorConstraintOptOptions = OETorConstraintOptOptions()) -> OETorConstraintOptimizer
            OETorConstraintOptimizer(arg2: OETorConstraintOptimizer) -> OETorConstraintOptimizer

      Default and copy constructors.


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

      .. oe:api::

         OETorConstraintOptimizer& operator=(const OETorConstraintOptimizer&)


.. _OESz_OETorConstraintOptimizer_Setup:

      Assignment operator.


   .. oe:method:: Setup

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

         .. oe:api::

            unsigned Setup(OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Setup(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Method to setup molecule for an all-torsions-constrained optimization



.. _OESz_OETorConstraintOptimizer_Optimize:

   .. oe:method:: Optimize

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

         .. oe:api::

            double Optimize(OEChem::OEMolBase& mol,
                            const OEChem::OETorsion& torsion) const
            double Optimize(OEChem::OEMolBase& mol) const
            unsigned Optimize(OELigandOptResults& res, OEChem::OEMolBase& mol,
                              const OEChem::OETorsion& torsion)
            unsigned Optimize(OELigandOptResults& res, OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Optimize(mol: Union[OEGraphMol,OEMol,OEQMol], torsion: OETorsion) -> float
            Optimize(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float
            Optimize(res: OELigandOptResults,
                     mol: Union[OEGraphMol,OEMol,OEQMol], torsion: OETorsion) -> int
            Optimize(res: OELigandOptResults,
                     mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Optimize the ligand. If an instance ref:`OELigandOptResults <OESz_OELigandOptResults` class is passed, it is populated
      with the results and a value from the :oe:constns:`OESz::OESzybkiReturnCode` namespace reporting the success or
      failure of the calculation is returned. Is not, the final optimized energy is returned.

