Struct UserCommunicator

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

A user-defined communicator

Standard section(s)

6.4

Implementations

impl UserCommunicator

pub unsafe fn from_raw(raw: MPI_Comm) -> Option<UserCommunicator>

If the raw value is the null handle returns None

Safety

• raw must be a live MPI_Comm object.
• raw must not be used after calling from_raw.

pub fn topology(&self) -> Topology

Gets the topology of the communicator.

Standard section(s)

7.5.5

Panics

Unexpected Topology type

pub fn into_topology(self) -> IntoTopology

Converts the communicator into its precise communicator type.

Standard section(s)

7.5.5

Panics

Unexpected Topology type

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 = *mut ompi_communicator_t

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

where C: Communicator + ?Sized,

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_shared(&self, key: c_int) -> UserCommunicator

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

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

where G: Group + ?Sized,

Split a communicator collectively by subgroup.

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

where G: Group + ?Sized,

Split a communicator by subgroup.

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

where G: Group + ?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 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,

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,

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,

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,

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

impl Drop for UserCommunicator

fn drop(&mut self)

Executes the destructor for this type.

impl From<CartesianCommunicator> for UserCommunicator

fn from(cart_comm: CartesianCommunicator) -> Self

Converts to this type from the input type.