..
    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_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``
=======================

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

Classes
-------

.. table:: `hpx` classes of header ``hpx/collectives.hpp``

   +-----------------------------------------------------+
   | Class                                               |
   +=====================================================+
   | :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:struct:`hpx::collectives::communicator`        |
   +-----------------------------------------------------+
   | :cpp:class:`hpx::collectives::channel_communicator` |
   +-----------------------------------------------------+

Functions
---------

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

   +-----------------------------------------------------------+
   | Function                                                  |
   +===========================================================+
   | :cpp:func:`hpx::collectives::all_gather`                  |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::all_reduce`                  |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::all_to_all`                  |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::broadcast_to`                |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::broadcast_from`              |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::create_channel_communicator` |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::set`                         |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::get`                         |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::create_communication_set`    |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::create_communicator`         |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::create_local_communicator`   |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::communicator::set_info`      |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::communicator::get_info`      |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::communicator::is_root`       |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::exclusive_scan`              |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::gather_here`                 |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::gather_there`                |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::inclusive_scan`              |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::reduce_here`                 |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::reduce_there`                |
   +-----------------------------------------------------------+
   | :cpp:func:`hpx::collectives::scatter_from`                |
   +-----------------------------------------------------------+
   | :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`                |
   +---------------------------------------------------+