Skip to content

Commit 9448807

Browse files
Generated documentation for triqs/DEV_mc_tools_stat
jenkins-TRIQS-triqs-DEV_mc_tools_stat-20 9fd0a207d0eb2e548c4d5fc2ba6db9ae8c936def
1 parent 298e9c0 commit 9448807

File tree

25 files changed

+32
-32
lines changed

25 files changed

+32
-32
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ Parameters
4848
Returns
4949
^^^^^^^
5050

51-
True, if all original iterators are equal.
51+
True, if one of the original iterators is equal to the corresponding iterator of the sentinel.

triqs/DEV_mc_tools_stat/_sources/documentation/cpp_api/mpi/lazy.rst.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Public members
3535

3636

3737
+------+-------------------+----------------------------------------------------------------------------+
38-
| rhs | const_view_type | View of the array/view to be scattered. |
38+
| rhs | stored_type | Array/View to be scattered. |
3939
+------+-------------------+----------------------------------------------------------------------------+
4040
| comm | mpi::communicator | MPI communicator. |
4141
+------+-------------------+----------------------------------------------------------------------------+
@@ -52,11 +52,11 @@ Member types
5252
:widths: 40 60
5353

5454

55-
+-----------------+--------------------------------------+---------------------------------------------------------------+
56-
| value_type | typename std::decay_t<A>::value_type | Value type of the array/view. |
57-
+-----------------+--------------------------------------+---------------------------------------------------------------+
58-
| const_view_type | decltype(std::declval<const A>()()) | Const view type of the array/view stored in the lazy object. |
59-
+-----------------+--------------------------------------+---------------------------------------------------------------+
55+
+-------------+--------------------------------------+----------------------------------------------------+
56+
| value_type | typename std::decay_t<A>::value_type | Value type of the array/view. |
57+
+-------------+--------------------------------------+----------------------------------------------------+
58+
| stored_type | A | Type of the array/view stored in the lazy object. |
59+
+-------------+--------------------------------------+----------------------------------------------------+
6060

6161

6262
Member functions
@@ -67,7 +67,7 @@ Member functions
6767

6868

6969
+-----------------------------------+-----------------------------------------------------------------------------+
70-
| :ref:`shape <mpi__lazy__shape>` | Compute the shape of the target array. |
70+
| :ref:`shape <mpi__lazy__shape>` | Compute the shape of the nda::ArrayInitializer object. |
7171
+-----------------------------------+-----------------------------------------------------------------------------+
7272
| :ref:`invoke <mpi__lazy__invoke>` | Execute the lazy MPI operation and write the result to a target array/view. |
7373
+-----------------------------------+-----------------------------------------------------------------------------+

triqs/DEV_mc_tools_stat/_sources/documentation/cpp_api/mpi/lazy/invoke.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ mpi::lazy::invoke
3636
Template parameters
3737
^^^^^^^^^^^^^^^^^^^
3838

39-
* :param:`T` nda::Array type of the target array/view.
39+
* :param:`T` nda::Array type with C-layout.
4040

4141

4242
Parameters

triqs/DEV_mc_tools_stat/_sources/documentation/cpp_api/mpi/lazy/shape.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ mpi::lazy::shape
3535
Returns
3636
^^^^^^^
3737

38-
Shape of the target array.
38+
Shape of the nda::ArrayInitializer object.
3939

4040
.. warning::
4141
This makes an MPI call.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ Parameters
5454
Returns
5555
^^^^^^^
5656

57-
std::vector containing the result of the gather operation.
57+
std::string containing the result of the gather operation.

triqs/DEV_mc_tools_stat/_sources/documentation/cpp_api/triqs/hilbert_space/stateLTHilbertSpace,ScalarType,falseGT/amplitudes.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ Documentation
4141
Returns
4242
^^^^^^^
4343

44-
Constant reference to the storage container
44+
Reference to the storage container

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ Parameters
4747
Returns
4848
^^^^^^^
4949

50-
Reference to the requested amplitude
50+
Constant reference to the requested amplitude

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ Parameters
4747
Returns
4848
^^^^^^^
4949

50-
Reference to the requested amplitude
50+
Constant reference to the requested amplitude

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1838,7 +1838,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
18381838
</section>
18391839
<section id="returns">
18401840
<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
1841-
<p>True, if all original iterators are equal.</p>
1841+
<p>True, if one of the original iterators is equal to the corresponding iterator of the sentinel.</p>
18421842
</section>
18431843
</section>
18441844

triqs/DEV_mc_tools_stat/documentation/cpp_api/mpi/lazy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1827,7 +1827,7 @@ <h2>Member functions<a class="headerlink" href="#member-functions" title="Link t
18271827
</colgroup>
18281828
<tbody>
18291829
<tr class="row-odd"><td><p><a class="reference internal" href="lazy/shape.html#mpi-lazy-shape"><span class="std std-ref">shape</span></a></p></td>
1830-
<td><p>Compute the shape of the target array.</p></td>
1830+
<td><p>Compute the shape of the nda::ArrayInitializer object.</p></td>
18311831
</tr>
18321832
<tr class="row-even"><td><p><a class="reference internal" href="lazy/invoke.html#mpi-lazy-invoke"><span class="std std-ref">invoke</span></a></p></td>
18331833
<td><p>Execute the lazy MPI operation and write the result to a target array/view.</p></td>

0 commit comments

Comments
 (0)