Struct mpi::topology::UserCommunicator

pub struct UserCommunicator(_);

A user-defined communicator

Standard section(s)

6.4

Trait Implementations

impl AsCommunicator for UserCommunicator

type Out = UserCommunicator

The type of the associated communicator

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

Returns the associated communicator.

impl AsRaw for UserCommunicator

type Raw = MPI_Comm

The raw MPI C API type

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

The raw value

impl Communicator for UserCommunicator

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 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: ?Sized>(&self, other: &C) -> CommunicatorRelation where C: Communicator

Compare two communicators.

fn duplicate(&self) -> UserCommunicator

Duplicate a communicator.

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

Split a communicator by color.

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

Split a communicator by color.

fn split_by_subgroup_collective<G: ?Sized>(&self,
                                           group: &G)
                                           -> Option<UserCommunicator> where G: Group

Split a communicator collectively by subgroup.

fn split_by_subgroup<G: ?Sized>(&self, group: &G) -> Option<UserCommunicator> where G: Group

Split a communicator by subgroup.

fn split_by_subgroup_with_tag<G: ?Sized>(&self,
                                         group: &G,
                                         tag: Tag)
                                         -> Option<UserCommunicator> where G: Group

Split a communicator by subgroup

fn group(&self) -> UserGroup

The group associated with this communicator

fn abort(&self, errorcode: c_int)

Abort program execution

impl Drop for UserCommunicator

fn drop(&mut self)

A method called when the value goes out of scope.