Skip to content

Commit

Permalink
Add doxygen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dimitraka committed Oct 13, 2023
1 parent 9dea135 commit 8392d50
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
18 changes: 18 additions & 0 deletions libs/full/collectives/include/hpx/collectives/argument_types.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,29 @@ namespace hpx::collectives {
struct arity_tag;
} // namespace detail

/// The number of participating sites (default: all localities)
using num_sites_arg = detail::argument_type<detail::num_sites_tag>;

/// The local end of the communication channel
using this_site_arg = detail::argument_type<detail::this_site_tag>;

/// The opposite end of the communication channel
using that_site_arg = detail::argument_type<detail::that_site_tag>;

/// The generational counter identifying the sequence number of the
/// operation performed on the given base name. It needs to be supplied
/// only if the operation on the given base name has to be performed
/// more than once. It must be a positive number greater than zero.
using generation_arg = detail::argument_type<detail::generation_tag>;

/// The site that is responsible for creating the support object
/// of the operation. It defaults to '0' (zero).
using root_site_arg = detail::argument_type<detail::root_site_tag, 0>;

/// The tag identifying the concrete operation
using tag_arg = detail::argument_type<detail::tag_tag, 0>;

/// The number of children each of the communication nodes is connected
/// to (default: picked based on num_sites).
using arity_arg = detail::argument_type<detail::arity_tag>;
} // namespace hpx::collectives
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ namespace hpx { namespace collectives {

///////////////////////////////////////////////////////////////////////////
// forward declarations
/// a handle identifying the communication channel to use for get/set
/// operations
class channel_communicator;

template <typename T>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ struct hpx::util::extra_data_helper<hpx::collectives::detail::communicator_data>
namespace hpx::collectives {

///////////////////////////////////////////////////////////////////////////
/// a handle identifying the communication channel to use for a particular
/// collective operation
struct communicator
: hpx::components::client_base<communicator, detail::communicator_server,
detail::communicator_data>
Expand Down

0 comments on commit 8392d50

Please sign in to comment.