Generated documentation for triqs/unstable

jenkins-TRIQS-triqs-unstable-1051 3547a0a4bace09ae1035ed7d381f2691384f5c7a

triqs/unstable/_sources/documentation/cpp_api/itertools/enum_iter/operator==.rst.txt

@@ -48,4 +48,4 @@ Parameters
 Returns
 ^^^^^^^
 
-True, if the original iterators are equal.
+True, if the original iterator is equal to the iterator stored in the sentinel.

triqs/unstable/_sources/documentation/cpp_api/itertools/iterator_facadeLTIter,Value,std::forward_iterator_tag,Reference,DifferenceGT/operator++.rst.txt

@@ -33,4 +33,4 @@ Documentation
 Returns
 ^^^^^^^
 
-Reference to the derived iterator after calling the derived iterator's `increment()` function.
+Copy of the derived iterator before calling the derived iterator's `increment()` function.

triqs/unstable/_sources/documentation/cpp_api/itertools/prod_iter/operator==.rst.txt

@@ -48,4 +48,4 @@ Parameters
 Returns
 ^^^^^^^
 
-True, if the first iterator, i.e. `std::get<0>(its)`, is equal to the iterator of the sentinel.
+True, if all original iterators are equal.

triqs/unstable/_sources/documentation/cpp_api/itertools/transform_iter/operator==.rst.txt

@@ -48,4 +48,4 @@ Parameters
 Returns
 ^^^^^^^
 
-True, if the original iterators are equal.
+True, if the original iterator is equal to the iterator stored in the sentinel.

triqs/unstable/_sources/documentation/cpp_api/itertools/zip_iter/operator==.rst.txt

@@ -48,4 +48,4 @@ Parameters
 Returns
 ^^^^^^^
 
-True, if one of the original iterators is equal to the corresponding iterator of the sentinel.
+True, if all original iterators are equal.

triqs/unstable/_sources/documentation/cpp_api/mpi/mpi_gather.rst.txt

@@ -54,4 +54,4 @@ Parameters
 Returns
 ^^^^^^^
 
-std::string containing the result of the gather operation.
+std::vector containing the result of the gather operation.

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/<deduction guide for block_gf>.rst.txt

@@ -20,8 +20,8 @@ triqs::gfs::<deduction guide for block_gf>
 
  .. rst-class:: cppsynopsis
 
-       | :green:`template<typename Mesh, typename Target>`
-       | block_gf<Mesh, Target, 1> :red:`<deduction guide for block_gf>` (std::vector<gf<Mesh, Target>> )
+       | :green:`template<typename Mesh, typename Target, typename Layout>`
+       | block_gf<Mesh, Target, Layout, 1> :red:`<deduction guide for block_gf>` (std::vector<gf<Mesh, Target, Layout>> )
 
 
 

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/block_gf.rst.txt

@@ -16,7 +16,7 @@ triqs::gfs::block_gf
 
 .. rst-class:: cppsynopsis
 
-     template<typename Mesh, typename Target, int Arity> class  :red:`block_gf`
+     template<typename Mesh, typename Target, typename Layout, int Arity> class  :red:`block_gf`
 
 ---------------------------  implementation  ---------------------------------
 
@@ -45,17 +45,17 @@ Member types
    +-------------------+-------------------------------------------------------------------------------------------------+---------------------------+
    | target_t          | Target                                                                                          |                           |
    +-------------------+-------------------------------------------------------------------------------------------------+---------------------------+
-   | regular_type      | block_gf<Mesh, Target, Arity>                                                                   |                           |
+   | regular_type      | block_gf<Mesh, Target, Layout, Arity>                                                           |                           |
    +-------------------+-------------------------------------------------------------------------------------------------+---------------------------+
-   | mutable_view_type | block_gf_view<Mesh, Target, Arity>                                                              |                           |
+   | mutable_view_type | block_gf_view<Mesh, Target, typename Layout::with_lowest_guarantee_t, Arity>                    |                           |
    +-------------------+-------------------------------------------------------------------------------------------------+---------------------------+
-   | view_type         | block_gf_view<Mesh, Target, Arity, false>                                                       |                           |
+   | view_type         | block_gf_view<Mesh, Target, typename Layout::with_lowest_guarantee_t, Arity, false>             |                           |
    +-------------------+-------------------------------------------------------------------------------------------------+---------------------------+
