OptimizationAlgorithm
=====================

.. currentmodule:: optking.stepAlgorithms

.. autoclass:: OptimizationAlgorithm
   :show-inheritance:

   .. rubric:: Methods Summary

   .. autosummary::

      ~OptimizationAlgorithm.apply_interfrag_step_scaling
      ~OptimizationAlgorithm.apply_intrafrag_step_scaling
      ~OptimizationAlgorithm.assess_previous_step
      ~OptimizationAlgorithm.backstep
      ~OptimizationAlgorithm.backstep_needed
      ~OptimizationAlgorithm.converged
      ~OptimizationAlgorithm.decrease_trust_radius
      ~OptimizationAlgorithm.expected_energy
      ~OptimizationAlgorithm.increase_trust_radius
      ~OptimizationAlgorithm.requires
      ~OptimizationAlgorithm.step
      ~OptimizationAlgorithm.supports_trust_region
      ~OptimizationAlgorithm.take_step
      ~OptimizationAlgorithm.update_history

   .. rubric:: Methods Documentation

   .. automethod:: apply_interfrag_step_scaling
   .. automethod:: apply_intrafrag_step_scaling
   .. automethod:: assess_previous_step
   .. automethod:: backstep
   .. automethod:: backstep_needed
   .. automethod:: converged
   .. automethod:: decrease_trust_radius
   .. automethod:: expected_energy
   .. automethod:: increase_trust_radius
   .. automethod:: requires
   .. automethod:: step
   .. automethod:: supports_trust_region
   .. automethod:: take_step
   .. automethod:: update_history