2014-10-24 01:21:54 +04:00
.\" -*- nroff -*-
2010-10-08 01:13:11 +04:00
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
2006-09-28 22:39:36 +04:00
.\" Copyright (c) 1996 Thinking Machines Corporation
2014-10-24 01:21:54 +04:00
.\" $COPYRIGHT$
2008-08-02 01:14:37 +04:00
.TH MPI_Graphdims_get 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
2006-09-28 22:39:36 +04:00
.SH NAME
\fBMPI_Graphdims_get \fP \- Retrieves graph topology information associated with a communicator.
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Graphdims_get(MPI_Comm \fIcomm\fP, int\fI *nnodes\fP, int\fI *nedges\fP)
2010-10-08 01:13:11 +04:00
.fi
2006-09-28 22:39:36 +04:00
.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
MPI_GRAPHDIMS_GET(\fICOMM, NNODES, NEDGES, IERROR\fP)
2015-06-24 06:59:57 +03:00
INTEGER \fICOMM, NNODES, NEDGES, IERROR\fP
2006-09-28 22:39:36 +04:00
2010-10-08 01:13:11 +04:00
.fi
2006-09-28 22:39:36 +04:00
.SH C++ Syntax
.nf
#include <mpi.h>
void Graphcomm::Get dims(int \fInnodes\fP[], int \fInedges\fP[]) const
2010-10-08 01:13:11 +04:00
.fi
2006-09-28 22:39:36 +04:00
.SH INPUT PARAMETER
.ft R
.TP 1i
comm
Communicator for group with graph structure (handle).
.SH OUTPUT PARAMETERS
.ft R
.TP 1i
nnodes
Number of nodes in graph (integer).
.TP 1i
nedges
Number of edges in graph (integer).
.ft R
.TP 1i
IERROR
2015-06-24 06:59:57 +03:00
Fortran only: Error status (integer).
2006-09-28 22:39:36 +04:00
.SH DESCRIPTION
.ft R
Functions MPI_Graphdims_get and MPI_Graph_get retrieve the graph-topology information that was associated with a communicator by MPI_Graph_create.
.sp
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.
.SH ERRORS
2010-07-22 05:24:12 +04:00
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.
2006-09-28 22:39:36 +04:00
.sp
Before the error value is returned, the current MPI error handler is
2015-06-24 06:59:57 +03:00
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.
2006-09-28 22:39:36 +04:00
.SH SEE ALSO
.ft R
.sp
MPI_Graph_create
.br
MPI_Graph_get