17.2.267. MPI_Op_commutative

MPI_Op_commutative - Query of commutativity of reduction operation.

17.2.267.1. SYNTAX

17.2.267.1.1. C Syntax

#include <mpi.h>

int MPI_Op_commutative(MPI_Op op, int *commute)

17.2.267.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_OP_COMMUTATIVE(OP, COMMUTE, IERROR)
     LOGICAL COMMUTE
     INTEGER OP, IERROR

17.2.267.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Op_commutative(op, commute, ierror)
     TYPE(MPI_Op), INTENT(IN) :: op
     INTEGER, INTENT(OUT) :: commute
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.267.2. INPUT PARAMETER

  • op: Operation (handle).

17.2.267.3. OUTPUT PARAMETERS

  • commute: True if op is commutative, false otherwise (logical).

  • IERROR: Fortran only: Error status (integer).

17.2.267.4. DESCRIPTION

Reduction operations can be queried for their commutativity.

17.2.267.5. ERRORS

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

See also

MPI_Op_create