Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix doc return type of broadcast_to #6562

Merged
merged 1 commit into from
Nov 5, 2024
Merged

Fix doc return type of broadcast_to #6562

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions libs/full/collectives/include/hpx/collectives/broadcast.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,12 @@ namespace hpx { namespace collectives {
/// the locality id). This value is optional and
/// defaults to whatever hpx::get_locality_id() returns.
///
/// \returns This function returns a future that will become
/// \returns 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.
///
template <typename T>
hpx::future<void> broadcast_to(char const* basename, T&& local_result,
hpx::future<T> 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());
Expand All @@ -64,11 +65,12 @@ namespace hpx { namespace collectives {
/// \note The generation values from corresponding \a broadcast_to and
/// \a broadcast_from have to match.
///
/// \returns This function returns a future that will become
/// \returns 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.
///
template <typename T>
hpx::future<void> broadcast_to(communicator comm,
hpx::future<T> broadcast_to(communicator comm,
T&& local_result, this_site_arg this_site = this_site_arg(),
generation_arg generation = generation_arg());

Expand All @@ -94,11 +96,12 @@ namespace hpx { namespace collectives {
/// \note The generation values from corresponding \a broadcast_to and
/// \a broadcast_from have to match.
///
/// \returns This function returns a future that will become
/// \returns 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.
///
template <typename T>
hpx::future<void> broadcast_to(communicator comm,
hpx::future<T> broadcast_to(communicator comm,
generation_arg generation,
T&& local_result, this_site_arg this_site = this_site_arg());

Expand Down
Loading