-   | const_view_type   | block_gf_view<Mesh, Target, Arity, true>                                                        |                           |
+   | const_view_type   | block_gf_view<Mesh, Target, typename Layout::with_lowest_guarantee_t, Arity, true>              |                           |
    +-------------------+-------------------------------------------------------------------------------------------------+---------------------------+
-   | real_t            | block_gf<Mesh, typename Target::real_t, Arity>                                                  |  The associated real type |
+   | real_t            | block_gf<Mesh, typename Target::real_t, Layout, Arity>                                          |  The associated real type |
    +-------------------+-------------------------------------------------------------------------------------------------+---------------------------+
-   | g_t               | gf<Mesh, Target>                                                                                |                           |
+   | g_t               | gf<Mesh, Target, Layout>                                                                        |                           |
    +-------------------+-------------------------------------------------------------------------------------------------+---------------------------+
    | data_t            | std::conditional_t<Arity == 1, std::vector<g_t>, std::vector<std::vector<g_t>>>                 |                           |
    +-------------------+-------------------------------------------------------------------------------------------------+---------------------------+

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/block_gf/constructor.rst.txt

@@ -20,16 +20,16 @@ triqs::gfs::block_gf::constructor
 
  .. rst-class:: cppsynopsis
 
-    1. | :red:`block_gf` (block_gf<Mesh, Target, Arity> const & :param:`x`)
+    1. | :red:`block_gf` (block_gf<Mesh, Target, Layout, Arity> const & :param:`x`)
 
-    2. | :red:`block_gf` (block_gf<Mesh, Target, Arity> && )
+    2. | :red:`block_gf` (block_gf<Mesh, Target, Layout, Arity> && )
 
     3. | :red:`block_gf` (block_names_t :param:`b`, data_t :param:`d`)
 
     4. | :red:`block_gf` ()
 
-    5. | :green:`template<bool IsConst2>`
-       | :red:`block_gf` (block_gf_view<Mesh, Target, Arity, IsConst2> const & :param:`g`)
+    5. | :green:`template<typename L, bool Cnst>`
+       | :red:`block_gf` (block_gf_view<Mesh, Target, L, Arity, Cnst> const & :param:`g`)
 
     6. | :green:`template<typename G>`
        | :red:`block_gf` (G const & :param:`x`)

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/block_gf/operator=.rst.txt

@@ -20,12 +20,12 @@ triqs::gfs::block_gf::operator=
 
  .. rst-class:: cppsynopsis
 
-    1. | block_gf<Mesh, Target, Arity> & :red:`operator=` (block_gf<Mesh, Target, Arity> const & :param:`rhs`)
+    1. | block_gf<Mesh, Target, Layout, Arity> & :red:`operator=` (block_gf<Mesh, Target, Layout, Arity> const & :param:`rhs`)
 
-    2. | block_gf<Mesh, Target, Arity> & :red:`operator=` (lazy<tag::reduce, block_gf<Mesh, Target, Arity>::const_view_type> :param:`l`)
+    2. | block_gf<Mesh, Target, Layout, Arity> & :red:`operator=` (lazy<tag::reduce, block_gf<Mesh, Target, Layout, Arity>::const_view_type> :param:`l`)
 
     3. | :green:`template<typename RHS>`
-       | block_gf<Mesh, Target, Arity> & :red:`operator=` (RHS && :param:`rhs`)
+       | block_gf<Mesh, Target, Layout, Arity> & :red:`operator=` (RHS && :param:`rhs`)
 
 Documentation
 

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/inverse.rst.txt

@@ -20,13 +20,13 @@ triqs::gfs::inverse
 
  .. rst-class:: cppsynopsis
 
-    1. | :green:`template<typename M, typename T, int A>`
-       | auto :red:`inverse` (:ref:`block_gf\<M, T, A\> <triqs__gfs__block_gf>` & :param:`g`)
+    1. | :green:`template<typename M, typename T, typename L, int A>`
+       | auto :red:`inverse` (:ref:`block_gf\<M, T, L, A\> <triqs__gfs__block_gf>` & :param:`g`)
 
-    2. | :green:`template<typename M, typename T, int A>`
-       | auto :red:`inverse` (:ref:`block_gf\<M, T, A\> <triqs__gfs__block_gf>` const & :param:`g`)
+    2. | :green:`template<typename M, typename T, typename L, int A>`
+       | auto :red:`inverse` (:ref:`block_gf\<M, T, L, A\> <triqs__gfs__block_gf>` const & :param:`g`)
 
