The OpenMP API User's Guide summarizes the OpenMP Fortran 95, C, and C++ application program interface (API) for building multiprocessing applications.
This guide is intended for scientists, engineers, and programmers who have a working knowledge of the Fortran, C, or C++ languages, and the OpenMP parallel programming model. Familiarity with the Solaris operating environment or UNIX® in general is also assumed.
Typographic Conventions
The following are the typographic conventions used in the text and code examples in this manual:
TABLE P-1 Typeface Conventions
Typeface
|
Meaning
|
Examples
|
AaBbCc123
|
The names of commands, files, and directories; on-screen computer output
|
Edit your .login file.
Use ls -a to list all files.
% You have mail.
|
AaBbCc123
|
In code examples, what you type, when contrasted with on-screen computer output.
In text, identifies tokens in the language, API, or library function names.
|
% su
Password:
ATOMIC directives
|
AaBbCc123
|
Book titles, new words or terms, words to be emphasized
|
Read Chapter 6 in the User's Guide.
These are called class options.
You must be superuser to do this.
|
AaBbCc123
|
Command-line placeholder text; replace with a real name or value
|
To delete a file, type rm filename.
|
TABLE P-2 Code and Command-Line Conventions
Code Symbol
|
Meaning
|
Notation
|
Code Example
|
[ ]
|
Brackets contain arguments that are optional.
|
O[n]
|
O4, O
|
{ }
|
Braces contain a set of choices for required option.
|
d{y|n}
|
dy
|
|
|
The "pipe" or "bar" symbol separates arguments, only one of which may be chosen.
|
B{dynamic|static}
|
Bstatic
|
:
|
The colon, like the comma, is sometimes used to separate arguments.
|
Rdir[:dir]
|
R/local/libs:/U/a
|
...
|
The ellipsis indicates omission in a series.
|
xinline=f1[,...fn]
|
xinline=alpha,dos
|
Shell Prompts
Shell
|
Prompt
|
C shell
|
%
|
Bourne shell and Korn shell
|
$
|
C shell, Bourne shell, and Korn shell superuser
|
#
|
Accessing Forte Developer Development Tools and Man Pages
The Forte Developer product components and man pages are not installed into the standard /usr/bin/ and /usr/share/man directories. To access the Forte Developer compilers and tools, you must have the Forte Developer component directory in your PATH environment variable. To access the Forte Developer man pages, you must have the Forte Developer man page directory in your MANPATH environment variable.
For more information about the PATH variable, see the csh(1), sh(1), and ksh(1) man pages. For more information about the MANPATH variable, see the man(1) man page. For more information about setting your PATH and MANPATH variables to access this Forte Developer release, see the installation guide or your system administrator.
Note - The information in this section assumes that your Forte Developer products are installed in the /opt directory. If your product software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.
|
Accessing Forte Developer Compilers and Tools
Use the steps below to determine whether you need to change your PATH variable to access the Forte Developer compilers and tools.
To Determine Whether You Need to Set Your PATH Environment Variable
|
1. Display the current value of the PATH variable by typing the following at a command prompt:
2. Review the output for a string of paths that contain /opt/SUNWspro/bin/.
If you find the path, your PATH variable is already set to access Forte Developer development tools. If you do not find the path, set your PATH environment variable by following the instructions in the next section.
To Set Your PATH Environment Variable to Enable Access to Forte Developer Compilers and Tools
|
1. If you are using the C shell, edit your home .cshrc file. If you are using the Bourne shell or Korn shell, edit your home .profile file.
2. Add the following to your PATH environment variable.
/opt/SUNWspro/bin
Accessing Forte Developer Man Pages
Use the following steps to determine whether you need to change your MANPATH variable to access the Forte Developer man pages.
To Determine Whether You Need to Set Your MANPATH Environment Variable
|
1. Request the dbx man page by typing the following at a command prompt:
2. Review the output, if any.
If the dbx(1) man page cannot be found or if the man page displayed is not for the current version of the software installed, follow the instructions in the next section for setting your MANPATH environment variable.
To Set Your MANPATH Environment Variable to Enable Access to Forte Developer Man Pages
|
1. If you are using the C shell, edit your home .cshrc file. If you are using the Bourne shell or Korn shell, edit your home .profile file.
2. Add the following to your MANPATH environment variable.
/opt/SUNWspro/man
Accessing Forte Developer Documentation
You can access Forte Developer product documentation at the following locations:
- The product documentation is available from the documentation index installed with the product on your local system or network at /opt/SUNWspro/docs/index.html.
If your product software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.
- Most manuals are available from the docs.sun.comsm web site. The following titles are available through your installed product only:
- Standard C++ Library Class Reference
- Standard C++ Library User's Guide
- Tools.h++ Class Library Reference
- Tools.h++ User's Guide
The docs.sun.com web site (http://docs.sun.com) enables you to read, print, and buy Sun Microsystems manuals through the Internet. If you cannot find a manual, see the documentation index installed with the product on your local system or network.
Note - Sun is not responsible for the availability of third-party web sites mentioned in this document and does not endorse and is not responsible or liable for any content, advertising, products, or other materials on or available from such sites or resources. Sun will not be responsible or liable for any damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services available on or through any such sites or resources.
|
Product Documentation in Accessible Formats
Forte Developer 7 product documentation is provided in accessible formats that are readable by assistive technologies for users with disabilities. You can find accessible versions of documentation as described in the following table. If your product software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.
Type of Documentation
|
Format and Location of Accessible Version
|
Manuals (except third-party manuals)
|
HTML at http://docs.sun.com
|
Third-party manuals:
- Standard C++ Library Class Reference
- Standard C++ Library User's Guide
- Tools.h++ Class Library Reference
- Tools.h++ User's Guide
|
HTML in the installed product through the documentation index at file:/opt/SUNWspro/docs/index.html
|
Readmes and man pages
|
HTML in the installed product through the documentation index at file:/opt/SUNWspro/docs/index.html
|
Release notes
|
Text file on the product CD at /cdrom/devpro_v10n1_sparc/release_notes.txt
|
Related Forte Developer Documentation
The following table describes related documentation that is available at file:/opt/SUNWspro/docs/index.html. If your product software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.
Document Title
|
Description
|
Fortran Programming Guide
|
Describes how to write effective Fortran code on Solaris environments; input/output, libraries, performance, debugging, and parallel processing.
|
Fortran Library Reference
|
Details the Fortran library and intrinsic routines
|
Fortran User's Guide
|
Describes the compile-time environment and command-line options for the f95 compiler. Also includes guidelines for migrating legacy f77 programs to f95.
|
C User's Guide
|
Describes the compile-time environment and command-line options for the cc compiler.
|
C++ User's Guide
|
Describes the compile-time environment and command-line options for the CC compiler.
|
Numerical Computation Guide
|
Describes issues regarding the numerical accuracy of floating-point computations.
|
Accessing Related Solaris Documentation
The following table describes related documentation that is available through the docs.sun.com web site.
Document Collection
|
Document Title
|
Description
|
Solaris Reference Manual Collection
|
See the titles of man page sections.
|
Provides information about the Solaris operating environment.
|
Solaris Software Developer Collection
|
Linker and Libraries Guide
|
Describes the operations of the Solaris link-editor and runtime linker.
|
Solaris Software Developer Collection
|
Multithreaded Programming Guide
|
Covers the POSIX and Solaris threads APIs, programming with synchronization objects, compiling multithreaded programs, and finding tools for multithreaded programs.
|
Sending Your Comments
Sun is interested in improving its documentation and welcomes your comments and suggestions. Email your comments to Sun at this address:
docfeedback@sun.com
OpenMP API User's Guide
| 816-2468-10
| ![Table of Contents](shared/toc01.gif) ![Previous Chapter](shared/prev01.gif) ![Next Chapter](shared/next01.gif)
|
Copyright © 2002, Sun Microsystems, Inc. All rights reserved.