..
   Generated automatically by cpp2rst

.. highlight:: c
.. role:: red
.. role:: green
.. role:: param


.. _triqs__mc_tools__mc_generic__warmup_and_accumulate:

triqs::mc_tools::mc_generic::warmup_and_accumulate
==================================================

*#include <triqs/mc_tools/mc_generic.hpp>*



**Synopsis**

 .. rst-class:: cppsynopsis

       | int :red:`warmup_and_accumulate` (int64_t :param:`n_warmup_cycles`,
       |                        int64_t :param:`n_accumulation_cycles`,
       |                        int64_t :param:`length_cycle`,
       |                        std::function<bool ()> :param:`stop_callback`,
       |                        MCSignType :param:`sign_init`,
       |                        :ref:`communicator <mpi__communicator>` :param:`c` = mpi::communicator{})





Warmup the Monte-Carlo configuration and accumulate/measure





Parameters
^^^^^^^^^^

 * :param:`n_warmup_cycles`         Number of QMC cycles in the warmup

 * :param:`n_accumulation_cycles`   Number of QMC cycles in the accumulation (measures are done after each cycle).
                                If negative, the accumulation is done until the stop_callback returns true or signal is received.

 * :param:`length_cycle`            Number of QMC move attempts in one cycle

 * :param:`stop_callback`           A callback function () -> bool. It is called after each cycle
                                to and the computation stops when it returns true.
                                Typically used to set up the time limit, cf doc.

 * :param:`sign_init`               The sign of the initial configuration's weight [optional]


Returns
^^^^^^^

    =  =============================================
    0  if the computation has run until the end
    1  if it has been stopped by stop_callback
    2  if it has been stopped by receiving a signal
    =  =============================================