-
Notifications
You must be signed in to change notification settings - Fork 908
add support for request_get_status_any/all/some #13279
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
0905498
5bcd16f
c1423fc
1c0d10c
5121f57
7f21618
2076ec2
47fbc39
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
.. _mpi_request_get_status_all: | ||
|
||
|
||
MPI_Request_get_status_all | ||
========================== | ||
|
||
.. include_body | ||
|
||
:ref:`MPI_Request_get_status_all` |mdash| Access information associated with a | ||
request without freeing the request. | ||
|
||
.. The following file was automatically generated | ||
.. include:: ./bindings/mpi_request_get_status_all.rst | ||
|
||
INPUT PARAMETER | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PARAMETERS (plural) |
||
--------------- | ||
* ``count``: List length (non-negative integer) | ||
* ``array_of_requests``: Array of requests (array of handles). | ||
|
||
OUTPUT PARAMETERS | ||
----------------- | ||
* ``flag``: Boolean flag, same as from :ref:`MPI_Test` (logical). | ||
* ``array_of_statuses``: Array of ``MPI_Status`` objects if flag is true (array of status). | ||
* ``ierror``: Fortran only: Error status (integer). | ||
|
||
DESCRIPTION | ||
----------- | ||
|
||
:ref:`MPI_Request_get_status_all` sets ``flag = true`` if all | ||
operations associated with *active* handles in the array have completed. | ||
In this case, each status entry that corresponds to an active request | ||
is set to the status of the corresponding operation. It | ||
does not deallocate or deactivate the request; a subsequent call to | ||
any of the MPI test, wait, or free routines should be executed with each | ||
of those requests. | ||
|
||
Each status entry that corresponds to a null or inactive handle is set | ||
to empty. Otherwise, ``flag = false`` is returned and the values of the | ||
status entries are undefined. | ||
|
||
If your application does not need to examine the *status* field, you can | ||
save resources by using the predefined constant ``MPI_STATUSES_IGNORE`` as a | ||
special value for the ``array_of_statuses`` argument. | ||
jsquyres marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
ERRORS | ||
------ | ||
|
||
.. include:: ./ERRORS.rst |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
.. _mpi_request_get_status_any: | ||
|
||
|
||
MPI_Request_get_status_any | ||
========================== | ||
|
||
.. include_body | ||
|
||
:ref:`MPI_Request_get_status_any` |mdash| Access information associated with a | ||
request without freeing the request. | ||
|
||
.. The following file was automatically generated | ||
.. include:: ./bindings/mpi_request_get_status_any.rst | ||
|
||
INPUT PARAMETER | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PARAMETERS (plural) |
||
--------------- | ||
* ``count``: List length (non-negative integer) | ||
* ``array_of_requests``: Array of requests (array of handles). | ||
|
||
OUTPUT PARAMETERS | ||
----------------- | ||
* ``index``: Index of operation that completed (integer). | ||
* ``flag``: Boolean flag, same as from :ref:`MPI_Test` (logical). | ||
* ``status``: ``MPI_Status`` object if flag is true (status). | ||
* ``ierror``: Fortran only: Error status (integer). | ||
|
||
DESCRIPTION | ||
----------- | ||
|
||
:ref:`MPI_Request_get_status_any` sets ``flag = true`` if either one | ||
of the operations associated with active handles has completed. In | ||
this case it returns in ``index`` the index of this request in the | ||
array and the status of the operation in ``status``. It does not | ||
deallocate or deactivate the request; a subsequent call to any of the MPI | ||
test, wait, or free routines should be executed with that request. | ||
|
||
If no operation completed, it returns ``flag = false`` and a value of | ||
``MPI_UNDEFINED`` in ``index``. ``status`` is undefined in this | ||
scenario. | ||
|
||
If ``array_of_requests`` contains no active handles then the call | ||
returns immediately with ``flag = true``, ``index = MPI_UNDEFINED``, | ||
and an empty status. | ||
|
||
If your application does not need to examine the *status* field, you can | ||
save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a | ||
special value for the ``status`` argument. | ||
|
||
|
||
ERRORS | ||
------ | ||
|
||
.. include:: ./ERRORS.rst |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
.. _mpi_request_get_status_some: | ||
|
||
|
||
MPI_Request_get_status_some | ||
=========================== | ||
|
||
.. include_body | ||
|
||
:ref:`MPI_Request_get_status_some` |mdash| Access information associated with a | ||
request without freeing the request. | ||
|
||
.. The following file was automatically generated | ||
.. include:: ./bindings/mpi_request_get_status_some.rst | ||
|
||
INPUT PARAMETER | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PARAMETERS (plural) |
||
--------------- | ||
* ``incount``: List length (non-negative integer). | ||
* ``array_of_requests``: Array of requests (array of handles). | ||
|
||
OUTPUT PARAMETERS | ||
----------------- | ||
* ``outcount``: Number of completed requests (integer). | ||
* ``array_of_indices``: Array of indices of operations that completed (array of integers). | ||
* ``array_of_statuses``: Array of ``MPI_Status`` objects for operations that completed (array of status). | ||
* ``ierror``: Fortran only: Error status (integer). | ||
|
||
DESCRIPTION | ||
----------- | ||
|
||
:ref:`MPI_Request_get_status_some` returns in outcount the number of | ||
requests from the list ``array_of_requests`` that have completed. The | ||
first ``outcount`` locations of the array ``array_of_indices`` and | ||
``array_of_statuses`` will contain the indices of the operations | ||
within the array ``array_of_requests`` and the status of these | ||
operations respectively. The array is indexed from zero in C and from | ||
one in Fortran. It does not deallocate or deactivate the request; a | ||
subsequent call to any of the MPI test, wait, or free routines should be | ||
executed with each completed request. | ||
|
||
If no operation in ``array_of_requests`` is complete, it returns | ||
``outcount = 0``. If all operations in ``array_of_requests`` are either | ||
``MPI_REQUEST_NULL`` or inactive, ``outcount`` will be set to ``MPI_UNDEFINED``. | ||
|
||
If your application does not need to examine the *status* field, you can | ||
save resources by using the predefined constant ``MPI_STATUSES_IGNORE`` as a | ||
special value for the ``array_of_statuses`` argument. | ||
|
||
|
||
ERRORS | ||
------ | ||
|
||
.. include:: ./ERRORS.rst |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're access information with all active requests in an array -- not just a request.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This still needs to be updated -- it's an array of requests, not a single request. Perhaps: