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

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

Adding compiled files

File size: 1.9 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Graph_neighbors_count 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Graph_neighbors_count \fP \- Returns the number of neighbors of a node associated with a graph topology.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Graph_neighbors_count(MPI_Comm \fIcomm\fP, int\fI rank\fP,
13        int\fI *nneighbors\fP)
14
15.SH Fortran Syntax
16.nf
17INCLUDE 'mpif.h'
18MPI_GRAPH_NEIGHBORS_COUNT(\fICOMM, RANK, NNEIGHBORS, IERROR\fP)
19        INTEGER \fICOMM, RANK, NNEIGHBORS, IERROR\fP
20
21.SH C++ Syntax
22.nf
23#include <mpi.h>
24int Graphcomm::Get_neighbors_count(int \fIrank\fP) const
25
26.SH INPUT PARAMETERS
27.ft R
28.TP 1i
29comm
30Communicator with graph topology (handle).
31.TP 1i
32rank
33Rank of process in group of comm (integer).
34
35.SH OUTPUT PARAMETERS
36.ft R
37.TP 1i
38nneighbors
39Number of neighbors of specified process (integer).
40.ft R
41.TP 1i
42IERROR
43Fortran only: Error status (integer).
44
45.SH DESCRIPTION
46.ft R
47MPI_Graph_neighbors_count and MPI_Graph_neighbors provide adjacency information for a general, graph topology. MPI_Graph_neighbors_count returns the number of neighbors for the process signified by rank.
48
49.SH ERRORS
50Almost 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.
51.sp
52Before the error value is returned, the current MPI error handler is
53called. 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. 
54
55.SH SEE ALSO
56.ft R
57.sp
58MPI_Graph_neighbors
59
Note: See TracBrowser for help on using the repository browser.