Struct mpi::topology::InterCommunicator

pub struct InterCommunicator(/* private fields */);

A communicator for inter-communication, which represents a point-to-point communication between disjoint groups

Standard Sections

6.6

Implementations

impl InterCommunicator

pub unsafe fn try_from_raw(raw: MPI_Comm) -> Option<Self>

Construct an InterCommunicator from a raw handle

pub fn remote_size(&self) -> Rank

The number of processes in the remote group of comm

Standard Section(s)

6.6.1, See MPI_Comm_remote_size

pub fn remote_group(&self) -> UserGroup

The remote group corresponding to the intercomm

Standard Section(s)

6.6.1, See MPI_Comm_remote_group

pub fn merge(&self, merge_order: MergeOrder) -> SimpleCommunicator

Merge an InterCommunicator into a single UserCommunicator

To specify the ordering of merged ranks, every member of the one group should call with MergeOrder::Low and every member of the other group should use MergeOrder::High.

Standard section(s)

7.6.2

Trait Implementations

impl AsCommunicator for InterCommunicator

type Out = InterCommunicator

The type of the associated communicator

fn as_communicator(&self) -> &Self::Out

Returns the associated communicator.

impl AsRaw for InterCommunicator

type Raw = *mut ompi_communicator_t

The raw MPI C API type

fn as_raw(&self) -> Self::Raw

The raw value

impl Communicator for InterCommunicator

fn target_size(&self) -> Rank

Returns the number of processes available to communicate with in this Communicator. For intra-communicators, this is equivalent to size. For inter-communicators, this is equivalent to remote_size.

fn size(&self) -> Rank

Number of processes in this communicator

fn rank(&self) -> Rank

The Rank that identifies the calling process within this communicator

fn get_attr<A: Attribute>(&self, key: A) -> Option<&<A as Attribute>::Target>

where Self: Sized,

Get Attribute

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

where Self: Sized,

Bundles a reference to this communicator with a specific Rank into a Process.

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

where Self: Sized,

Returns an AnyProcess identifier that can be used, e.g. as a Source in point to point communication.

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

where Self: Sized,

A Process for the calling process

fn compare<C>(&self, other: &C) -> CommunicatorRelation

where C: Communicator + ?Sized, Self: Sized,

Compare two communicators.

fn duplicate(&self) -> SimpleCommunicator

Duplicate a communicator.

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

Split a communicator by color.

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

Split a communicator by color.

fn split_shared(&self, key: c_int) -> SimpleCommunicator

Split the communicator into subcommunicators, each of which can create a shared memory region.

fn split_by_subgroup_collective<G>( &self, group: &G ) -> Option<SimpleCommunicator>

where G: Group + ?Sized, Self: Sized,

Split a communicator collectively by subgroup.

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

where G: Group + ?Sized, Self: Sized,

Split a communicator by subgroup.

fn split_by_subgroup_with_tag<G>( &self, group: &G, tag: Tag ) -> Option<SimpleCommunicator>

where G: Group + ?Sized, Self: Sized,

Split a communicator by subgroup

fn group(&self) -> UserGroup

The group associated with this communicator

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

Abort program execution

fn test_inter(&self) -> bool

Tests if the communicator is an inter-communicator.

fn set_name(&self, name: &str)

Set the communicator name

fn get_name(&self) -> String

Get the communicator name

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

Creates a communicator with ranks laid out in a multi-dimensional space, allowing for easy neighbor-to-neighbor communication, while providing MPI with information to allow it to better optimize the physical locality of ranks that are logically close.

fn cartesian_map(&self, dims: &[Count], periods: &[bool]) -> Option<Rank>

Gets the target rank of this rank as-if create_cartesian_communicator had been called with dims, periods, and reorder = true.

fn pack_size<Dt>(&self, incount: Count, datatype: &Dt) -> Count

where Dt: Datatype, Self: Sized,

Gets the implementation-defined buffer size required to pack ‘incount’ elements of type ‘datatype’.

fn pack<Buf>(&self, inbuf: &Buf) -> Vec<u8>

where Buf: ?Sized + Buffer, Self: Sized,

Packs inbuf into a byte array with an implementation-defined format. Often paired with unpack to convert back into a specific datatype.

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

where Buf: ?Sized + Buffer, Self: Sized,

Packs inbuf into a byte array with an implementation-defined format. Often paired with unpack to convert back into a specific datatype.

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

where Buf: ?Sized + BufferMut, Self: Sized,

Unpacks an implementation-specific byte array from pack or pack_into into a buffer of a specific datatype.

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

Returns the parent Communicator, if any

impl FromRaw for InterCommunicator

unsafe fn from_raw(handle: <Self as AsRaw>::Raw) -> Self

Construct an InterCommunicator from a raw handle without checking if it’s an Intercomm handle

Safety

• handle must be a live MPI_Comm object.
• handle must be an inter-comms or inter-comm parent handle
• handle must not be used after calling from_raw.