[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Graph_get 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Graph_get \fP \- Retrieves graph topology information associated with a communicator. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .SH C Syntax |
---|
| 10 | .nf |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_Graph_get(MPI_Comm \fIcomm\fP, int\fI maxindex\fP, int\fI maxedges\fP, |
---|
| 13 | int\fI *index\fP, int\fI *edges\fP) |
---|
| 14 | |
---|
| 15 | .SH Fortran Syntax |
---|
| 16 | .nf |
---|
| 17 | INCLUDE 'mpif.h' |
---|
| 18 | MPI_GRAPH_GET(\fICOMM, MAXINDEX, MAXEDGES, INDEX, EDGES, IERROR\fP) |
---|
| 19 | INTEGER \fICOMM, MAXINDEX, MAXEDGES, INDEX(*)\fP |
---|
| 20 | INTEGER \fIEDGES(*), IERROR\fP |
---|
| 21 | |
---|
| 22 | .SH C++ Syntax |
---|
| 23 | .nf |
---|
| 24 | #include <mpi.h> |
---|
| 25 | void Graphcomm::Get_topo(int \fImaxindex\fP, int \fImaxedges\fP, |
---|
| 26 | int \fIindex\fP[], int \fIedges\fP[]) const |
---|
| 27 | |
---|
| 28 | .SH INPUT PARAMETERS |
---|
| 29 | .ft R |
---|
| 30 | .TP 1i |
---|
| 31 | comm |
---|
| 32 | Communicator with graph structure (handle). |
---|
| 33 | .TP 1i |
---|
| 34 | maxindex |
---|
| 35 | Length of vector index in the calling program (integer). |
---|
| 36 | .TP 1i |
---|
| 37 | maxedges |
---|
| 38 | Length of vector edges in the calling program (integer). |
---|
| 39 | |
---|
| 40 | .SH OUTPUT PARAMETERS |
---|
| 41 | .ft R |
---|
| 42 | .TP 1i |
---|
| 43 | index |
---|
| 44 | Array of integers containing the graph structure (for details see the |
---|
| 45 | definition of MPI_Graph_create). |
---|
| 46 | .TP 1i |
---|
| 47 | edges |
---|
| 48 | Array of integers containing the graph structure. |
---|
| 49 | .ft R |
---|
| 50 | .TP 1i |
---|
| 51 | IERROR |
---|
| 52 | Fortran only: Error status (integer). |
---|
| 53 | |
---|
| 54 | .SH DESCRIPTION |
---|
| 55 | .ft R |
---|
| 56 | Functions MPI_Graphdims_get and MPI_Graph_get retrieve the graph-topology information that was associated with a communicator by MPI_Graph_create. |
---|
| 57 | .sp |
---|
| 58 | The information provided by MPI_Graphdims_get can be used to dimension the vectors index and edges correctly for a call to MPI_Graph_get. |
---|
| 59 | |
---|
| 60 | .SH ERRORS |
---|
| 61 | Almost 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. |
---|
| 62 | .sp |
---|
| 63 | Before the error value is returned, the current MPI error handler is |
---|
| 64 | 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. |
---|
| 65 | |
---|
| 66 | .SH SEE ALSO |
---|
| 67 | .ft R |
---|
| 68 | .sp |
---|
| 69 | MPI_Graph_create |
---|
| 70 | .br |
---|
| 71 | MPI_Graphdims_get |
---|
| 72 | |
---|