mpi4py.MPI.Win
- class mpi4py.MPI.Win
Bases:
object
Remote memory access context.
Methods Summary
Accumulate
(origin, target_rank[, target, op])Accumulate data into the target process.
Allocate
(size[, disp_unit, info, comm])Create an window object for one-sided communication.
Allocate_shared
(size[, disp_unit, info, comm])Create an window object for one-sided communication.
Attach
(memory)Attach a local memory region.
Call_errhandler
(errorcode)Call the error handler installed on a window.
Compare_and_swap
(origin, compare, result, ...)Perform one-sided atomic compare-and-swap.
Complete
()Complete an RMA operation begun after an
Start
.Create
(memory[, disp_unit, info, comm])Create an window object for one-sided communication.
Create_dynamic
([info, comm])Create an window object for one-sided communication.
Create_errhandler
(errhandler_fn)Create a new error handler for windows.
Create_keyval
([copy_fn, delete_fn, nopython])Create a new attribute key for windows.
Delete_attr
(keyval)Delete attribute value associated with a key.
Detach
(memory)Detach a local memory region.
Fence
([assertion])Perform an MPI fence synchronization on a window.
Fetch_and_op
(origin, result, target_rank[, ...])Perform one-sided read-modify-write.
Flush
(rank)Complete all outstanding RMA operations at a target.
Complete all outstanding RMA operations at all targets.
Flush_local
(rank)Complete locally all outstanding RMA operations at a target.
Complete locally all outstanding RMA operations at all targets.
Free
()Free a window.
Free_keyval
(keyval)Free an attribute key for windows.
Get
(origin, target_rank[, target])Get data from a memory window on a remote process.
Get_accumulate
(origin, result, target_rank)Fetch-and-accumulate data into the target process.
Get_attr
(keyval)Retrieve attribute value by key.
Get the error handler for a window.
Access the group of processes that created the window.
Get_info
()Return the current hints for a window.
Get_name
()Get the print name for this window.
Lock
(rank[, lock_type, assertion])Begin an RMA access epoch at the target process.
Lock_all
([assertion])Begin an RMA access epoch at all processes.
Post
(group[, assertion])Start an RMA exposure epoch.
Put
(origin, target_rank[, target])Put data into a memory window on a remote process.
Raccumulate
(origin, target_rank[, target, op])Fetch-and-accumulate data into the target process.
Rget
(origin, target_rank[, target])Get data from a memory window on a remote process.
Rget_accumulate
(origin, result, target_rank)Accumulate data into the target process using remote memory access.
Rput
(origin, target_rank[, target])Put data into a memory window on a remote process.
Set_attr
(keyval, attrval)Store attribute value associated with a key.
Set_errhandler
(errhandler)Set the error handler for a window.
Set_info
(info)Set new values for the hints associated with a window.
Set_name
(name)Set the print name for this window.
Shared_query
(rank)Query the process-local address for remote memory segments.
Start
(group[, assertion])Start an RMA access epoch for MPI.
Sync
()Synchronize public and private copies of the window.
Test
()Test whether an RMA exposure epoch has completed.
Unlock
(rank)Complete an RMA access epoch at the target process.
Complete an RMA access epoch at all processes.
Wait
()Complete an RMA exposure epoch begun with
Post
.f2py
(arg)free
()Call
Free
if not null.fromhandle
(handle)Create object from MPI handle.
py2f
()tomemory
()Return window memory buffer.
Attributes Summary
Attributes.
Create flavor.
Group.
Group rank.
Group size.
MPI handle.
Info hints.
Memory model.
Print name.
Methods Documentation
- Accumulate(origin, target_rank, target=None, op=SUM)
Accumulate data into the target process.
- classmethod Allocate(size, disp_unit=1, info=INFO_NULL, comm=COMM_SELF)
Create an window object for one-sided communication.
Create an window object for one-sided communication.
- Call_errhandler(errorcode)
Call the error handler installed on a window.
- Compare_and_swap(origin, compare, result, target_rank, target_disp=0)
Perform one-sided atomic compare-and-swap.
- classmethod Create(memory, disp_unit=1, info=INFO_NULL, comm=COMM_SELF)
Create an window object for one-sided communication.
- classmethod Create_dynamic(info=INFO_NULL, comm=COMM_SELF)
Create an window object for one-sided communication.
- classmethod Create_errhandler(errhandler_fn)
Create a new error handler for windows.
- Parameters:
- Return type:
- classmethod Create_keyval(copy_fn=None, delete_fn=None, nopython=False)
Create a new attribute key for windows.
- Delete_attr(keyval)
Delete attribute value associated with a key.
- Fence(assertion=0)
Perform an MPI fence synchronization on a window.
- Fetch_and_op(origin, result, target_rank, target_disp=0, op=SUM)
Perform one-sided read-modify-write.
- Flush(rank)
Complete all outstanding RMA operations at a target.
- Flush_local(rank)
Complete locally all outstanding RMA operations at a target.
- Flush_local_all()
Complete locally all outstanding RMA operations at all targets.
- Return type:
- classmethod Free_keyval(keyval)
Free an attribute key for windows.
- Get(origin, target_rank, target=None)
Get data from a memory window on a remote process.
- Parameters:
origin (BufSpec)
target_rank (int)
target (TargetSpec | None)
- Return type:
- Get_accumulate(origin, result, target_rank, target=None, op=SUM)
Fetch-and-accumulate data into the target process.
- Get_attr(keyval)
Retrieve attribute value by key.
- Get_errhandler()
Get the error handler for a window.
- Return type:
- Lock(rank, lock_type=LOCK_EXCLUSIVE, assertion=0)
Begin an RMA access epoch at the target process.
- Lock_all(assertion=0)
Begin an RMA access epoch at all processes.
- Post(group, assertion=0)
Start an RMA exposure epoch.
- Put(origin, target_rank, target=None)
Put data into a memory window on a remote process.
- Parameters:
origin (BufSpec)
target_rank (int)
target (TargetSpec | None)
- Return type:
- Raccumulate(origin, target_rank, target=None, op=SUM)
Fetch-and-accumulate data into the target process.
- Rget(origin, target_rank, target=None)
Get data from a memory window on a remote process.
- Parameters:
origin (BufSpec)
target_rank (int)
target (TargetSpec | None)
- Return type:
- Rget_accumulate(origin, result, target_rank, target=None, op=SUM)
Accumulate data into the target process using remote memory access.
- Rput(origin, target_rank, target=None)
Put data into a memory window on a remote process.
- Parameters:
origin (BufSpec)
target_rank (int)
target (TargetSpec | None)
- Return type:
- Set_attr(keyval, attrval)
Store attribute value associated with a key.
- Set_errhandler(errhandler)
Set the error handler for a window.
- Parameters:
errhandler (Errhandler)
- Return type:
- Set_info(info)
Set new values for the hints associated with a window.
Query the process-local address for remote memory segments.
- Start(group, assertion=0)
Start an RMA access epoch for MPI.
- Unlock(rank)
Complete an RMA access epoch at the target process.
- classmethod fromhandle(handle)
Create object from MPI handle.
Attributes Documentation
- attrs
Attributes.
- flavor
Create flavor.
- group
Group.
- group_rank
Group rank.
- group_size
Group size.
- handle
MPI handle.
- info
Info hints.
- model
Memory model.
- name
Print name.