MPI Programming Guide

A_SAMPLE_PE_SUBROUTINE, A_Sample_PE_subroutine

Purpose

Provides a brief description of the subroutine.

Library

libmpi.a, libmpi_r.a, or both

The mpcc, mpCC, and mpxlf scripts automatically include these libraries.

C synopsis

#include <header.h> or #include "header.h"
int A_Sample_PE_subroutine (one or more parameters);

FORTRAN synopsis

include 'header.h'
A_SAMPLE_PE_SUBROUTINE (ONE OR MORE PARAMETERS);

In the FORTRAN subroutines, formal parameters are described using a function prototype format, even though FORTRAN does not support prototyping.

Parameters

Argument or parameter definitions are listed as follows:

parameter_1

description of parameter_1 (type)

·
·
·

 

parameter_n

description of parameter_n (type)

Description

A more detailed description of the subroutine appears here.

Notes

Any additional notes about the subroutine appear here.

Return values

Any return values appear here:

n

indicates ...

In almost every subroutine, the C version is invoked as a function returning integer. In the FORTRAN version, the routine is called as a subroutine; that is, it has no return value.

Examples

C example

A C example appears here.

FORTRAN example

A FORTRAN example appears here.

Related information

The names of any related subroutines or commands appear here.