mpi4py.MPI.Info¶
- class mpi4py.MPI.Info(info=None)¶
Bases:
object
Info object
Methods Summary
Create
()Create a new, empty 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[, maxlen])Retrieve the value associated with a key
Return the number of currently defined keys in info
Get_nthkey
(n)Return the nth defined key in info.
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
- 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
- Free()¶
Free a info object
- Return type
None
- Get(key, maxlen=- 1)¶
Retrieve the value associated with a key
- Parameters
key (str) –
maxlen (int) –
- 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
- 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
- get(key, default=None)¶
info get
- Parameters
key (str) –
default (Optional[str]) –
- 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
other (Union[Info, Mapping[str, str], Iterable[Tuple[str, str]]]) –
kwds (str) –
- Return type
None
- values()¶
info values
- Return type
List[str]