vt::objgroup::proxy::Proxy struct

A indexable proxy to object instances on all nodes that are tied together with a common ID.

After creating an objgroup, a Proxy<ObjT> is returned which can be used to perform distributed operations on that object instance across all nodes.

Proxies are very inexpensive to copy and move around the system.

Public types

using ObjGroupType = ObjT
using ReduceStamp = collective::reduce::ReduceStamp
using PendingSendType = messaging::PendingSend

Constructors, destructors, conversion operators

Proxy() defaulted
Proxy(Proxy const&) defaulted
Proxy(Proxy&&) defaulted
Proxy(ObjGroupProxyType in_proxy) explicit: Create a new proxy, called by the system.

Public functions

auto operator=(Proxy const&) -> Proxy& defaulted
template<typename MsgT, ActiveObjType<MsgT, ObjT> fn> void broadcast(MsgT* msg) const: Broadcast a message to all nodes to be delivered to the local object instance.
template<typename MsgT, ActiveObjType<MsgT, ObjT> fn> void broadcast(MsgPtr<MsgT> msg) const: Broadcast a message to all nodes to be delivered to the local object instance.
template<typename MsgT, ActiveObjType<MsgT, ObjT> fn> auto broadcastMsg(messaging::MsgPtrThief<MsgT> msg) const -> PendingSendType: Broadcast a message to all nodes to be delivered to the local object instance.
template<auto fn> auto broadcastMsg(messaging::MsgPtrThief<typename ObjFuncTraits<decltype(fn)>::MsgT> msg) const -> PendingSendType: Broadcast a message to all nodes to be delivered to the local object instance.
template<typename MsgT, ActiveObjType<MsgT, ObjT> fn, typename... Args> auto broadcast(Args && ... args) const -> PendingSendType: Broadcast a message to all nodes to be delivered to the local object instance.
template<auto fn, typename... Args> auto broadcast(Args && ... args) const -> PendingSendType: Broadcast a message to all nodes to be delivered to the local object instance.
template<auto fn, typename... Args> auto multicast(GroupType type, Args && ... args) const -> PendingSendType: Multicast a message to nodes that are part of given group to be delivered to the local object instance.
template<auto fn, typename... Args> auto multicast(group::region::Region::RegionUPtrType&& nodes, Args && ... args) const -> PendingSendType: Multicast a message to nodes specified by the region to be delivered to the local object instance.
template<auto f, template<typename Arg> class Op = collective::NoneOp, typename... Args> auto allreduce(Args && ... args) const -> PendingSendType: All-reduce back to this objgroup. Performs a reduction using operator Op followed by a broadcast to f with the result.
template<auto f, template<typename Arg> class Op = collective::NoneOp, typename Target, typename... Args> auto reduce(Target target, Args && ... args) const -> PendingSendType: Reduce back to a point target. Performs a reduction using operator Op followed by a send to f with the result.
template<template<typename Arg> class Op = collective::NoneOp, typename... CBArgs, typename... Args> auto reduce(vt::Callback<CBArgs...> cb, Args && ... args) const -> PendingSendType: Reduce back to an arbitrary callback. Performs a reduction using operator Op and then delivers the result to the callback cb.
template<typename OpT = collective::None, typename MsgPtrT, typename MsgT, ActiveTypedFnType<MsgT>* f> auto reduce(MsgPtrT msg, Callback<MsgT> cb, ReduceStamp stamp = ReduceStamp{}) const -> PendingSendType: Reduce over the objgroup instances on each node with a callback target.
template<typename OpT = collective::None, typename MsgPtrT, typename MsgT = typename util::MsgPtrType<MsgPtrT>::MsgType> auto reduce(MsgPtrT msg, Callback<MsgT> cb, ReduceStamp stamp = ReduceStamp{}) const -> PendingSendType
template<typename OpT = collective::None, typename FunctorT, typename MsgPtrT, typename MsgT = typename util::MsgPtrType<MsgPtrT>::MsgType, ActiveTypedFnType<MsgT>* f> auto reduce(MsgPtrT msg, ReduceStamp stamp = ReduceStamp{}) const -> PendingSendType: Reduce over the objgroup instances on each node with a functor target.
template<typename OpT = collective::None, typename FunctorT, typename MsgPtrT, typename MsgT = typename util::MsgPtrType<MsgPtrT>::MsgType> auto reduce(MsgPtrT msg, ReduceStamp stamp = ReduceStamp{}) const -> PendingSendType
template<typename MsgPtrT, typename MsgT = typename util::MsgPtrType<MsgPtrT>::MsgType, ActiveTypedFnType<MsgT>* f> auto reduce(MsgPtrT msg, ReduceStamp stamp = ReduceStamp{}) const -> PendingSendType: Reduce over the objgroup instance on each node with target specified in reduction message type.
auto get() const -> ObjT*: Get raw pointer to the local object instance residing on the current node.
auto getProxy() const -> ObjGroupProxyType: Get the underlying proxy bits that are used to identify the objgroup.
template<typename BaseT> auto castToBase() const -> Proxy<BaseT>: Cast typed proxy to the base class type for this objgroup.
void destroyCollective() const: Collective destroy this objgroup instance on all nodes.
template<typename T> auto makeHandleRDMA(std::size_t count, bool is_uniform) const -> vt::rdma::Handle<T>: Make a new RDMA handle for this objgroup—a collective invocation.
template<typename T> void destroyHandleRDMA(vt::rdma::Handle<T> handle) const: Destroy an RDMA handle created from this objgroup.
template<typename T> auto makeHandleSetRDMA(int32_t max_elm, std::unordered_map<int32_t, std::size_t> const& map, bool is_uniform) const -> vt::rdma::HandleSet<T>: Make a new set of RDMA handles for this objgroup—a collective invocation. This is the overload for a potentially sparse set of handles with a non-zero starting index.
template<typename T> auto makeHandleSetRDMA(int32_t max_elm, std::vector<std::size_t> const& vec, bool is_uniform) const -> vt::rdma::HandleSet<T>: Make a new set of RDMA handles for this objgroup—a collective invocation. This is the overload for a dense, start at zero set of handles to create.
template<typename T> void destroyHandleSetRDMA(vt::rdma::HandleSet<T> handle) const: Destroy a set of RDMA handles created from this objgroup.
auto operator[](NodeType node) const -> ProxyElm<ObjT>: Index the proxy to get the element proxy for a particular node.
auto operator()(NodeType node) const -> ProxyElm<ObjT>: Index the proxy to get the element proxy for a particular node.
template<typename Serializer> void serialize(Serializer& s)

Function documentation