hpx/collectives/broadcast.hpp¶
See Public API for a list of names and headers that are part of the public HPX API.
-
namespace
hpx
-
namespace
collectives
Functions
-
template<typename
T
>
hpx::future<void>broadcast_to
(char const *basename, T &&local_result, num_sites_arg num_sites = num_sites_arg(), this_site_arg this_site = this_site_arg(), generation_arg generation = generation_arg())¶ Broadcast a value to different call sites
This function sends a set of values to all call sites operating on the given base name.
- Return
This function returns a future that will become ready once the broadcast operation has been completed.
- Parameters
basename
: The base name identifying the broadcast operationlocal_result
: A value to transmit to all participating sites from this call site.num_sites
: The number of participating sites (default: all localities).generation
: The generational counter identifying the sequence number of the broadcast operation performed on the given base name. This is optional and needs to be supplied only if the broadcast operation on the given base name has to be performed more than once.this_site
: The sequence number of this invocation (usually the locality id). This value is optional and defaults to whatever hpx::get_locality_id() returns.
-
template<typename
T
>
hpx::future<void>broadcast_to
(communicator comm, T &&local_result, this_site_arg this_site = this_site_arg())¶ Broadcast a value to different call sites
This function sends a set of values to all call sites operating on the given base name.
- Return
This function returns a future that will become ready once the broadcast operation has been completed.
- Parameters
comm
: A communicator object returned from create_communicatorlocal_result
: A value to transmit to all participating sites from this call site.this_site
: The sequence number of this invocation (usually the locality id). This value is optional and defaults to whatever hpx::get_locality_id() returns.
-
template<typename
T
>
hpx::future<T>broadcast_from
(char const *basename, this_site_arg this_site = this_site_arg(), generation_arg generation = generation_arg())¶ Receive a value that was broadcast to different call sites
This function sends a set of values to all call sites operating on the given base name.
- Return
This function returns a future holding the value that was sent to all participating sites. It will become ready once the broadcast operation has been completed.
- Parameters
basename
: The base name identifying the broadcast operationgeneration
: The generational counter identifying the sequence number of the broadcast operation performed on the given base name. This is optional and needs to be supplied only if the broadcast operation on the given base name has to be performed more than once.this_site
: The sequence number of this invocation (usually the locality id). This value is optional and defaults to whatever hpx::get_locality_id() returns.
-
template<typename
T
>
hpx::future<T>broadcast_from
(communicator comm, this_site_arg this_site = this_site_arg())¶ Receive a value that was broadcast to different call sites
This function sends a set of values to all call sites operating on the given base name.
- Return
This function returns a future holding the value that was sent to all participating sites. It will become ready once the broadcast operation has been completed.
- Parameters
comm
: A communicator object returned from create_communicatorthis_site
: The sequence number of this invocation (usually the locality id). This value is optional and defaults to whatever hpx::get_locality_id() returns.
-
template<typename
-
namespace