1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Graphdims_get 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Graphdims_get \fP \- Retrieves graph topology information associated with a communicator. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .nf |
---|
10 | .SH C Syntax |
---|
11 | .nf |
---|
12 | #include <mpi.h> |
---|
13 | int MPI_Graphdims_get(MPI_Comm \fIcomm\fP, int\fI *nnodes\fP, int\fI *nedges\fP) |
---|
14 | |
---|
15 | .SH Fortran Syntax |
---|
16 | .nf |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_GRAPHDIMS_GET(\fICOMM, NNODES, NEDGES, IERROR\fP) |
---|
19 | INTEGER \fICOMM, NNODES, NEDGES, IERROR\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | void Graphcomm::Get dims(int \fInnodes\fP[], int \fInedges\fP[]) const |
---|
25 | |
---|
26 | .SH INPUT PARAMETER |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | comm |
---|
30 | Communicator for group with graph structure (handle). |
---|
31 | |
---|
32 | .SH OUTPUT PARAMETERS |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | nnodes |
---|
36 | Number of nodes in graph (integer). |
---|
37 | .TP 1i |
---|
38 | nedges |
---|
39 | Number of edges in graph (integer). |
---|
40 | .ft R |
---|
41 | .TP 1i |
---|
42 | IERROR |
---|
43 | Fortran only: Error status (integer). |
---|
44 | |
---|
45 | .SH DESCRIPTION |
---|
46 | .ft R |
---|
47 | Functions MPI_Graphdims_get and MPI_Graph_get retrieve the graph-topology information that was associated with a communicator by MPI_Graph_create. |
---|
48 | .sp |
---|
49 | 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. |
---|
50 | |
---|
51 | .SH ERRORS |
---|
52 | 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. |
---|
53 | .sp |
---|
54 | Before the error value is returned, the current MPI error handler is |
---|
55 | 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. |
---|
56 | |
---|
57 | .SH SEE ALSO |
---|
58 | .ft R |
---|
59 | .sp |
---|
60 | MPI_Graph_create |
---|
61 | .br |
---|
62 | MPI_Graph_get |
---|
63 | |
---|