Add distributed public API for collectives, latch, barrier

STEllAR-GROUP · Oct 10, 2023 · f59ab19 · f59ab19
1 parent 36df71d
commit f59ab19
Showing 1 changed file with 86 additions and 1 deletion.
diff --git a/docs/sphinx/api/public_distributed_api.rst b/docs/sphinx/api/public_distributed_api.rst
@@ -16,6 +16,39 @@ to harness the full potential of distributed computing. Here, you'll find a comp
 list of header files, classes and functions for various distributed computing features
 provided by |hpx|.
 
+.. _public_distr_api_header_barrier:
+
+``hpx/barrier.hpp``
+===================
+
+The header :hpx-header:`libs/full/include/include,hpx/barrier.hpp` includes
+a distributed barrier implementation. For information regarding the C++ standard
+library header :cppreference-header:`barrier`, see :ref:`public_api`.
+
+Classes
+-------
+
+.. table:: Distributed implementation of classes of header ``hpx/barrier.hpp``
+
+   +----------------------------------------+
+   | Class                                  |
+   +========================================+
+   | :cpp:class:`hpx::distributed::barrier` |
+   +----------------------------------------+
+
+Functions
+---------
+
+.. table:: `hpx` functions of header ``hpx/barrier.hpp``
+
+   +-------------------------------------------+
+   | Function                                  |
+   +===========================================+
+   | :cpp:func:`hpx::distributed::wait`        |
+   +-------------------------------------------+
+   | :cpp:func:`hpx::distributed::synchronize` |
+   +-------------------------------------------+
+
 .. _public_distr_api_header_collectives:
 
 ``hpx/collectives.hpp``
@@ -32,7 +65,19 @@ Classes
    +-----------------------------------------------------+
    | Function                                            |
    +=====================================================+
-   | :cpp:class:`hpx::collectives::barrier`              |
+   | :cpp:struct:`hpx::collectives::num_sites_arg`       |
+   +-----------------------------------------------------+
+   | :cpp:struct:`hpx::collectives::this_site_arg`       |
+   +-----------------------------------------------------+
+   | :cpp:struct:`hpx::collectives::that_site_arg`       |
+   +-----------------------------------------------------+
+   | :cpp:struct:`hpx::collectives::generation_arg`      |
+   +-----------------------------------------------------+
+   | :cpp:struct:`hpx::collectives::root_site_arg`       |
+   +-----------------------------------------------------+
+   | :cpp:struct:`hpx::collectives::tag_arg`             |
+   +-----------------------------------------------------+
+   | :cpp:struct:`hpx::collectives::arity_arg`           |
    +-----------------------------------------------------+
    | :cpp:class:`hpx::collectives::channel_communicator` |
    +-----------------------------------------------------+
@@ -84,3 +129,43 @@ Functions
    | :cpp:func:`hpx::collectives::scatter_to`                  |
    +-----------------------------------------------------------+
 
+.. _public_distr_api_header_latch:
+
+``hpx/latch.hpp``
+=================
+
+The header :hpx-header:`libs/full/include/include,hpx/latch.hpp` includes
+a distributed latch implementation. For information regarding the C++ standard
+library header :cppreference-header:`latch`, see :ref:`public_api`.
+
+Classes
+-------
+
+.. table:: Distributed implementation of classes of header ``hpx/latch.hpp``
+
+   +--------------------------------------+
+   | Class                                |
+   +======================================+
+   | :cpp:class:`hpx::distributed::latch` |
+   +--------------------------------------+
+
+Functions
+---------
+
+.. table:: `hpx` functions of header ``hpx/latch.hpp``
+
+   +---------------------------------------------------+
+   | Function                                          |
+   +===================================================+
+   | :cpp:func:`hpx::distributed::count_down_and_wait` |
+   +---------------------------------------------------+
+   | :cpp:func:`hpx::distributed::arrive_and_wait`     |
+   +---------------------------------------------------+
+   | :cpp:func:`hpx::distributed::count_down`          |
+   +---------------------------------------------------+
+   | :cpp:func:`hpx::distributed::is_ready`            |
+   +---------------------------------------------------+
+   | :cpp:func:`hpx::distributed::try_wait`            |
+   +---------------------------------------------------+
+   | :cpp:func:`hpx::distributed::wait`                |
+   +---------------------------------------------------+