NAME

MPI_Op_free - Free a user operation handle

SYNOPSIS

#include <mpi.h> 
int MPI_Op_free(MPI_Op *op ); 
#include <pmpi.h> 
int PMPI_Op_free(MPI_Op *op ); 

INPUT PARAMETER

op - The operator to free (handle)

OUTPUT PARAMETER

op - set to MPI_OP_NULL after being freed (handle)

DESCRIPTION

The MPI_Op_free() function is used to free a user operation, op . Once the operation has been freed, op is set to MPI_OP_NULL.

It is erronious to try to free a built-in MPI operation or the MPI_OP_NULL handle.

PMPI_Op_free() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_OP - Invalid operation.

SEE ALSO

MPI_Op_create (3) MPI_Reduce (3) MPI_Allreduce (3) MPI_Reduce_scatter (3) MPI_Scan (3) MPI_Exscan (3)

• Lockless
• MPI Documentation
• MPI_Op_free