..
    Copyright (C) 2019 Thomas Heller
    Copyright (C) 2019-2026 The STE||AR Group

    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)

.. _modules_collectives_api:

-----------
collectives
-----------

See :ref:`public_api` for a list of names and headers that are part of the public
|hpx| API.


.. toctree::
   :maxdepth: 1

   /libs/full/collectives/api/all_reduce_hpx_collectives_all_reduce.rst
   /libs/full/collectives/api/gather_hpx_collectives_gather_here.rst
   /libs/full/collectives/api/gather_hpx_collectives_gather_there.rst
   /libs/full/collectives/api/barrier_hpx_distributed_barrier.rst
   /libs/full/collectives/api/all_gather_hpx_collectives_all_gather.rst
   /libs/full/collectives/api/all_to_all_hpx_collectives_all_to_all.rst
   /libs/full/collectives/api/inclusive_scan_hpx_collectives_inclusive_scan.rst
   /libs/full/collectives/api/broadcast_hpx_collectives_broadcast_to.rst
   /libs/full/collectives/api/broadcast_hpx_collectives_broadcast_from.rst
   /libs/full/collectives/api/argument_types_hpx_collectives_num_sites_arg.rst
   /libs/full/collectives/api/argument_types_hpx_collectives_this_site_arg.rst
   /libs/full/collectives/api/argument_types_hpx_collectives_that_site_arg.rst
   /libs/full/collectives/api/argument_types_hpx_collectives_generation_arg.rst
   /libs/full/collectives/api/argument_types_hpx_collectives_root_site_arg.rst
   /libs/full/collectives/api/argument_types_hpx_collectives_tag_arg.rst
   /libs/full/collectives/api/argument_types_hpx_collectives_arity_arg.rst
   /libs/full/collectives/api/argument_types_hpx_collectives_flat_fallback_threshold_arg.rst
   /libs/full/collectives/api/exclusive_scan_hpx_collectives_exclusive_scan.rst
   /libs/full/collectives/api/scatter_hpx_collectives_scatter_from.rst
   /libs/full/collectives/api/scatter_hpx_collectives_scatter_to.rst
   /libs/full/collectives/api/spmd_block_hpx_lcos_spmd_block.rst
   /libs/full/collectives/api/spmd_block_hpx_lcos_define_spmd_block.rst
   /libs/full/collectives/api/latch_hpx_distributed_latch.rst
   /libs/full/collectives/api/fold_hpx_lcos_fold.rst
   /libs/full/collectives/api/fold_hpx_lcos_fold_with_index.rst
   /libs/full/collectives/api/fold_hpx_lcos_inverse_fold.rst
   /libs/full/collectives/api/fold_hpx_lcos_inverse_fold_with_index.rst
   /libs/full/collectives/api/reduce_direct_hpx_lcos_reduce.rst
   /libs/full/collectives/api/reduce_direct_hpx_lcos_reduce_with_index.rst
   /libs/full/collectives/api/reduce_hpx_collectives_reduce_here.rst
   /libs/full/collectives/api/reduce_hpx_collectives_reduce_there.rst
   /libs/full/collectives/api/macros.rst
   /libs/full/collectives/api/channel_communicator_hpx_collectives_channel_communicator.rst
   /libs/full/collectives/api/channel_communicator_hpx_collectives_create_channel_communicator.rst
   /libs/full/collectives/api/channel_communicator_hpx_collectives_get.rst
   /libs/full/collectives/api/channel_communicator_hpx_collectives_set.rst
   /libs/full/collectives/api/create_communicator_hpx_collectives_communicator.rst
   /libs/full/collectives/api/create_communicator_hpx_collectives_create_communicator.rst
   /libs/full/collectives/api/create_communicator_hpx_collectives_create_local_communicator.rst
   /libs/full/collectives/api/create_communicator_hpx_collectives_create_hierarchical_communicator.rst
   /libs/full/collectives/api/create_communicator_hpx_collectives_communicator_set_info.rst
   /libs/full/collectives/api/create_communicator_hpx_collectives_communicator_get_info.rst
   /libs/full/collectives/api/create_communicator_hpx_collectives_communicator_is_root.rst
   /libs/full/collectives/api/broadcast_direct_hpx_lcos_broadcast.rst
   /libs/full/collectives/api/broadcast_direct_hpx_lcos_broadcast_post.rst
   /libs/full/collectives/api/broadcast_direct_hpx_lcos_broadcast_with_index.rst
   /libs/full/collectives/api/broadcast_direct_hpx_lcos_broadcast_post_with_index.rst