mpi4py.MPI.Info

class mpi4py.MPI.Info(info=None)

Bases: object

Info object

Parameters

info (Optional[Info]) –

Return type

Info

static __new__(cls, info=None)
Parameters

info (Optional[Info]) –

Return type

Info

Methods Summary

Create()

Create a new, empty info object

Create_env([args])

Create a new info object

Delete(key)

Remove a (key, value) pair from info

Dup()

Duplicate an existing info object, creating a new object, with the same (key, value) pairs and the same ordering of keys

Free()

Free a info object

Get(key)

Retrieve the value associated with a key

Get_nkeys()

Return the number of currently defined keys in info

Get_nthkey(n)

Return the nth defined key in info.

Get_string(key)

Retrieve the value associated with a key

Set(key, value)

Add the (key, value) pair to info, and overrides the value if a value for the same key was previously set

clear()

info clear

copy()

info copy

f2py(arg)

get(key[, default])

info get

items()

info items

keys()

info keys

pop(key, *default)

info pop

popitem()

info popitem

py2f()

update([other])

info update

values()

info values

Methods Documentation

classmethod Create()

Create a new, empty info object

Return type

Info

classmethod Create_env(args=None)

Create a new info object

Parameters

args (Optional[Sequence[str]]) –

Return type

Info

Delete(key)

Remove a (key, value) pair from info

Parameters

key (str) –

Return type

None

Dup()

Duplicate an existing info object, creating a new object, with the same (key, value) pairs and the same ordering of keys

Return type

Info

Free()

Free a info object

Return type

None

Get(key)

Retrieve the value associated with a key

Parameters

key (str) –

Return type

Optional[str]

Get_nkeys()

Return the number of currently defined keys in info

Return type

int

Get_nthkey(n)

Return the nth defined key in info. Keys are numbered in the range [0, N) where N is the value returned by Info.Get_nkeys()

Parameters

n (int) –

Return type

str

Get_string(key)

Retrieve the value associated with a key

Parameters

key (str) –

Return type

Optional[str]

Set(key, value)

Add the (key, value) pair to info, and overrides the value if a value for the same key was previously set

Parameters
  • key (str) –

  • value (str) –

Return type

None

clear()

info clear

Return type

None

copy()

info copy

Return type

Info

classmethod f2py(arg)
Parameters

arg (int) –

Return type

Info

get(key, default=None)

info get

Parameters
Return type

Optional[str]

items()

info items

Return type

List[Tuple[str, str]]

keys()

info keys

Return type

List[str]

pop(key, *default)

info pop

Parameters
  • key (str) –

  • default (str) –

Return type

str

popitem()

info popitem

Return type

Tuple[str, str]

py2f()
Return type

int

update(other=(), **kwds)

info update

Parameters
Return type

None

values()

info values

Return type

List[str]