-    3. | :green:`template<typename M, typename T, int A, bool C>`
-       | auto :red:`inverse` (block_gf_view<M, T, A, C> :param:`g`)
+    3. | :green:`template<typename M, typename T, typename L, int A, bool C>`
+       | auto :red:`inverse` (block_gf_view<M, T, L, A, C> :param:`g`)
 
 Documentation

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/make_block2_gf.rst.txt

@@ -20,8 +20,8 @@ triqs::gfs::make_block2_gf
 
  .. rst-class:: cppsynopsis
 
-       | :green:`template<typename V, typename T>`
-       | block2_gf<V, T> :red:`make_block2_gf` (int :param:`n`, int :param:`p`, :ref:`gf\<V, T\> <triqs__gfs__gf>` const & :param:`g`)
+       | :green:`template<typename V, typename T, typename L>`
+       | block2_gf<V, T, L> :red:`make_block2_gf` (int :param:`n`, int :param:`p`, :ref:`gf\<V, T, L\> <triqs__gfs__gf>` const & :param:`g`)
 
 
 

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/make_block_gf.rst.txt

@@ -20,25 +20,25 @@ triqs::gfs::make_block_gf
 
  .. rst-class:: cppsynopsis
 
-    1. | :green:`template<typename V, typename T>`
-       | :ref:`block_gf\<V, T\> <triqs__gfs__block_gf>` :red:`make_block_gf` (int :param:`n`, :ref:`gf\<V, T\> <triqs__gfs__gf>` const & :param:`g`)
+    1. | :green:`template<typename V, typename T, typename L>`
+       | :ref:`block_gf\<V, T, L\> <triqs__gfs__block_gf>` :red:`make_block_gf` (int :param:`n`, :ref:`gf\<V, T, L\> <triqs__gfs__gf>` const & :param:`g`)
 
-    2. | :green:`template<typename V, typename T>`
-       | :ref:`block_gf\<V, T\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::vector<gf<V, T>> :param:`v`)
+    2. | :green:`template<typename V, typename T, typename L>`
+       | :ref:`block_gf\<V, T, L\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::vector<gf<V, T, L>> :param:`v`)
 
-    3. | :green:`template<typename V, typename T>`
-       | :ref:`block_gf\<V, T\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::initializer_list<gf<V, T>> const & :param:`v`)
+    3. | :green:`template<typename V, typename T, typename L>`
+       | :ref:`block_gf\<V, T, L\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::initializer_list<gf<V, T, L>> const & :param:`v`)
 
-    4. | :green:`template<typename V, typename T>`
-       | :ref:`block_gf\<V, T\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::vector<std::string> const & :param:`b`,
-       |                :ref:`gf\<V, T\> <triqs__gfs__gf>` const & :param:`g`)
+    4. | :green:`template<typename V, typename T, typename L>`
+       | :ref:`block_gf\<V, T, L\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::vector<std::string> const & :param:`b`,
+       |                :ref:`gf\<V, T, L\> <triqs__gfs__gf>` const & :param:`g`)
 
-    5. | :green:`template<typename V, typename T>`
-       | :ref:`block_gf\<V, T\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::vector<std::string> const & :param:`b`,
-       |                std::vector<gf<V, T>> :param:`v`)
+    5. | :green:`template<typename V, typename T, typename L>`
+       | :ref:`block_gf\<V, T, L\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::vector<std::string> const & :param:`b`,
+       |                std::vector<gf<V, T, L>> :param:`v`)
 
