..
   Generated automatically by cpp2rst

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


.. _triqs__stat__histogram:

triqs::stat::histogram
======================

*#include <triqs/stat.hpp>*

.. rst-class:: cppsynopsis

      class  :red:`histogram`

This class serves to sample a continuous random variable, and to 'bin' it.
It divides a given range of real values into a series of equal intervals,
and counts amounts of samples falling into each interval.
The histogram keeps track of the total number of the sampled values, as well
as of the lost samples that lie outside the chosen range.


Member functions
----------------

.. table::
   :widths: 40 60


   +------------------------------------------------------------+--------------------------------------+
   | :ref:`(constructor) <triqs__stat__histogram__constructor>` |                                      |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`operator\<\< <triqs__stat__histogram__operatorLTLT>` | Bin a real value into the histogram  |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`mesh_point <triqs__stat__histogram__mesh_point>`     | Get position of bin's center         |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`size <triqs__stat__histogram__size>`                 | Get number of histogram bins         |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`limits <triqs__stat__histogram__limits>`             | Get boundaries of the histogram      |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`data <triqs__stat__histogram__data>`                 | Read-only access to the data storage |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`n_data_pts <triqs__stat__histogram__n_data_pts>`     | Get number of accumulated samples    |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`n_lost_pts <triqs__stat__histogram__n_lost_pts>`     | Get number of discarded samples      |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`clear <triqs__stat__histogram__clear>`               | Reset all histogram values to 0      |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`hdf5_format <triqs__stat__histogram__hdf5_format>`   | Get HDF5 format name                 |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`operator== <triqs__stat__histogram__operator==>`     |                                      |
   +------------------------------------------------------------+--------------------------------------+
   | :ref:`serialize <triqs__stat__histogram__serialize>`       | Serialize Histogram                  |
   +------------------------------------------------------------+--------------------------------------+

.. toctree::
    :hidden:

    histogram/constructor
    histogram/operator<<
    histogram/mesh_point
    histogram/size
    histogram/limits
    histogram/data
    histogram/n_data_pts
    histogram/n_lost_pts
    histogram/clear
    histogram/hdf5_format
    histogram/operator==
    histogram/serialize


Non Member functions
--------------------

.. table::
   :widths: 40 60


   +--------------------------------------------------------------+--------------------------+
   | :ref:`operator+ <triqs__stat__histogram__operator+>`         | Addition of histograms   |
   +--------------------------------------------------------------+--------------------------+
   | :ref:`mpi_broadcast <triqs__stat__histogram__mpi_broadcast>` | MPI-broadcast histogram  |
   +--------------------------------------------------------------+--------------------------+
   | :ref:`mpi_reduce <triqs__stat__histogram__mpi_reduce>`       | MPI-reduce histogram     |
   +--------------------------------------------------------------+--------------------------+
   | :ref:`h5_write <triqs__stat__histogram__h5_write>`           | Write histogram to HDF5  |
   +--------------------------------------------------------------+--------------------------+
   | :ref:`h5_read <triqs__stat__histogram__h5_read>`             | Read histogram form HDF5 |
   +--------------------------------------------------------------+--------------------------+
   | :ref:`operator\<\< <triqs__stat__histogram__operatorLTLT>`   | Output stream insertion  |
   +--------------------------------------------------------------+--------------------------+

.. toctree::
    :hidden:

    histogram/operator+
    histogram/mpi_broadcast
    histogram/mpi_reduce
    histogram/h5_write
    histogram/h5_read
    histogram/operator<<