Struct mpi::datatype::UserDatatype

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

A user defined MPI datatype

Standard section(s)

4

Implementations

impl UserDatatype

pub fn contiguous<D>(count: Count, oldtype: &D) -> UserDatatype

where D: UncommittedDatatype,

Constructs a new datatype by concatenating count repetitions of oldtype

Examples

See examples/contiguous.rs

Standard section(s)

4.1.2

pub fn vector<D>( count: Count, blocklength: Count, stride: Count, oldtype: &D ) -> UserDatatype

where D: UncommittedDatatype,

Construct a new datatype out of count blocks of blocklength elements of oldtype concatenated with the start of consecutive blocks placed stride elements apart.

Examples

See examples/vector.rs

Standard section(s)

4.1.2

pub fn heterogeneous_vector<D>( count: Count, blocklength: Count, stride: Address, oldtype: &D ) -> UserDatatype

where D: UncommittedDatatype,

Like vector() but stride is given in bytes rather than elements of oldtype.

Standard section(s)

4.1.2

pub fn indexed<D>( blocklengths: &[Count], displacements: &[Count], oldtype: &D ) -> UserDatatype

where D: UncommittedDatatype,

Constructs a new type out of multiple blocks of individual length and displacement. Block i will be blocklengths[i] items of datytpe oldtype long and displaced by dispplacements[i] items of the oldtype.

Standard section(s)

4.1.2

pub fn heterogeneous_indexed<D>( blocklengths: &[Count], displacements: &[Address], oldtype: &D ) -> UserDatatype

where D: UncommittedDatatype,

Constructs a new type out of multiple blocks of individual length and displacement. Block i will be blocklengths[i] items of datytpe oldtype long and displaced by dispplacements[i] bytes.

Standard section(s)

4.1.2

pub fn indexed_block<D>( blocklength: Count, displacements: &[Count], oldtype: &D ) -> UserDatatype

where D: UncommittedDatatype,

Construct a new type out of blocks of the same length and individual displacements.

Standard section(s)

4.1.2

pub fn heterogeneous_indexed_block<D>( blocklength: Count, displacements: &[Address], oldtype: &D ) -> UserDatatype

where D: UncommittedDatatype,

Construct a new type out of blocks of the same length and individual displacements. Displacements are in bytes.

Standard section(s)

4.1.2

pub fn structured<D>( blocklengths: &[Count], displacements: &[Address], types: &[D] ) -> UserDatatype

where D: UncommittedDatatype + MatchesRaw<Raw = MPI_Datatype>,

Constructs a new datatype out of blocks of different length, displacement and datatypes

Examples

See examples/structured.rs

Standard section(s)

4.1.2

pub fn as_ref(&self) -> DatatypeRef<'_>

Creates a DatatypeRef from this datatype object.

Trait Implementations

impl AsRaw for UserDatatype

type Raw = *mut ompi_datatype_t

The raw MPI C API type

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

The raw value

impl Clone for UserDatatype

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for UserDatatype

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&'a UserDatatype> for DatatypeRef<'a>

fn from(datatype: &'a UserDatatype) -> Self

Converts to this type from the input type.

impl<'a> From<&'a UserDatatype> for UncommittedDatatypeRef<'a>

fn from(datatype: &'a UserDatatype) -> Self

Converts to this type from the input type.

impl FromRaw for UserDatatype

unsafe fn from_raw(handle: MPI_Datatype) -> Self

Constructs the Rust type, with all its semantics, from the raw MPI type.

impl UncommittedDatatype for UserDatatype

type DuplicatedDatatype = UserDatatype

The type returned when the datatype is duplicated.

fn dup(&self) -> Self::DuplicatedDatatype

Creates a new datatype with the same key-values as this datatype.

impl Datatype for UserDatatype

impl MatchesRaw for UserDatatype

impl Send for UserDatatype

impl Sync for UserDatatype