1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
|
.. _mpi_op_free:
MPI_Op_free
===========
.. include_body
:ref:`MPI_Op_free` |mdash| Frees a user-defined combination function handle.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Op_free(MPI_Op *op)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_OP_FREE(OP, IERROR)
INTEGER OP, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Op_free(op, ierror)
TYPE(MPI_Op), INTENT(INOUT) :: op
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT/OUTPUT PARAMETER
----------------------
* ``op``: Operation (handle).
OUTPUT PARAMETER
----------------
* ``ierror``: Fortran only: Error status (integer).
DESCRIPTION
-----------
Marks a user-defined reduction operation for deallocation and sets *op*
to MPI_OP_NULL.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Op_create`
* :ref:`MPI_Reduce`
* :ref:`MPI_Allreduce`
* :ref:`MPI_Reduce_scatter`
* :ref:`MPI_Scan`
|