MPIGraphget(3OpenMPI) MPIGraphget(3OpenMPI)

NAME
       MMPPIIGGrraapphhggeett  - Retrieves graph topology information associated with a
       communicator.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIGraphget(MPIComm comm, int maxindex, int maxedges,
            int *index, int *edges)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIGRAPHGET(COMM, MAXINDEX, MAXEDGES, INDEX, EDGES, IERROR)
            INTEGER   COMM, MAXINDEX, MAXEDGES, INDEX(*)
            INTEGER   EDGES(*), IERROR


CC++++ SSyynnttaaxx
       #include 
       void Graphcomm::Gettopo(int maxindex, int maxedges,
            int index[], int edges[]) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       comm      Communicator with graph structure (handle).

       maxindex  Length of vector index in the calling program (integer).

       maxedges  Length of vector edges in the calling program (integer).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       index     Array of integers containing the graph structure (for details
                 see the definition of MPIGraphcreate).

       edges     Array of integers containing the graph structure.

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Functions MPIGraphdimsget and MPIGraphget retrieve the graph-topol-
       ogy  information  that  was   associated   with   a   communicator   by
       MPIGraphcreate.

       The  information provided by MPIGraphdimsget can be used to dimension
       the vectors index and edges correctly for a call to MPIGraphget.


EERRRROORRSS
       Almost all MPI routines return an error value; C routines as the  value
       of  the  function  and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default  error  handler  is  set  to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before the error value is returned, the current MPI  error  handler  is
       called.  By  default, this error handler aborts the MPI job, except for
       I/O  function  errors.  The  error  handler   may   be   changed   with
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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.


SEE ALSO
       MPIGraphcreate
       MPIGraphdimsget




Open MPI 1.2                    September 2006         MPIGraphget(3OpenMPI)