leaspy.algo.algo_with_annealing
===============================

.. py:module:: leaspy.algo.algo_with_annealing


Classes
-------

.. autoapisummary::

   leaspy.algo.algo_with_annealing.AlgorithmWithAnnealingMixin


Module Contents
---------------

.. py:class:: AlgorithmWithAnnealingMixin(settings)

   
   Mixin class to use in algorithms that requires `temperature_inv`.

   Note that this mixin should be used with a class inheriting from `AbstractAlgo`, which must have `algo_parameters`
   attribute.

   :Parameters:

       **settings** : :class:`.AlgorithmSettings`
           The specifications of the algorithm as a :class:`.AlgorithmSettings` instance.
           
           Please note that you can customize the number of iterations with annealing by setting:
                * `annealing.n_iter_frac`, such that iterations with annealing is a ratio of algorithm `n_iter` (default = 50%)

   :Attributes:

       **annealing_on** : :obj:`bool`
           Activates annealing.

       **temperature** : float >= 1
           ..

       **temperature_inv** : float in [0, 1]
           Temperature and its inverse when using annealing













   ..
       !! processed by numpydoc !!

   .. py:attribute:: temperature
      :type:  float
      :value: 1.0



   .. py:attribute:: temperature_inv
      :type:  float
      :value: 1.0



   .. py:attribute:: annealing_on
      :type:  bool