source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Op_free.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 1.5 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Op_free 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Op_free\fP \- Frees a user-defined combination function handle.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Op_free(MPI_Op *\fIop\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_OP_FREE(\fIOP, IERROR\fP)
18        INTEGER \fIOP, IERROR\fP
19
20.SH C++ Syntax
21.nf
22#include <mpi.h>
23void Op::Free()
24
25.SH INPUT/OUTPUT PARAMETER
26.TP 1i
27op
28Operation (handle).
29
30.SH OUTPUT PARAMETER
31.ft R
32.TP 1i
33IERROR
34Fortran only: Error status (integer).
35
36.SH DESCRIPTION
37.ft R
38Marks a user-defined reduction operation for deallocation and sets \fIop\fP to MPI_OP_NULL.
39
40.SH ERRORS
41Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object.
42.sp
43Before the error value is returned, the current MPI error handler is
44called. 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. 
45
46.SH SEE ALSO
47.sp
48MPI_Op_create
49.br
50MPI_Reduce
51.br
52MPI_Allreduce
53.br
54MPI_Reduce_scatter
55.br
56MPI_Scan
57
Note: See TracBrowser for help on using the repository browser.