-    6. | :green:`template<typename V, typename T>`
-       | :ref:`block_gf\<V, T\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::vector<std::string> :param:`b`,
-       |                std::initializer_list<gf<V, T>> const & :param:`v`)
+    6. | :green:`template<typename V, typename T, typename L>`
+       | :ref:`block_gf\<V, T, L\> <triqs__gfs__block_gf>` :red:`make_block_gf` (std::vector<std::string> :param:`b`,
+       |                std::initializer_list<gf<V, T, L>> const & :param:`v`)
 
 Documentation

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/make_gf_from_fourier.rst.txt

@@ -20,13 +20,13 @@ triqs::gfs::make_gf_from_fourier
 
  .. rst-class:: cppsynopsis
 
-    1. | :green:`template<typename M, typename T, int A>`
-       | auto :red:`make_gf_from_fourier` (:ref:`block_gf\<M, T, A\> <triqs__gfs__block_gf>` & :param:`g`)
+    1. | :green:`template<typename M, typename T, typename L, int A>`
+       | auto :red:`make_gf_from_fourier` (:ref:`block_gf\<M, T, L, A\> <triqs__gfs__block_gf>` & :param:`g`)
 
-    2. | :green:`template<typename M, typename T, int A>`
-       | auto :red:`make_gf_from_fourier` (:ref:`block_gf\<M, T, A\> <triqs__gfs__block_gf>` const & :param:`g`)
+    2. | :green:`template<typename M, typename T, typename L, int A>`
+       | auto :red:`make_gf_from_fourier` (:ref:`block_gf\<M, T, L, A\> <triqs__gfs__block_gf>` const & :param:`g`)
 
-    3. | :green:`template<typename M, typename T, int A, bool C>`
-       | auto :red:`make_gf_from_fourier` (block_gf_view<M, T, A, C> :param:`g`)
+    3. | :green:`template<typename M, typename T, typename L, int A, bool C>`
+       | auto :red:`make_gf_from_fourier` (block_gf_view<M, T, L, A, C> :param:`g`)
 
 Documentation

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/make_gf_from_inverse_fourier.rst.txt

@@ -20,13 +20,13 @@ triqs::gfs::make_gf_from_inverse_fourier
 
  .. rst-class:: cppsynopsis
 
-    1. | :green:`template<typename M, typename T, int A>`
-       | auto :red:`make_gf_from_inverse_fourier` (:ref:`block_gf\<M, T, A\> <triqs__gfs__block_gf>` & :param:`g`)
+    1. | :green:`template<typename M, typename T, typename L, int A>`
+       | auto :red:`make_gf_from_inverse_fourier` (:ref:`block_gf\<M, T, L, A\> <triqs__gfs__block_gf>` & :param:`g`)
 
-    2. | :green:`template<typename M, typename T, int A>`
-       | auto :red:`make_gf_from_inverse_fourier` (:ref:`block_gf\<M, T, A\> <triqs__gfs__block_gf>` const & :param:`g`)
+    2. | :green:`template<typename M, typename T, typename L, int A>`
+       | auto :red:`make_gf_from_inverse_fourier` (:ref:`block_gf\<M, T, L, A\> <triqs__gfs__block_gf>` const & :param:`g`)
 
-    3. | :green:`template<typename M, typename T, int A, bool C>`
-       | auto :red:`make_gf_from_inverse_fourier` (block_gf_view<M, T, A, C> :param:`g`)
+    3. | :green:`template<typename M, typename T, typename L, int A, bool C>`
+       | auto :red:`make_gf_from_inverse_fourier` (block_gf_view<M, T, L, A, C> :param:`g`)
 
 Documentation

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/mpi_reduce.rst.txt

@@ -20,15 +20,15 @@ triqs::gfs::mpi_reduce
 
  .. rst-class:: cppsynopsis
 
-    1. | :green:`template<typename V, typename T, int Arity>`
-       | lazy<tag::reduce, block_gf_const_view<V, T, Arity>> :red:`mpi_reduce` (:ref:`block_gf\<V, T, Arity\> <triqs__gfs__block_gf>` const & :param:`a`,
+    1. | :green:`template<typename V, typename T, typename Layout, int Arity>`
+       | lazy<tag::reduce, typename block_gf<V, T, Layout, Arity>::const_view_type> :red:`mpi_reduce` (:ref:`block_gf\<V, T, Layout, Arity\> <triqs__gfs__block_gf>` const & :param:`a`,
        |             :ref:`communicator <mpi__communicator>` :param:`c` = {},
        |             int :param:`root` = 0,
        |             bool :param:`all` = false,
        |             MPI_Op :param:`op` = MPI_SUM)
 
-    2. | :green:`template<typename V, typename T, int Arity, bool IsConst>`
-       | lazy<tag::reduce, block_gf_const_view<V, T, Arity>> :red:`mpi_reduce` (block_gf_view<V, T, Arity, IsConst> const & :param:`a`,
+    2. | :green:`template<typename V, typename T, typename Layout, int Arity, bool IsConst>`
+       | lazy<tag::reduce, block_gf_const_view<V, T, Layout, Arity>> :red:`mpi_reduce` (block_gf_view<V, T, Layout, Arity, IsConst> const & :param:`a`,
        |             :ref:`communicator <mpi__communicator>` :param:`c` = {},
        |             int :param:`root` = 0,
        |             bool :param:`all` = false,

triqs/unstable/_sources/documentation/cpp_api/triqs/gfs/reinterpret_scalar_valued_gf_as_matrix_valued.rst.txt

@@ -20,13 +20,13 @@ triqs::gfs::reinterpret_scalar_valued_gf_as_matrix_valued
 
  .. rst-class:: cppsynopsis
 
-    1. | :green:`template<typename M, typename T, int A>`
-       | auto :red:`reinterpret_scalar_valued_gf_as_matrix_valued` (:ref:`block_gf\<M, T, A\> <triqs__gfs__block_gf>` & :param:`g`)
+    1. | :green:`template<typename M, typename T, typename L, int A>`
+       | auto :red:`reinterpret_scalar_valued_gf_as_matrix_valued` (:ref:`block_gf\<M, T, L, A\> <triqs__gfs__block_gf>` & :param:`g`)
 
-    2. | :green:`template<typename M, typename T, int A>`
-       | auto :red:`reinterpret_scalar_valued_gf_as_matrix_valued` (:ref:`block_gf\<M, T, A\> <triqs__gfs__block_gf>` const & :param:`g`)
+    2. | :green:`template<typename M, typename T, typename L, int A>`
+       | auto :red:`reinterpret_scalar_valued_gf_as_matrix_valued` (:ref:`block_gf\<M, T, L, A\> <triqs__gfs__block_gf>` const & :param:`g`)
 
-    3. | :green:`template<typename M, typename T, int A, bool C>`
-       | auto :red:`reinterpret_scalar_valued_gf_as_matrix_valued` (block_gf_view<M, T, A, C> :param:`g`)
+    3. | :green:`template<typename M, typename T, typename L, int A, bool C>`
+       | auto :red:`reinterpret_scalar_valued_gf_as_matrix_valued` (block_gf_view<M, T, L, A, C> :param:`g`)
 
 Documentation

triqs/unstable/_sources/documentation/cpp_api/triqs/hilbert_space/stateLTHilbertSpace,ScalarType,falseGT/operator().rst.txt

@@ -47,4 +47,4 @@ Parameters
 Returns
 ^^^^^^^
 
-Reference to the requested amplitude
+Constant reference to the requested amplitude

triqs/unstable/_sources/documentation/cpp_api/triqs/hilbert_space/stateLTHilbertSpace,ScalarType,trueGT/operator().rst.txt

@@ -47,4 +47,4 @@ Parameters
 Returns
 ^^^^^^^
 
-Reference to the requested amplitude
+Constant reference to the requested amplitude

triqs/unstable/documentation/cpp_api/itertools/enum_iter/operator==.html

@@ -1838,7 +1838,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>True, if the original iterators are equal.</p>
+<p>True, if the original iterator is equal to the iterator stored in the sentinel.</p>
 </section>
 </section>
 

triqs/unstable/documentation/cpp_api/itertools/iterator_facadeLTIter,Value,std::forward_iterator_tag,Reference,DifferenceGT/operator++.html

@@ -1820,7 +1820,7 @@
 <p>Documentation</p>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>Reference to the derived iterator after calling the derived iterator’s <cite>increment()</cite> function.</p>
+<p>Copy of the derived iterator before calling the derived iterator’s <cite>increment()</cite> function.</p>
 </section>
 </section>
 

triqs/unstable/documentation/cpp_api/itertools/prod_iter/operator==.html

@@ -1838,7 +1838,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>True, if the first iterator, i.e. <cite>std::get&lt;0&gt;(its)</cite>, is equal to the iterator of the sentinel.</p>
+<p>True, if all original iterators are equal.</p>
 </section>
 </section>
 

triqs/unstable/documentation/cpp_api/itertools/transform_iter/operator==.html

@@ -1838,7 +1838,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>True, if the original iterators are equal.</p>
+<p>True, if the original iterator is equal to the iterator stored in the sentinel.</p>
 </section>
 </section>
 

triqs/unstable/documentation/cpp_api/itertools/zip_iter/operator==.html

@@ -1838,7 +1838,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>True, if one of the original iterators is equal to the corresponding iterator of the sentinel.</p>
+<p>True, if all original iterators are equal.</p>
 </section>
 </section>
 

triqs/unstable/documentation/cpp_api/mpi/mpi_gather.html

@@ -1840,7 +1840,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>std::string containing the result of the gather operation.</p>
+<p>std::vector containing the result of the gather operation.</p>
 </section>
 </section>