Struct SimpleCommunicator 

pub struct SimpleCommunicator { /* private fields */ }

A communicator. In rsmpi 0.8.x this single type replaces the earlier SystemCommunicator (world) and UserCommunicator (derived) types.

Implementations

impl SimpleCommunicator

pub fn world() -> SimpleCommunicator

The world communicator for the current process.

Trait Implementations

impl AsRaw for SimpleCommunicator

type Raw = u32

The raw handle type.

fn as_raw(&self) -> u32

Obtain the raw handle.

impl Clone for SimpleCommunicator

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Communicator for SimpleCommunicator

fn size(&self) -> Rank

Number of processes in the communicator (MPI_Comm_size).

fn rank(&self) -> Rank

This process’s rank in the communicator (MPI_Comm_rank).

fn target_size(&self) -> Rank

Number of processes on the remote side (equals Communicator::size for an intra-communicator).

fn process_at_rank(&self, r: Rank) -> Process<'_>

A handle to the process with the given rank.

fn this_process(&self) -> Process<'_>

A handle to this process.

fn any_process(&self) -> AnyProcess<'_>

A handle matching any source (MPI_ANY_SOURCE), for receives.

fn group(&self) -> Group

The group underlying this communicator (MPI_Comm_group).

fn compare(&self, other: &dyn Communicator) -> CommunicatorRelation

Compare this communicator to other (MPI_Comm_compare).

fn duplicate(&self) -> SimpleCommunicator

Duplicate the communicator with a fresh context (MPI_Comm_dup). Collective over all members.

fn split_by_color(&self, color: Color) -> Option<SimpleCommunicator>

Split the communicator by colour (MPI_Comm_split). Collective.

fn split_by_color_with_key( &self, color: Color, key: Key, ) -> Option<SimpleCommunicator>

Split by colour, ordering new ranks by key then old rank (MPI_Comm_split). Collective.

fn split_by_subgroup(&self, group: &Group) -> Option<SimpleCommunicator>

Split by an explicit subgroup (MPI_Comm_create style). Collective; returns None for processes not in group.

fn abort(&self, errorcode: i32) -> !

Abort the whole job with an exit code (MPI_Abort). Notifies every peer so the entire job exits rather than leaving ranks blocked.

fn set_name(&self, name: &str)

Set the communicator’s name (MPI_Comm_set_name).

fn get_name(&self) -> String

Get the communicator’s name (MPI_Comm_get_name).

fn pack_size(&self, incount: Count, dt: DatatypeRef) -> Count

Number of bytes needed to pack incount elements of datatype dt (MPI_Pack_size).

fn pack<Buf: Buffer + ?Sized>(&self, inbuf: &Buf) -> Vec<u8>

where Self: Sized,

Pack a buffer into a freshly allocated byte vector (MPI_Pack). Since this implementation uses contiguous native layouts, packing is a copy.

fn pack_into<Buf: Buffer + ?Sized>( &self, inbuf: &Buf, outbuf: &mut [u8], position: Count, ) -> Count

where Self: Sized,

Pack a buffer into outbuf starting at byte offset position, returning the new position (MPI_Pack).

unsafe fn unpack_into<Buf: BufferMut + ?Sized>( &self, inbuf: &[u8], outbuf: &mut Buf, position: Count, ) -> Count

where Self: Sized,

Unpack from inbuf starting at byte offset position into outbuf, returning the new position (MPI_Unpack).

fn create_graph_communicator( &self, index: &[Count], edges: &[Count], ) -> Option<GraphCommunicator>

Create a graph topology communicator (MPI_Graph_create).

fn create_dist_graph_adjacent( &self, sources: &[Rank], destinations: &[Rank], ) -> DistGraphCommunicator

Create a distributed-graph topology where this rank receives from sources and sends to destinations (MPI_Dist_graph_create_adjacent). Collective; each rank supplies its own adjacency.

fn split_intercommunicator(&self, in_group_a: bool) -> InterCommunicator

Collectively split this communicator into an inter-communicator between two disjoint groups. Ranks passing true form one group (“A”); the rest form the other. Each rank’s InterCommunicator has the other group as its remote group (MPI_Intercomm_create-style, collective).

fn create_cartesian_communicator( &self, dims: &[Count], periods: &[bool], _reorder: bool, ) -> Option<CartesianCommunicator>

Create a Cartesian topology communicator (MPI_Cart_create).

fn parent(&self) -> Option<InterCommunicator>

If this process was created by crate::collective::Root::spawn, return the inter-communicator to the parent group (MPI_Comm_get_parent). The local group is this world; the remote group is the spawner.