Skip to content

Commit

Permalink
Add distributed API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dimitraka committed Sep 20, 2023
1 parent 27094b3 commit abf4017
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/sphinx/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ a heading brings in the features listed under that heading.

api/public_api.rst

.. toctree::
:maxdepth: 1

api/public_distributed_api.rst

.. toctree::
:maxdepth: 1

Expand Down
95 changes: 95 additions & 0 deletions docs/sphinx/api/public_distributed_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
..
Copyright (C) 2023 Dimitra Karatza
SPDX-License-Identifier: BSL-1.0
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

.. _public_distributed_api:

======================
Public distributed API
======================

Our Public Distributed API offers a rich set of tools and functions that enable developers
to harness the full potential of distributed computing. Here, you'll find a comprehensive
list of header files, classes and functions for various distributed computing features
provided by |hpx|.

.. _public_distr_api_header_all_gather:

``hpx/collectives/all_gather.hpp``
==================================

The header :hpx-header:`libs/full/collectives/include,hpx/collectives/all_gather.hpp`
contains definitions and implementations related to the `all_gather` operation.

Functions
---------

.. table:: `hpx` functions of header ``hpx/collectives/all_gather.hpp``

+------------------------------------------+
| Function |
+==========================================+
| :cpp:func:`hpx::collectives::all_gather` |
+------------------------------------------+

.. _public_distr_api_header_all_reduce:

``hpx/collectives/all_reduce.hpp``
==================================

The header :hpx-header:`libs/full/collectives/include,hpx/collectives/all_reduce.hpp`
contains definitions and implementations related to the `all_reduce` operation.

Functions
---------

.. table:: `hpx` functions of header ``hpx/collectives/all_reduce.hpp``

+------------------------------------------+
| Function |
+==========================================+
| :cpp:func:`hpx::collectives::all_reduce` |
+------------------------------------------+

.. _public_distr_api_header_all_to_all:

``hpx/collectives/all_to_all.hpp``
==================================

The header :hpx-header:`libs/full/collectives/include,hpx/collectives/all_to_all.hpp`
contains definitions and implementations related to the `all_to_all` operation.

Functions
---------

.. table:: `hpx` functions of header ``hpx/collectives/all_to_all.hpp``

+------------------------------------------+
| Function |
+==========================================+
| :cpp:func:`hpx::collectives::all_to_all` |
+------------------------------------------+

.. _public_distr_api_header_argument_types:

``hpx/collectives/argument_types.hpp``
==================================

The header :hpx-header:`libs/full/collectives/include,hpx/collectives/argument_types.hpp`
contains definitions and implementations related to the `argument_types` operation.

Functions
---------

.. table:: `hpx` functions of header ``hpx/collectives/argument_types.hpp``

+----------------------------------------------+
| Function |
+==============================================+
| :cpp:class:`hpx::collectives::argument_type` |
+----------------------------------------------+
| :cpp:func:`hpx::collectives::argument_type` |
+----------------------------------------------+

0 comments on commit abf4017

Please sign in to comment.