mpi.info: MPI_Info_create, MPI_Info_free, MPI_Info_get, MPI_Info_set...

In Rmpi: Interface (Wrapper) to MPI (Message-Passing Interface)

MPI_Info_create, MPI_Info_free, MPI_Info_get, MPI_Info_set APIs

Description

Many MPI APIs take an info argument for additional information passing. An info is an object which consists of many (key,value) pairs. Rmpi uses an internal memory to store an info object.

mpi.info.create creates a new info object.

mpi.info.free frees an info object and sets it to MPI_INFO_NULL.

mpi.info.get retrieves the value associated with key in an info.

mpi.info.set adds the key and value pair to info.

Usage

  mpi.info.create(info = 0)
  mpi.info.free(info = 0)
  mpi.info.get(info = 0, key, valuelen)
  mpi.info.set(info = 0, key, value)

Arguments

info	an info number.
key	a char (length 1).
valuelen	the length (nchar) of a key
value	a char (length 1).

Value

mpi.info.create, mpi.info.free, and mpi.info.set return 1 if success and 0 otherwise.

mpi.info.get returns the value (a char) for a given info and valuelen.

Author(s)

Hao Yu

See Also

mpi.spawn.Rslaves

Rmpi documentation built on April 1, 2023, 12:20 a.m.