Before You Begin

This book describes how to use the Suntrademark specific extensions and features included with the Sun Performance Librarytrademark subroutines that are supported by the Sun Forte Developer Fortran 95 and C compilers.


Who Should Use This Book

This book is a user's guide intended for programmers who have a working knowledge of the Fortran or C language and some understanding of the base LAPACK and BLAS libraries available from Netlib (http://www.netlib.org).


How This Book Is Organized

This book is organized into the following chapters and appendixes:

Chapter 1 describes the benefits of using the Sun Performance Library and the features of the Sun Performance Library.

Chapter 2 describes how to use the f95 and C interfaces provided with the Sun Performance Library.

Chapter 3 shows how to use compiler and linking options to maximize library performance for specific SPARCtrademark instruction set architectures and different parallel processing modes.

Chapter 4 includes information on matrix storage schemes, matrix types, and sparse matrices.

Chapter 5 describes the one-dimensional, two-dimensional, and three-dimensional fast Fourier transform routines provided with the Sun Performance Library.

Chapter 6 provides an introduction to the Interval Basic Linear Algebra Subroutine (IBLAS) library provided with the Sun Performance Library.

Appendix A lists the Sun Performance Library routines organized according to name, routine, and library.


What Is Not in This Book

This book does not repeat information included in existing LAPACK books or sources on Netlib. Refer to the next section Related Documents and Web Sites for a list of sources that contain reference material for the base routines upon which Sun Performance Library is based.


Related Documents and Web Sites

A number of books and web sites provide reference information on the routines in the base LAPACK and BLAS libraries upon which the Sun Performance Library is based. The LAPACK Users' Guide. 3rd ed., Anderson E. and others. SIAM, 1999, augments the material in this manual and provide essential information:

The LAPACK Users' Guide, 3rd ed. is the official reference for the base LAPACK version 3.0 routines. An online version of the LAPACK 3.0 Users' Guide is available at http://www.netlib.org/lapack/lug/, and the printed version is available from the Society for Industrial and Applied Mathematics (SIAM) http://www.siam.org.

Sun Performance Library routines contain performance enhancements, extensions, and features not described in the LAPACK Users' Guide. However, because Sun Performance Library maintains compatibility with the base LAPACK routines, the LAPACK Users' Guide can be used as a reference for the LAPACK routines and the Fortran interfaces.

Online Resources

Online information describing the performance library routines that form the basis of the Sun Performance Library can be found at the following URLs.

LAPACK version 3.0

http://www.netlib.org/lapack/

BLAS, levels 1 through 3

http://www.netlib.org/blas/

FFTPACK version 4

http://www.netlib.org/fftpack/

VFFTPACK version 2.1

http://www.netlib.org/vfftpack/

Sparse BLAS

http://www.netlib.org/sparseblas/index.html

NIST (National Institute of Standards and Technology) Fortran Sparse BLAS

http://math.nist.gov/spblas/




Note - LINPACK has been removed from this version of the Sun Performance Library. The LINPACK libraries and documentation are still available from www.netlib.org.




Typographic Conventions

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

What you type, when contrasted with on-screen computer output

% su

Password:

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 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.


procedure icon  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:

% echo $PATH

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.


procedure icon  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.


procedure icon  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:

% man dbx

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.


procedure icon  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

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