.. Copyright (C) 2021 Dimitra Karatza Copyright (C) 2020-2022 ETH Zurich 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_api: ========== Public API ========== Our API is semantically conforming; hence, the reader is highly encouraged to refer to the corresponding facility in the `C++ Standard `_ if needed. All names below are also available in the top-level ``hpx`` namespace unless otherwise noted. The names in ``hpx`` should be preferred. The names in sub-namespaces will eventually be removed. .. _public_api_header_hpx_algorithm: ``hpx/algorithm.hpp`` ===================== The header :hpx-header:`libs/full/include/include,hpx/algorithm.hpp` corresponds to the C++ standard library header :cppreference-header:`algorithm`. See :ref:`parallel_algorithms` for more information about the parallel algorithms. Classes ------- .. table:: Classes of header ``hpx/algorithm.hpp`` ========================================= ============== Class C++ standard ========================================= ============== :hpx:class:`hpx::experimental::reduction` |cpp19_n4808|_ :hpx:class:`hpx::experimental::induction` |cpp19_n4808|_ ========================================= ============== Functions --------- .. table:: `hpx` functions of header ``hpx/algorithm.hpp`` ================================================= ========================================================== `hpx` function C++ standard ================================================= ========================================================== :hpx:func:`hpx::adjacent_find` :cppreference-generic:`algorithm,adjacent_find` :hpx:func:`hpx::all_of` :cppreference-generic:`algorithm,all_any_none_of,all_of` :hpx:func:`hpx::any_of` :cppreference-generic:`algorithm,all_any_none_of,any_of` :hpx:func:`hpx::copy` :cppreference-generic:`algorithm,copy` :hpx:func:`hpx::copy_if` :cppreference-generic:`algorithm,copy,copy_if` :hpx:func:`hpx::copy_n` :cppreference-generic:`algorithm,copy_n` :hpx:func:`hpx::count` :cppreference-generic:`algorithm,count` :hpx:func:`hpx::count_if` :cppreference-generic:`algorithm,count,count_if` :hpx:func:`hpx::ends_with` :cppreference-generic:`algorithm/ranges,ends_with` :hpx:func:`hpx::equal` :cppreference-generic:`algorithm,equal` :hpx:func:`hpx::fill` :cppreference-generic:`algorithm,fill` :hpx:func:`hpx::fill_n` :cppreference-generic:`algorithm,fill_n` :hpx:func:`hpx::find` :cppreference-generic:`algorithm,find` :hpx:func:`hpx::find_end` :cppreference-generic:`algorithm,find_end` :hpx:func:`hpx::find_first_of` :cppreference-generic:`algorithm,find_first_of` :hpx:func:`hpx::find_if` :cppreference-generic:`algorithm,find,find_if` :hpx:func:`hpx::find_if_not` :cppreference-generic:`algorithm,find,find_if_not` :hpx:func:`hpx::for_each` :cppreference-generic:`algorithm,for_each` :hpx:func:`hpx::for_each_n` :cppreference-generic:`algorithm,for_each_n` :hpx:func:`hpx::generate` :cppreference-generic:`algorithm,generate` :hpx:func:`hpx::generate_n` :cppreference-generic:`algorithm,generate_n` :hpx:func:`hpx::includes` :cppreference-generic:`algorithm,includes` :hpx:func:`hpx::inplace_merge` :cppreference-generic:`algorithm,inplace_merge` :hpx:func:`hpx::is_heap` :cppreference-generic:`algorithm,is_heap` :hpx:func:`hpx::is_heap_until` :cppreference-generic:`algorithm,is_heap_until` :hpx:func:`hpx::is_partitioned` :cppreference-generic:`algorithm,is_partitioned` :hpx:func:`hpx::is_sorted` :cppreference-generic:`algorithm,is_sorted` :hpx:func:`hpx::is_sorted_until` :cppreference-generic:`algorithm,is_sorted_until` :hpx:func:`hpx::lexicographical_compare` :cppreference-generic:`algorithm,lexicographical_compare` :hpx:func:`hpx::make_heap` :cppreference-generic:`algorithm,make_heap` :hpx:func:`hpx::max_element` :cppreference-generic:`algorithm,max_element` :hpx:func:`hpx::merge` :cppreference-generic:`algorithm,merge` :hpx:func:`hpx::min_element` :cppreference-generic:`algorithm,min_element` :hpx:func:`hpx::minmax_element` :cppreference-generic:`algorithm,minmax_element` :hpx:func:`hpx::mismatch` :cppreference-generic:`algorithm,mismatch` :hpx:func:`hpx::move` :cppreference-generic:`algorithm,move` :hpx:func:`hpx::none_of` :cppreference-generic:`algorithm,all_any_none_of,none_of` :hpx:func:`hpx::nth_element` :cppreference-generic:`algorithm,nth_element` :hpx:func:`hpx::partial_sort` :cppreference-generic:`algorithm,partial_sort` :hpx:func:`hpx::partial_sort_copy` :cppreference-generic:`algorithm,partial_sort_copy` :hpx:func:`hpx::partition` :cppreference-generic:`algorithm,partition` :hpx:func:`hpx::partition_copy` :cppreference-generic:`algorithm,partition_copy` :hpx:func:`hpx::experimental::reduce_by_key` `reduce_by_key `_ :hpx:func:`hpx::remove` :cppreference-generic:`algorithm,remove` :hpx:func:`hpx::remove_copy` :cppreference-generic:`algorithm,remove_copy` :hpx:func:`hpx::remove_copy_if` :cppreference-generic:`algorithm,remove_copy,remove_copy_if` :hpx:func:`hpx::remove_if` :cppreference-generic:`algorithm,remove,remove_if` :hpx:func:`hpx::replace` :cppreference-generic:`algorithm,replace` :hpx:func:`hpx::replace_copy` :cppreference-generic:`algorithm,replace_copy` :hpx:func:`hpx::replace_copy_if` :cppreference-generic:`algorithm,replace_copy,replace_copy_if` :hpx:func:`hpx::replace_if` :cppreference-generic:`algorithm,replace,replace_if` :hpx:func:`hpx::reverse` :cppreference-generic:`algorithm,reverse` :hpx:func:`hpx::reverse_copy` :cppreference-generic:`algorithm,reverse_copy` :hpx:func:`hpx::rotate` :cppreference-generic:`algorithm,rotate` :hpx:func:`hpx::rotate_copy` :cppreference-generic:`algorithm,rotate_copy` :hpx:func:`hpx::search` :cppreference-generic:`algorithm,search` :hpx:func:`hpx::search_n` :cppreference-generic:`algorithm,search_n` :hpx:func:`hpx::set_difference` :cppreference-generic:`algorithm,set_difference` :hpx:func:`hpx::set_intersection` :cppreference-generic:`algorithm,set_intersection` :hpx:func:`hpx::set_symmetric_difference` :cppreference-generic:`algorithm,set_symmetric_difference` :hpx:func:`hpx::set_union` :cppreference-generic:`algorithm,set_union` :hpx:func:`hpx::shift_left` :cppreference-generic:`algorithm,shift,shift_left` :hpx:func:`hpx::shift_right` :cppreference-generic:`algorithm,shift,shift_right` :hpx:func:`hpx::sort` :cppreference-generic:`algorithm,sort` :hpx:func:`hpx::experimental::sort_by_key` `sort_by_key `_ :hpx:func:`hpx::stable_partition` :cppreference-generic:`algorithm,stable_partition` :hpx:func:`hpx::stable_sort` :cppreference-generic:`algorithm,stable_sort` :hpx:func:`hpx::starts_with` :cppreference-generic:`algorithm/ranges,starts_with` :hpx:func:`hpx::swap_ranges` :cppreference-generic:`algorithm,swap_ranges` :hpx:func:`hpx::transform` :cppreference-generic:`algorithm,transform` :hpx:func:`hpx::unique` :cppreference-generic:`algorithm,unique` :hpx:func:`hpx::unique_copy` :cppreference-generic:`algorithm,unique_copy` :hpx:func:`hpx::experimental::for_loop` |cpp19_n4808|_ :hpx:func:`hpx::experimental::for_loop_strided` |cpp19_n4808|_ :hpx:func:`hpx::experimental::for_loop_n` |cpp19_n4808|_ :hpx:func:`hpx::experimental::for_loop_n_strided` |cpp19_n4808|_ ================================================= ========================================================== .. table:: `hpx::ranges` functions of header ``hpx/algorithm.hpp`` ======================================================= ================================================================= `hpx::ranges` function C++ standard ======================================================= ================================================================= :hpx:func:`hpx::ranges::adjacent_find` :cppreference-generic:`algorithm/ranges,adjacent_find` :hpx:func:`hpx::ranges::all_of` :cppreference-generic:`algorithm/ranges,all_any_none_of,all_of` :hpx:func:`hpx::ranges::any_of` :cppreference-generic:`algorithm/ranges,all_any_none_of,any_of` :hpx:func:`hpx::ranges::copy` :cppreference-generic:`algorithm/ranges,copy` :hpx:func:`hpx::ranges::copy_if` :cppreference-generic:`algorithm/ranges,copy,copy_if` :hpx:func:`hpx::ranges::copy_n` :cppreference-generic:`algorithm/ranges,copy_n` :hpx:func:`hpx::ranges::count` :cppreference-generic:`algorithm/ranges,count` :hpx:func:`hpx::ranges::count_if` :cppreference-generic:`algorithm/ranges,count,count_if` :hpx:func:`hpx::ranges::ends_with` :cppreference-generic:`algorithm/ranges,ends_with` :hpx:func:`hpx::ranges::equal` :cppreference-generic:`algorithm/ranges,equal` :hpx:func:`hpx::ranges::fill` :cppreference-generic:`algorithm/ranges,fill` :hpx:func:`hpx::ranges::fill_n` :cppreference-generic:`algorithm/ranges,fill_n` :hpx:func:`hpx::ranges::find` :cppreference-generic:`algorithm/ranges,find` :hpx:func:`hpx::ranges::find_end` :cppreference-generic:`algorithm/ranges,find_end` :hpx:func:`hpx::ranges::find_first_of` :cppreference-generic:`algorithm/ranges,find_first_of` :hpx:func:`hpx::ranges::find_if` :cppreference-generic:`algorithm/ranges,find,find_if` :hpx:func:`hpx::ranges::find_if_not` :cppreference-generic:`algorithm/ranges,find,find_if_not` :hpx:func:`hpx::ranges::for_each` :cppreference-generic:`algorithm/ranges,for_each` :hpx:func:`hpx::ranges::for_each_n` :cppreference-generic:`algorithm/ranges,for_each_n` :hpx:func:`hpx::ranges::generate` :cppreference-generic:`algorithm/ranges,generate` :hpx:func:`hpx::ranges::generate_n` :cppreference-generic:`algorithm/ranges,generate_n` :hpx:func:`hpx::ranges::includes` :cppreference-generic:`algorithm/ranges,includes` :hpx:func:`hpx::ranges::inplace_merge` :cppreference-generic:`algorithm/ranges,inplace_merge` :hpx:func:`hpx::ranges::is_heap` :cppreference-generic:`algorithm/ranges,is_heap` :hpx:func:`hpx::ranges::is_heap_until` :cppreference-generic:`algorithm/ranges,is_heap_until` :hpx:func:`hpx::ranges::is_partitioned` :cppreference-generic:`algorithm/ranges,is_partitioned` :hpx:func:`hpx::ranges::is_sorted` :cppreference-generic:`algorithm/ranges,is_sorted` :hpx:func:`hpx::ranges::is_sorted_until` :cppreference-generic:`algorithm/ranges,is_sorted_until` :hpx:func:`hpx::ranges::make_heap` :cppreference-generic:`algorithm/ranges,make_heap` :hpx:func:`hpx::ranges::max_element` :cppreference-generic:`algorithm/ranges,max_element` :hpx:func:`hpx::ranges::merge` :cppreference-generic:`algorithm/ranges,merge` :hpx:func:`hpx::ranges::min_element` :cppreference-generic:`algorithm/ranges,min_element` :hpx:func:`hpx::ranges::minmax_element` :cppreference-generic:`algorithm/ranges,minmax_element` :hpx:func:`hpx::ranges::mismatch` :cppreference-generic:`algorithm/ranges,mismatch` :hpx:func:`hpx::ranges::move` :cppreference-generic:`algorithm/ranges,move` :hpx:func:`hpx::ranges::none_of` :cppreference-generic:`algorithm/ranges,all_any_none_of,none_of` :hpx:func:`hpx::ranges::nth_element` :cppreference-generic:`algorithm/ranges,nth_element` :hpx:func:`hpx::ranges::partial_sort` :cppreference-generic:`algorithm/ranges,partial_sort` :hpx:func:`hpx::ranges::partial_sort_copy` :cppreference-generic:`algorithm/ranges,partial_sort_copy` :hpx:func:`hpx::ranges::partition` :cppreference-generic:`algorithm/ranges,partition` :hpx:func:`hpx::ranges::partition_copy` :cppreference-generic:`algorithm/ranges,partition_copy` :hpx:func:`hpx::ranges::set_difference` :cppreference-generic:`algorithm/ranges,set_difference` :hpx:func:`hpx::ranges::set_intersection` :cppreference-generic:`algorithm/ranges,set_intersection` :hpx:func:`hpx::ranges::set_symmetric_difference` :cppreference-generic:`algorithm/ranges,set_symmetric_difference` :hpx:func:`hpx::ranges::set_union` :cppreference-generic:`algorithm/ranges,set_union` :hpx:func:`hpx::ranges::shift_left` |p2440|_ :hpx:func:`hpx::ranges::shift_right` |p2440|_ :hpx:func:`hpx::ranges::sort` :cppreference-generic:`algorithm/ranges,sort` :hpx:func:`hpx::ranges::stable_partition` :cppreference-generic:`algorithm/ranges,stable_partition` :hpx:func:`hpx::ranges::stable_sort` :cppreference-generic:`algorithm/ranges,stable_sort` :hpx:func:`hpx::ranges::starts_with` :cppreference-generic:`algorithm/ranges,starts_with` :hpx:func:`hpx::ranges::swap_ranges` :cppreference-generic:`algorithm/ranges,swap_ranges` :hpx:func:`hpx::ranges::transform` :cppreference-generic:`algorithm/ranges,transform` :hpx:func:`hpx::ranges::unique` :cppreference-generic:`algorithm/ranges,unique` :hpx:func:`hpx::ranges::unique_copy` :cppreference-generic:`algorithm/ranges,unique_copy` :hpx:func:`hpx::ranges::experimental::for_loop` |cpp19_n4808|_ :hpx:func:`hpx::ranges::experimental::for_loop_strided` |cpp19_n4808|_ ======================================================= ================================================================= .. _public_api_header_hpx_any: ``hpx/any.hpp`` =============== The header :hpx-header:`libs/core/include_local/include,hpx/any.hpp` corresponds to the C++ standard library header :cppreference-header:`any`. :hpx:type:`hpx::any` is compatible with ``std::any``. :hpx:type:`hpx::any_nonser`, :hpx:type:`hpx::unique_any_nonser`, and their corresponding factory functions :hpx:func:`hpx::make_any_nonser` and :hpx:func:`hpx::make_unique_any_nonser` are |hpx| extensions that do not support serialization and have no counterparts in the C++ standard library. Classes ------- .. table:: Classes of header ``hpx/any.hpp`` ================================== ================================================ Class C++ standard ================================== ================================================ :hpx:type:`hpx::any` :cppreference-generic:`utility,any` :hpx:type:`hpx::any_nonser` :hpx:type:`hpx::bad_any_cast` :cppreference-generic:`utility/any,bad_any_cast` :hpx:type:`hpx::unique_any_nonser` ================================== ================================================ Functions --------- .. table:: Functions of header ``hpx/any.hpp`` ======================================= ================================================ Function C++ standard ======================================= ================================================ :hpx:func:`hpx::any_cast` :cppreference-generic:`utility/any,any_cast` :hpx:func:`hpx::make_any` :cppreference-generic:`utility/any,make_any` :hpx:func:`hpx::make_any_nonser` :hpx:func:`hpx::make_unique_any_nonser` ======================================= ================================================ .. _public_api_header_hpx_assert: ``hpx/assert.hpp`` ================== The header :hpx-header:`libs/core/assertion/include,hpx/assert.hpp` corresponds to the C++ standard library header :cppreference-header:`cassert`. :c:macro:`HPX_ASSERT` is the |hpx| equivalent to ``assert`` in ``cassert``. :c:macro:`HPX_ASSERT` can also be used in CUDA device code. Macros ------ .. table:: Macros of header ``hpx/assert.hpp`` +--------------------------+ | Macro | +==========================+ | :c:macro:`HPX_ASSERT` | +--------------------------+ | :c:macro:`HPX_ASSERT_MSG`| +--------------------------+ .. _public_api_header_hpx_barrier: ``hpx/barrier.hpp`` =================== The header :hpx-header:`libs/full/include/include,hpx/barrier.hpp` corresponds to the C++ standard library header :cppreference-header:`barrier` and contains a distributed barrier implementation. This functionality is also exposed through the ``hpx::distributed`` namespace. The name in ``hpx::distributed`` should be preferred. Classes ------- .. table:: Classes of header ``hpx/barrier.hpp`` +--------------------------+----------------------------------------+ | Class | C++ standard | +==========================+========================================+ | :hpx:class:`hpx::barrier`| :cppreference-generic:`thread,barrier` | +--------------------------+----------------------------------------+ .. table:: Distributed implementation of classes of header ``hpx/barrier.hpp`` +----------------------------------------+ | Class | +========================================+ | :hpx:class:`hpx::distributed::barrier` | +----------------------------------------+ .. _public_api_header_hpx_channel: ``hpx/channel.hpp`` =================== The header :hpx-header:`libs/full/include/include,hpx/channel.hpp` contains a local and a distributed channel implementation. This functionality is also exposed through the ``hpx::distributed`` namespace. The name in ``hpx::distributed`` should be preferred. The channel functionality is specific to |hpx| and has no counterpart in the C++ standard library. Classes ------- .. table:: Classes of header ``hpx/channel.hpp`` +--------------------------+ | Class | +==========================+ | :hpx:class:`hpx::channel`| +--------------------------+ .. table:: Distributed implementation of classes of header ``hpx/channel.hpp`` +----------------------------------------+ | Class | +========================================+ | :hpx:class:`hpx::distributed::channel` | +----------------------------------------+ .. _public_api_header_hpx_chrono: ``hpx/chrono.hpp`` ================== The header :hpx-header:`libs/core/include_local/include,hpx/chrono.hpp` corresponds to the C++ standard library header :cppreference-header:`chrono`. The following replacements and extensions are provided compared to :cppreference-header:`chrono`. Classes ------- .. table:: Classes of header ``hpx/chrono.hpp`` =============================================== ==================================================== Class C++ standard =============================================== ==================================================== :hpx:class:`hpx::chrono::high_resolution_clock` :cppreference-generic:`chrono,high_resolution_clock` :hpx:class:`hpx::chrono::high_resolution_timer` :hpx:class:`hpx::chrono::steady_time_point` :cppreference-generic:`chrono,time_point` =============================================== ==================================================== .. _public_api_header_hpx_condition_variable: ``hpx/condition_variable.hpp`` ============================== The header :hpx-header:`libs/core/include_local/include,hpx/condition_variable.hpp` corresponds to the C++ standard library header :cppreference-header:`condition_variable`. Classes ------- .. table:: Classes of header ``hpx/condition_variable.hpp`` ======================================== ===================================================== Class C++ standard ======================================== ===================================================== :hpx:class:`hpx::condition_variable` :cppreference-generic:`thread,condition_variable` :hpx:class:`hpx::condition_variable_any` :cppreference-generic:`thread,condition_variable_any` :hpx:class:`hpx::cv_status` :cppreference-generic:`thread,cv_status` ======================================== ===================================================== .. _public_api_header_hpx_exception: ``hpx/exception.hpp`` ===================== The header :hpx-header:`libs/core/include_local/include,hpx/exception.hpp` corresponds to the C++ standard library header :cppreference-header:`exception`. :hpx:class:`hpx::exception` extends ``std::exception`` and is the base class for all exceptions thrown in |hpx|. :c:macro:`HPX_THROW_EXCEPTION` can be used to throw |hpx| exceptions with file and line information attached to the exception. Macros ------ - :c:macro:`HPX_THROW_EXCEPTION` Classes ------- .. table:: Classes of header ``hpx/exception.hpp`` +----------------------------+----------------------------------------+ | Class | C++ standard | +============================+========================================+ | :hpx:class:`hpx::exception`| :cppreference-generic:`error,exception`| +----------------------------+----------------------------------------+ .. _public_api_header_hpx_execution: ``hpx/execution.hpp`` ===================== The header :hpx-header:`libs/core/include_local/include,hpx/execution.hpp` corresponds to the C++ standard library header :cppreference-header:`execution`. See :ref:`parallel`, :ref:`parallel_algorithms` and :ref:`executor_parameters` for more information about execution policies and executor parameters. .. note:: These names are only available in the ``hpx::execution`` namespace, not in the top-level ``hpx`` namespace. Constants --------- .. table:: Constants of header ``hpx/execution.hpp`` ==================================== ====================================================== Constant C++ standard ==================================== ====================================================== :hpx:var:`hpx::execution::seq` :cppreference-generic:`algorithm,execution_policy_tag` :hpx:var:`hpx::execution::par` :cppreference-generic:`algorithm,execution_policy_tag` :hpx:var:`hpx::execution::par_unseq` :cppreference-generic:`algorithm,execution_policy_tag` :hpx:var:`hpx::execution::task` ==================================== ====================================================== Classes ------- .. table:: Classes of header ``hpx/execution.hpp`` ===================================================================== ======================================================== Class C++ standard ===================================================================== ======================================================== :hpx:class:`hpx::execution::sequenced_policy` :cppreference-generic:`algorithm,execution_policy_tag_t` :hpx:class:`hpx::execution::parallel_policy` :cppreference-generic:`algorithm,execution_policy_tag_t` :hpx:class:`hpx::execution::parallel_unsequenced_policy` :cppreference-generic:`algorithm,execution_policy_tag_t` :hpx:class:`hpx::execution::sequenced_task_policy` :hpx:class:`hpx::execution::parallel_task_policy` :hpx:class:`hpx::execution::experimental::auto_chunk_size` :hpx:class:`hpx::execution::experimental::dynamic_chunk_size` :hpx:class:`hpx::execution::experimental::guided_chunk_size` :hpx:class:`hpx::execution::experimental::persistent_auto_chunk_size` :hpx:class:`hpx::execution::experimental::static_chunk_size` :hpx:class:`hpx::execution::experimental::num_cores` ===================================================================== ======================================================== .. _public_api_header_hpx_functional: ``hpx/functional.hpp`` ====================== The header :hpx-header:`libs/core/include_local/include,hpx/functional.hpp` corresponds to the C++ standard library header :cppreference-header:`functional`. :hpx:class:`hpx::function` is a more efficient and serializable replacement for ``std::function``. Constants --------- The following constants correspond to the C++ standard :cppreference-generic:`utility/functional,placeholders` .. table:: Constants of header ``hpx/functional.hpp`` +---------------------------------+ | Constant | +=================================+ | :hpx:var:`hpx::placeholders::_1`| +---------------------------------+ | :hpx:var:`hpx::placeholders::_2`| +---------------------------------+ | ... | +---------------------------------+ | :hpx:var:`hpx::placeholders::_9`| +---------------------------------+ Classes ------- .. table:: Classes of header ``hpx/functional.hpp`` ============================================= ============================================================= Class C++ standard ============================================= ============================================================= :hpx:class:`hpx::function` :cppreference-generic:`utility/functional,function` :hpx:class:`hpx::function_ref` |p0792|_ :hpx:class:`hpx::move_only_function` :cppreference-generic:`utility/functional,move_only_function` :hpx:struct:`hpx::is_bind_expression` :cppreference-generic:`utility/functional,is_bind_expression` :hpx:struct:`hpx::is_placeholder` :cppreference-generic:`utility/functional,is_placeholder` :hpx:struct:`hpx::scoped_annotation` ============================================= ============================================================= Functions --------- .. table:: Functions of header ``hpx/functional.hpp`` ======================================== ===================================================== Function C++ standard ======================================== ===================================================== :hpx:func:`hpx::annotated_function` :hpx:func:`hpx::bind` :cppreference-generic:`utility/functional,bind` :hpx:func:`hpx::bind_back` :cppreference-generic:`utility/functional,bind_front` :hpx:func:`hpx::bind_front` :cppreference-generic:`utility/functional,bind_front` :hpx:func:`hpx::invoke` :cppreference-generic:`utility/functional,invoke` :hpx:func:`hpx::invoke_fused` :cppreference-generic:`utility,apply` :hpx:func:`hpx::invoke_fused_r` :hpx:func:`hpx::mem_fn` :cppreference-generic:`utility/functional,mem_fn` ======================================== ===================================================== .. _public_api_header_hpx_future: ``hpx/future.hpp`` ================== The header :hpx-header:`libs/full/include/include,hpx/future.hpp` corresponds to the C++ standard library header :cppreference-header:`future`. See :ref:`extend_futures` for more information about extensions to futures compared to the C++ standard library. This header file also contains overloads of :hpx:func:`hpx::async`, :hpx:func:`hpx::post`, :hpx:func:`hpx::sync`, and :hpx:func:`hpx::dataflow` that can be used with actions. See :ref:`action_invocation` for more information about invoking actions. Classes ------- .. table:: Classes of header ``hpx/future.hpp`` =============================== ============================================ Class C++ standard =============================== ============================================ :hpx:class:`hpx::future` :cppreference-generic:`thread,future` :hpx:class:`hpx::shared_future` :cppreference-generic:`thread,shared_future` :hpx:class:`hpx::promise` :cppreference-generic:`thread,promise` :hpx:class:`hpx::launch` :cppreference-generic:`thread,launch` :hpx:class:`hpx::packaged_task` :cppreference-generic:`thread,packaged_task` =============================== ============================================ .. note:: All names except :hpx:class:`hpx::promise` are also available in the top-level ``hpx`` namespace. ``hpx::promise`` refers to :hpx:class:`hpx::distributed::promise`, a distributed variant of :hpx:class:`hpx::promise`, but will eventually refer to :hpx:class:`hpx::promise` after a deprecation period. .. table:: Distributed implementation of classes of header ``hpx/future.hpp`` +---------------------------------------+ | Class | +=======================================+ | :hpx:class:`hpx::distributed::promise`| +---------------------------------------+ Functions --------- .. table:: Functions of header ``hpx/future.hpp`` ======================================== ===================================== Function C++ standard ======================================== ===================================== :hpx:func:`hpx::async` :cppreference-generic:`thread,async` :hpx:func:`hpx::post` :hpx:func:`hpx::sync` :hpx:func:`hpx::dataflow` :hpx:func:`hpx::make_future` :hpx:func:`hpx::make_shared_future` :hpx:func:`hpx::make_ready_future` |p0159|_ :hpx:func:`hpx::make_ready_future_alloc` :hpx:func:`hpx::make_ready_future_at` :hpx:func:`hpx::make_ready_future_after` :hpx:func:`hpx::make_exceptional_future` |p0159|_ :hpx:func:`hpx::when_all` |p0159|_ :hpx:func:`hpx::when_any` |p0159|_ :hpx:func:`hpx::when_some` :hpx:func:`hpx::when_each` :hpx:func:`hpx::wait_all` :hpx:func:`hpx::wait_any` :hpx:func:`hpx::wait_some` :hpx:func:`hpx::wait_each` ======================================== ===================================== .. _public_api_header_hpx_init: ``hpx/init.hpp`` ================ The header :hpx-header:`libs/full/init_runtime/include,hpx/init.hpp` contains functionality for starting, stopping, suspending, and resuming the |hpx| runtime. This is the main way to explicitly start the |hpx| runtime. See :ref:`starting_hpx` for more details on starting the |hpx| runtime. Classes ------- .. table:: Classes of header ``hpx/init.hpp`` +------------------------------+ | Class | +==============================+ | :hpx:class:`hpx::init_params`| +------------------------------+ | :hpx:enum:`hpx::runtime_mode`| +------------------------------+ Functions --------- .. table:: Functions of header ``hpx/init.hpp`` +------------------------------+ | Function | +==============================+ | :hpx:func:`hpx::init` | +------------------------------+ | :hpx:func:`hpx::start` | +------------------------------+ | :hpx:func:`hpx::finalize` | +------------------------------+ | :hpx:func:`hpx::disconnect` | +------------------------------+ | :hpx:func:`hpx::suspend` | +------------------------------+ | :hpx:func:`hpx::resume` | +------------------------------+ .. _public_api_header_hpx_latch: ``hpx/latch.hpp`` ================= The header :hpx-header:`libs/full/include/include,hpx/latch.hpp` corresponds to the C++ standard library header :cppreference-header:`latch`. It contains a local and a distributed latch implementation. This functionality is also exposed through the ``hpx::distributed`` namespace. The name in ``hpx::distributed`` should be preferred. Classes ------- .. table:: Classes of header ``hpx/latch.hpp`` +----------------------------+----------------------------------------+ | Class | C++ standard | +============================+========================================+ | :hpx:class:`hpx::latch` | :cppreference-generic:`thread,latch` | +----------------------------+----------------------------------------+ .. table:: Distributed implementation of classes of header ``hpx/latch.hpp`` +--------------------------------------+ | Class | +======================================+ | :hpx:class:`hpx::distributed::latch` | +--------------------------------------+ .. _public_api_header_hpx_mutex: ``hpx/mutex.hpp`` ================= The header :hpx-header:`libs/core/include_local/include,hpx/mutex.hpp` corresponds to the C++ standard library header :cppreference-header:`mutex`. Classes ------- .. table:: Classes of header ``hpx/mutex.hpp`` ================================= ============================================== Class C++ standard ================================= ============================================== :hpx:class:`hpx::mutex` :cppreference-generic:`thread,mutex` :hpx:class:`hpx::no_mutex` :hpx:class:`hpx::once_flag` :cppreference-generic:`thread,once_flag` :hpx:class:`hpx::recursive_mutex` :cppreference-generic:`thread,recursive_mutex` :hpx:class:`hpx::spinlock` :hpx:class:`hpx::timed_mutex` :cppreference-generic:`thread,timed_mutex` :hpx:class:`hpx::unlock_guard` ================================= ============================================== Functions --------- .. table:: Functions of header ``hpx/mutex.hpp`` +----------------------------+------------------------------------------+ | Class | C++ standard | +============================+==========================================+ | :hpx:func:`hpx::call_once` | :cppreference-generic:`thread,call_once` | +----------------------------+------------------------------------------+ .. _public_api_header_hpx_memory: ``hpx/memory.hpp`` ================== The header :hpx-header:`libs/core/include_local/include,hpx/memory.hpp` corresponds to the C++ standard library header :cppreference-header:`memory`. It contains parallel versions of the copy, fill, move, and construct helper functions in :cppreference-header:`memory`. See :ref:`parallel_algorithms` for more information about the parallel algorithms. Functions --------- .. table:: `hpx` functions of header ``hpx/memory.hpp`` ================================================== ================================================================ `hpx` function C++ standard ================================================== ================================================================ :hpx:func:`hpx::uninitialized_copy` :cppreference-generic:`memory,uninitialized_copy` :hpx:func:`hpx::uninitialized_copy_n` :cppreference-generic:`memory,uninitialized_copy_n` :hpx:func:`hpx::uninitialized_default_construct` :cppreference-generic:`memory,uninitialized_default_construct` :hpx:func:`hpx::uninitialized_default_construct_n` :cppreference-generic:`memory,uninitialized_default_construct_n` :hpx:func:`hpx::uninitialized_fill` :cppreference-generic:`memory,uninitialized_fill` :hpx:func:`hpx::uninitialized_fill_n` :cppreference-generic:`memory,uninitialized_fill_n` :hpx:func:`hpx::uninitialized_move` :cppreference-generic:`memory,uninitialized_move` :hpx:func:`hpx::uninitialized_move_n` :cppreference-generic:`memory,uninitialized_move_n` :hpx:func:`hpx::uninitialized_value_construct` :cppreference-generic:`memory,uninitialized_value_construct` :hpx:func:`hpx::uninitialized_value_construct_n` :cppreference-generic:`memory,uninitialized_value_construct_n` ================================================== ================================================================ .. table:: `hpx::ranges` functions of header ``hpx/memory.hpp`` ========================================================== ======================================================================= `hpx::ranges` function C++ standard ========================================================== ======================================================================= :hpx:func:`hpx::ranges::uninitialized_copy` :cppreference-generic:`memory/ranges,uninitialized_copy` :hpx:func:`hpx::ranges::uninitialized_copy_n` :cppreference-generic:`memory/ranges,uninitialized_copy_n` :hpx:func:`hpx::ranges::uninitialized_default_construct` :cppreference-generic:`memory/ranges,uninitialized_default_construct` :hpx:func:`hpx::ranges::uninitialized_default_construct_n` :cppreference-generic:`memory/ranges,uninitialized_default_construct_n` :hpx:func:`hpx::ranges::uninitialized_fill` :cppreference-generic:`memory/ranges,uninitialized_fill` :hpx:func:`hpx::ranges::uninitialized_fill_n` :cppreference-generic:`memory/ranges,uninitialized_fill_n` :hpx:func:`hpx::ranges::uninitialized_move` :cppreference-generic:`memory/ranges,uninitialized_move` :hpx:func:`hpx::ranges::uninitialized_move_n` :cppreference-generic:`memory/ranges,uninitialized_move_n` :hpx:func:`hpx::ranges::uninitialized_value_construct` :cppreference-generic:`memory/ranges,uninitialized_value_construct` :hpx:func:`hpx::ranges::uninitialized_value_construct_n` :cppreference-generic:`memory/ranges,uninitialized_value_construct_n` ========================================================== ======================================================================= .. _public_api_header_hpx_numeric: ``hpx/numeric.hpp`` =================== The header :hpx-header:`libs/core/include_local/include,hpx/numeric.hpp` corresponds to the C++ standard library header :cppreference-header:`numeric`. See :ref:`parallel_algorithms` for more information about the parallel algorithms. Functions --------- .. table:: `hpx` functions of header ``hpx/numeric.hpp`` ========================================= ========================================================== `hpx` function C++ standard ========================================= ========================================================== :hpx:func:`hpx::adjacent_difference` :cppreference-generic:`algorithm,adjacent_difference` :hpx:func:`hpx::exclusive_scan` :cppreference-generic:`algorithm,exclusive_scan` :hpx:func:`hpx::inclusive_scan` :cppreference-generic:`algorithm,inclusive_scan` :hpx:func:`hpx::reduce` :cppreference-generic:`algorithm,reduce` :hpx:func:`hpx::transform_exclusive_scan` :cppreference-generic:`algorithm,transform_exclusive_scan` :hpx:func:`hpx::transform_inclusive_scan` :cppreference-generic:`algorithm,transform_inclusive_scan` :hpx:func:`hpx::transform_reduce` :cppreference-generic:`algorithm,transform_reduce` ========================================= ========================================================== .. table:: `hpx::ranges` functions of header ``hpx/numeric.hpp`` +--------------------------------------------------+ | `hpx::ranges` function | +==================================================+ | :hpx:func:`hpx::ranges::adjacent_difference` | +--------------------------------------------------+ | :hpx:func:`hpx::ranges::exclusive_scan` | +--------------------------------------------------+ | :hpx:func:`hpx::ranges::inclusive_scan` | +--------------------------------------------------+ | :hpx:func:`hpx::ranges::reduce` | +--------------------------------------------------+ | :hpx:func:`hpx::ranges::transform_exclusive_scan`| +--------------------------------------------------+ | :hpx:func:`hpx::ranges::transform_inclusive_scan`| +--------------------------------------------------+ | :hpx:func:`hpx::ranges::transform_reduce` | +--------------------------------------------------+ .. _public_api_header_hpx_optional: ``hpx/optional.hpp`` ==================== The header :hpx-header:`libs/core/include_local/include,hpx/optional.hpp` corresponds to the C++ standard library header :cppreference-header:`optional`. :hpx:type:`hpx::optional` is compatible with ``std::optional``. Constants --------- - :hpx:var:`hpx::nullopt` Classes ------- .. table:: Classes of header ``hpx/optional.hpp`` ===================================== ============================================================ Class C++ standard ===================================== ============================================================ :hpx:class:`hpx::optional` :cppreference-generic:`utility,optional` :hpx:class:`hpx::nullopt_t` :cppreference-generic:`utility,nullopt_t` :hpx:class:`hpx::bad_optional_access` :cppreference-generic:`utility/optional,bad_optional_access` ===================================== ============================================================ .. _public_api_header_hpx_runtime: ``hpx/runtime.hpp`` =================== The header :hpx-header:`libs/full/include/include,hpx/runtime.hpp` contains functions for accessing local and distributed runtime information. Typedefs -------- .. table:: Typedefs of header ``hpx/runtime.hpp`` +-----------------------------------------+ | Typedef | +=========================================+ | :hpx:type:`hpx::startup_function_type` | +-----------------------------------------+ | :hpx:type:`hpx::shutdown_function_type` | +-----------------------------------------+ Functions --------- .. table:: Functions of header ``hpx/runtime.hpp`` +--------------------------------------------------+ | Function | +==================================================+ | :hpx:func:`hpx::find_root_locality` | +--------------------------------------------------+ | :hpx:func:`hpx::find_all_localities` | +--------------------------------------------------+ | :hpx:func:`hpx::find_remote_localities` | +--------------------------------------------------+ | :hpx:func:`hpx::find_locality` | +--------------------------------------------------+ | :hpx:func:`hpx::get_colocation_id` | +--------------------------------------------------+ | :hpx:func:`hpx::get_locality_id` | +--------------------------------------------------+ | :hpx:func:`hpx::get_num_worker_threads` | +--------------------------------------------------+ | :hpx:func:`hpx::get_worker_thread_num` | +--------------------------------------------------+ | :hpx:func:`hpx::get_thread_name` | +--------------------------------------------------+ | :hpx:func:`hpx::register_pre_startup_function` | +--------------------------------------------------+ | :hpx:func:`hpx::register_startup_function` | +--------------------------------------------------+ | :hpx:func:`hpx::register_pre_shutdown_function` | +--------------------------------------------------+ | :hpx:func:`hpx::register_shutdown_function` | +--------------------------------------------------+ | :hpx:func:`hpx::get_num_localities` | +--------------------------------------------------+ | :hpx:func:`hpx::get_locality_name` | +--------------------------------------------------+ .. _public_api_header_hpx_scope: ``hpx/experimental/scope.hpp`` ============================== The header :hpx-header:`libs/core/include_local/include,hpx/experimental/scope.hpp` corresponds to the C++ standard library header :cppreference-header:`experimental/scope`. Classes ------- .. table:: Classes of header ``hpx/scope.hpp`` ============================================== ================================================== Class C++ standard ============================================== ================================================== :hpx:class:`hpx::experimental::scope_exit` :cppreference-generic:`experimental,scope_exit` :hpx:class:`hpx::experimental::scope_fail` :cppreference-generic:`experimental,scope_fail` :hpx:class:`hpx::experimental::scope_success` :cppreference-generic:`experimental,scope_success` ============================================== ================================================== .. _public_api_header_hpx_semaphore: ``hpx/semaphore.hpp`` ===================== The header :hpx-header:`libs/core/include_local/include,hpx/semaphore.hpp` corresponds to the C++ standard library header :cppreference-header:`semaphore`. Classes ------- .. table:: Classes of header ``hpx/semaphore.hpp`` ========================================== ================================================= Class C++ standard ========================================== ================================================= :hpx:class:`hpx::binary_semaphore` :cppreference-generic:`thread,counting_semaphore` :hpx:class:`hpx::counting_semaphore` :cppreference-generic:`thread,counting_semaphore` ========================================== ================================================= .. _public_api_header_hpx_shared_mutex: ``hpx/shared_mutex.hpp`` ======================== The header :hpx-header:`libs/core/include_local/include,hpx/shared_mutex.hpp` corresponds to the C++ standard library header :cppreference-header:`shared_mutex`. Classes ------- .. table:: Classes of header ``hpx/shared_mutex.hpp`` +--------------------------------+---------------------------------------------+ | Class | C++ standard | +================================+=============================================+ | :hpx:class:`hpx::shared_mutex` | :cppreference-generic:`thread,shared_mutex` | +--------------------------------+---------------------------------------------+ .. _public_api_header_hpx_source_location: ``hpx/source_location.hpp`` =========================== The header :hpx-header:`libs/core/include_local/include,hpx/source_location.hpp` corresponds to the C++ standard library header :cppreference-header:`source_location`. Classes ------- .. table:: Classes of header ``hpx/system_error.hpp`` +-----------------------------------+-------------------------------------------------+ | Class | C++ standard | +===================================+=================================================+ | :hpx:class:`hpx::source_location` | :cppreference-generic:`utility,source_location` | +-----------------------------------+-------------------------------------------------+ .. _public_api_header_hpx_stop_token: ``hpx/stop_token.hpp`` ====================== The header :hpx-header:`libs/core/include_local/include,hpx/stop_token.hpp` corresponds to the C++ standard library header :cppreference-header:`stop_token`. Constants --------- .. table:: Constants of header ``hpx/stop_token.hpp`` +-----------------------------+--------------------------------------------------------+ | Constant | C++ standard | +=============================+========================================================+ | :hpx:var:`hpx::nostopstate` | :cppreference-generic:`thread/stop_source,nostopstate` | +-----------------------------+--------------------------------------------------------+ Classes ------- .. table:: Classes of header ``hpx/stop_token.hpp`` ================================ ======================================================== Class C++ standard ================================ ======================================================== :hpx:class:`hpx::stop_callback` :cppreference-generic:`thread,stop_callback` :hpx:class:`hpx::stop_source` :cppreference-generic:`thread,stop_source` :hpx:class:`hpx::stop_token` :cppreference-generic:`thread,stop_token` :hpx:struct:`hpx::nostopstate_t` :cppreference-generic:`thread/stop_source,nostopstate_t` ================================ ======================================================== .. _public_api_header_hpx_system_error: ``hpx/system_error.hpp`` ======================== The header :hpx-header:`libs/core/include_local/include,hpx/system_error.hpp` corresponds to the C++ standard library header :cppreference-header:`system_error`. Classes ------- .. table:: Classes of header ``hpx/system_error.hpp`` +------------------------------+------------------------------------------+ | Class | C++ standard | +==============================+==========================================+ | :hpx:class:`hpx::error_code` | :cppreference-generic:`error,error_code` | +------------------------------+------------------------------------------+ .. _public_api_header_hpx_task_block: ``hpx/task_block.hpp`` ====================== The header :hpx-header:`libs/core/include_local/include,hpx/task_block.hpp` corresponds to the ``task_block`` feature in |cpp17_n4755|_. See :ref:`using_task_block` for more details on using task blocks. Classes ------- .. table:: Classes of header ``hpx/task_block.hpp`` +---------------------------------------------------------+ | Class | +=========================================================+ | :hpx:class:`hpx::experimental::task_canceled_exception` | +---------------------------------------------------------+ | :hpx:class:`hpx::experimental::task_block` | +---------------------------------------------------------+ Functions --------- .. table:: Functions of header ``hpx/task_block.hpp`` +-----------------------------------------------------------------+ | Function | +=================================================================+ | :hpx:func:`hpx::experimental::define_task_block` | +-----------------------------------------------------------------+ | :hpx:func:`hpx::experimental::define_task_block_restore_thread` | +-----------------------------------------------------------------+ .. _public_api_header_hpx_task_group: ``hpx/experimental/task_group.hpp`` =================================== The header :hpx-header:`libs/core/include_local/include,hpx/experimental/task_group.hpp` corresponds to the ``task_group`` feature in |oneTBB|_. Classes ------- .. table:: Classes of header ``hpx/experimental/task_group.hpp`` +---------------------------------------------------------+ | Class | +=========================================================+ | :hpx:class:`hpx::experimental::task_group` | +---------------------------------------------------------+ .. _public_api_header_hpx_thread: ``hpx/thread.hpp`` ================== The header :hpx-header:`libs/core/include_local/include,hpx/thread.hpp` corresponds to the C++ standard library header :cppreference-header:`thread`. The functionality in this header is equivalent to the standard library thread functionality, with the exception that the |hpx| equivalents are implemented on top of lightweight threads and the |hpx| runtime. Classes ------- .. table:: Classes of header ``hpx/thread.hpp`` ========================= ====================================== Class C++ standard ========================= ====================================== :hpx:class:`hpx::thread` :cppreference-generic:`thread,thread` :hpx:class:`hpx::jthread` :cppreference-generic:`thread,jthread` ========================= ====================================== Functions --------- .. table:: Functions of header ``hpx/thread.hpp`` ========================================= ========================================== Function C++ standard ========================================= ========================================== :hpx:func:`hpx::this_thread::yield` :cppreference-generic:`thread,yield` :hpx:func:`hpx::this_thread::get_id` :cppreference-generic:`thread,get_id` :hpx:func:`hpx::this_thread::sleep_for` :cppreference-generic:`thread,sleep_for` :hpx:func:`hpx::this_thread::sleep_until` :cppreference-generic:`thread,sleep_until` ========================================= ========================================== .. _public_api_header_hpx_tuple: ``hpx/tuple.hpp`` ================= The header :hpx-header:`libs/core/include_local/include,hpx/tuple.hpp` corresponds to the C++ standard library header :cppreference-header:`tuple`. :hpx:class:`hpx::tuple` can be used in CUDA device code, unlike ``std::tuple``. Constants --------- .. table:: Constants of header ``hpx/tuple.hpp`` +------------------------+----------------------------------------------+ | Constant | C++ standard | +========================+==============================================+ | :hpx:var:`hpx::ignore` | :cppreference-generic:`utility/tuple,ignore` | +------------------------+----------------------------------------------+ Classes ------- .. table:: Classes of header ``hpx/tuple.hpp`` ================================ =================================================== Class C++ standard ================================ =================================================== :hpx:struct:`hpx::tuple` :cppreference-generic:`utility,tuple` :hpx:struct:`hpx::tuple_size` :cppreference-generic:`utility,tuple_size` :hpx:struct:`hpx::tuple_element` :cppreference-generic:`utility,tuple_element` ================================ =================================================== Functions --------- .. table:: Functions of header ``hpx/tuple.hpp`` ================================= ====================================================== Function C++ standard ================================= ====================================================== :hpx:func:`hpx::make_tuple` :cppreference-generic:`utility/tuple,tuple_element` :hpx:func:`hpx::tie` :cppreference-generic:`utility/tuple,tie` :hpx:func:`hpx::forward_as_tuple` :cppreference-generic:`utility/tuple,forward_as_tuple` :hpx:func:`hpx::tuple_cat` :cppreference-generic:`utility/tuple,tuple_cat` :hpx:func:`hpx::get` :cppreference-generic:`utility/tuple,get` ================================= ====================================================== .. _public_api_header_hpx_type_traits: ``hpx/type_traits.hpp`` ======================= The header :hpx-header:`libs/core/include_local/include,hpx/type_traits.hpp` corresponds to the C++ standard library header :cppreference-header:`type_traits`. Classes ------- .. table:: Classes of header ``hpx/type_traits.hpp`` ================================= ========================================== Class C++ standard ================================= ========================================== :hpx:struct:`hpx::is_invocable` :cppreference-generic:`types,is_invocable` :hpx:struct:`hpx::is_invocable_r` :cppreference-generic:`types,is_invocable` ================================= ========================================== .. _public_api_header_hpx_unwrap: ``hpx/unwrap.hpp`` ================== The header :hpx-header:`libs/core/include_local/include,hpx/unwrap.hpp` contains utilities for unwrapping futures. Classes ------- .. table:: Classes of header ``hpx/unwrap.hpp`` +-------------------------------------------+ | Class | +===========================================+ | :hpx:struct:`hpx::functional::unwrap` | +-------------------------------------------+ | :hpx:struct:`hpx::functional::unwrap_n` | +-------------------------------------------+ | :hpx:struct:`hpx::functional::unwrap_all` | +-------------------------------------------+ Functions --------- .. table:: Functions of header ``hpx/unwrap.hpp`` +----------------------------------+ | Function | +==================================+ | :hpx:func:`hpx::unwrap` | +----------------------------------+ | :hpx:func:`hpx::unwrap_n` | +----------------------------------+ | :hpx:func:`hpx::unwrap_all` | +----------------------------------+ | :hpx:func:`hpx::unwrapping` | +----------------------------------+ | :hpx:func:`hpx::unwrapping_n` | +----------------------------------+ | :hpx:func:`hpx::unwrapping_all` | +----------------------------------+ .. _public_api_header_hpx_version: ``hpx/version.hpp`` =================== The header :hpx-header:`libs/core/version/include,hpx/version.hpp` provides version information about |hpx|. The macros and functions provided by this header are specific to |hpx| and have no counterparts in the C++ standard library. Macros ------ .. table:: Macros of header ``hpx/version.hpp`` +----------------------------------+ | Macro | +==================================+ | :c:macro:`HPX_VERSION_MAJOR` | +----------------------------------+ | :c:macro:`HPX_VERSION_MINOR` | +----------------------------------+ | :c:macro:`HPX_VERSION_SUBMINOR` | +----------------------------------+ | :c:macro:`HPX_VERSION_FULL` | +----------------------------------+ | :c:macro:`HPX_VERSION_DATE` | +----------------------------------+ | :c:macro:`HPX_VERSION_TAG` | +----------------------------------+ | :c:macro:`HPX_AGAS_VERSION` | +----------------------------------+ Functions --------- .. table:: Functions of header ``hpx/version.hpp`` +-----------------------------------------+ | Function | +=========================================+ | :hpx:func:`hpx::major_version` | +-----------------------------------------+ | :hpx:func:`hpx::minor_version` | +-----------------------------------------+ | :hpx:func:`hpx::subminor_version` | +-----------------------------------------+ | :hpx:func:`hpx::full_version` | +-----------------------------------------+ | :hpx:func:`hpx::full_version_as_string` | +-----------------------------------------+ | :hpx:func:`hpx::tag` | +-----------------------------------------+ | :hpx:func:`hpx::agas_version` | +-----------------------------------------+ | :hpx:func:`hpx::build_type` | +-----------------------------------------+ | :hpx:func:`hpx::build_date_time` | +-----------------------------------------+ .. _public_api_header_hpx_wrap_main: ``hpx/wrap_main.hpp`` ===================== The header :hpx-header:`wrap/include,hpx/wrap_main.hpp` does not provide any direct functionality but is used for implicitly using ``main`` as the runtime entry point. See :ref:`minimal` for more details on implicitly starting the |hpx| runtime.