Preface

Sun Performance Library User's Guide

Preface

This book describes how to use the Sun^TM specific extensions and features included with the Sun Performance Library subroutines that are supported by the Sun WorkShop^TM 6 FORTRAN 77, Fortran 95, and C compilers.

Who Should Use This Book

This is a reference manual intended for programmers who have a working knowledge of the Fortran or C language and some understanding of the base LAPACK, BLAS, FFTPACK, VFFTPACK, and LINPACK libraries available from Netlib (http://www.netlib.org).

What Is in This Book

This book is organized into the following chapters and appendixes:

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

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

Chapter 3, "SPARC Optimization and Parallel Processing," shows how to use compiler and linking options to maximize library performance for specific SPARC^TM instruction set architectures and different parallel processing modes.

Chapter 4, "Working With Matrices," includes information on matrix storage schemes, matrix types, and sparse matrices.

Appendix A, "Sun Performance Library Routines," 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 and LINPACK books or sources on Netlib. Refer to the 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.

Typographic Conventions

TABLE P-1 shows the typographic conventions that are used in Sun WorkShop documentation.
TABLE P-1 Typographic 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.

Shell Prompts

TABLE P-2 shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

TABLE P-2 Shell Prompts
Shell Prompt

C shell %

Bourne shell and Korn shell $

C shell, Bourne shell, and Korn shell superuser #

Access to Sun WorkShop Development Tools

Because Sun WorkShop product components and man pages do not install into the standard /usr/bin/ and /usr/share/man directories, you must change your PATH and MANPATH environment variables to enable access to Sun WorkShop compilers and tools.

To determine if you need to set your PATH environment variable:
1. Display the current value of the PATH variable by typing:

% echo $PATH
2. Review the output for a string of paths containing /opt/SUNWspro/bin/.

If you find the paths, your PATH variable is already set to access Sun WorkShop development tools. If you do not find the paths, set your PATH environment variable by following the instructions in this section.

To determine if you need to set your MANPATH environment variable:
1. Request the workshop man page by typing:

% man workshop
2. Review the output, if any.

If the workshop(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 this section for setting your MANPATH environment variable.
Note – The information in this section assumes that your Sun WorkShop 6 products were installed in the /opt directory. Contact your system administrator if your Sun WorkShop software is not installed in /opt.

The PATH and MANPATH variables should be set in your home .cshrc file if you are using the C shell or in your home .profile file if you are using the Bourne or Korn shells:

To use Sun WorkShop commands, add the following to your PATH variable:

/opt/SUNWspro/bin

To access Sun WorkShop man pages with the man command, add the following to your MANPATH variable:

/opt/SUNWspro/man

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 release, see the Sun WorkShop 6 Installation Guide or your system administrator.

Related Documents and Web Sites

A number of books and web sites provide reference information on the routines in the base libraries (LAPACK, LINPACK, BLAS, and so on) upon which the Sun Performance Workshop is based. Sun Performance Library includes extensions to the base libraries that are not described in the books from the Society for Industrial and Applied Mathematics (SIAM) or the online Netlib documents.

LAPACK and LINPACK Books

The following books augment this manual and provide essential information:

LAPACK Users' Guide. 3rd ed., Anderson E. and others. SIAM, 1999.
LINPACK User's Guide. Dongarra J. J. and others. SIAM, 1979.

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

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 types of LAPACK routines and the FORTRAN 77 interfaces.

Sparse BLAS and Sparse Solver Books and Papers

The following books and papers provide additional information for the sparse BLAS and sparse solver routines.

Dodson, D.S, R.G. Grimes, and J.G. Lewis. "Sparse Extensions to the Fortran Basic Linear Algebra Subprograms." ACM Transactions on Mathematical Software, June 1991, Vol 17, No. 2.
A. George and J. W-H. Liu. "Computer Solution of Large Sparse Positive Definite Systems." Prentice-Hall Inc., Englewood Cliffs, New Jersey, 1981.
E. Ng and B. W. Peyton. "Block Sparse Cholesky Algorithms on Advanced Uniprocessor Computers." SIAM M. Sci Comput., 14:1034-1056, 1993.
Ian S. Duff, Roger G. Grimes and John G. Lewis, "User's Guide for the Harwell-Boeing Sparse Matrix Collection (Release I)," Technical Report TR/PA/92/86, CERFACS, Lyon, France, October 1992.

Online Resources

Online information describing the performance library routines that form the basis of the Sun Performance Library can be found at:
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/sparse- blas/index.html

NIST (National Institute of Standards and Technology) Fortran Sparse BLAS
http://math.nist.gov/spblas/

LINPACK
http://www.netlib.org/linpack/
Related Sun WorkShop 6 Documentation

You can access documentation related to the subject matter of this book in the following ways:

Through the Internet at the docs.sun.com^sm Web site. You can search for a specific book title or you can browse by subject, document collection, or product at the following Web site:

http://docs.sun.com

Through the installed Sun WorkShop products on your local system or network. Sun WorkShop 6 HTML documents (manuals, online help, man pages, component readme files, and release notes) are available with your installed Sun WorkShop 6 products. To access the HTML documentation, do one of the following:

In any Sun WorkShop or Sun WorkShop^{^TM}TeamWare window, choose Help About Documentation.
In your Netscape^TM Communicator 4.0 or compatible version browser, open the following file:

/opt/SUNWspro/docs/index.html

(Contact your system administrator if your Sun WorkShop software is not installed in the /opt directory.) Your browser displays an index of Sun WorkShop 6 HTML documents. To open a document in the index, click the document's title.

TABLE P-3 lists related Sun WorkShop 6 manuals by document collection.

TABLE P-3 Related Sun WorkShop 6 Documentation by Document Collection
Document Collection Document Title Description

Forte^TM Developer 6 / Sun WorkShop 6 Release Documents About Sun WorkShop 6 Documentation Describes the documentation available with this Sun WorkShop release and how to access it.

What's New in Sun WorkShop 6 Provides information about the new features in the current and previous release of Sun WorkShop.

Sun WorkShop 6 Release Notes Contains installation details and other information that was not available until immediately before the final release of Sun WorkShop 6. This document complements the information that is available in the component readme files.

Forte Developer 6 / Sun WorkShop 6 Analyzing Program Performance With Sun WorkShop 6 Explains how to use the new Sampling Collector and Sampling Analyzer (with examples and a discussion of advanced profiling topics) and includes information about the command-line analysis tool er_print, the LoopTool and LoopReport utilities, and UNIX profiling tools prof, gprof, and tcov.

Debugging a Program With dbx Provides information on using dbx commands to debug a program with references to how the same debugging operations can be performed using the Sun WorkShop Debugging window.

Introduction to Sun WorkShop Acquaints you with the basic program development features of the Sun WorkShop integrated programming environment.

Forte^TM C 6 / Sun WorkShop 6 Compilers C C User's Guide Describes the C compiler options, Sun-specific capabilities such as pragmas, the lint tool, parallelization, migration to a 64-bit operating system, and ANSI/ISO-compliant C.

Forte^TM C++ 6 / Sun WorkShop 6 Compilers C++ C++ Library Reference Describes the C++ libraries, including C++ Standard Library, Tools.h++ class library, Sun WorkShop Memory Monitor, Iostream, and Complex.

C++ Migration Guide Provides guidance on migrating code to this version of the Sun WorkShop C++ compiler.

C++ Programming Guide Explains how to use the new features to write more efficient programs and covers templates, exception handling, runtime type identification, cast operations, performance, and multithreaded programs.

C++ User's Guide Provides information on command-line options and how to use the compiler.

Sun WorkShop Memory Monitor User's Manual Describes how the Sun WorkShop Memory Monitor solves the problems of memory management in C and C++. This manual is only available through your installed product (see /opt/SUNWspro/docs/index.html) and not at the docs.sun.com Web site.

Forte^TM for High Performance Computing 6 / Sun WorkShop 6 Compilers Fortran 77/95 Fortran Library Reference Provides details about the library routines supplied with the Fortran compiler.

Fortran Programming Guide Discusses issues relating to input/output, libraries, program analysis, debugging, and performance.

Fortran User's Guide Provides information on command-line options and how to use the compilers.

FORTRAN 77 Language Reference Provides a complete language reference.

Interval Arithmetic Programming Reference Describes the intrinsic INTERVAL data type supported by the Fortran 95 compiler.

Forte^TM TeamWare 6 / Sun WorkShop TeamWare 6 Sun WorkShop TeamWare 6 User's Guide Describes how to use the Sun WorkShop TeamWare code management tools.

Forte Developer 6 / Sun WorkShop Visual 6 Sun WorkShop Visual User's Guide Describes how to use Visual to create C++ and Java^TM graphical user interfaces.

Forte^TM / Sun Performance Library 6 Sun Performance Library Reference Discusses the optimized library of subroutines and functions used to perform computational linear algebra and fast Fourier transforms.

Sun Performance Library User's Guide Describes how to use the Sun-specific features of the Sun Performance Library, which is a collection of subroutines and functions used to solve linear algebra problems.

Numerical Computation Guide Numerical Computation Guide Describes issues regarding the numerical accuracy of floating-point computations.

Standard Library 2 Standard C++ Class Library Reference Provides details on the Standard C++ Library.

Standard C++ Library User's Guide Describes how to use the Standard C++ Library.

Tools.h++ 7 Tools.h++ Class Library Reference Provides details on the Tools.h++ class library.

Tools.h++ User's Guide Discusses use of the C++ classes for enhancing the efficiency of your programs.

TABLE P-4 describes related Solaris documentation available through the docs.sun.com Web site.

TABLE P-4 Related Solaris Documentation
Document Collection Document Title Description

Solaris Software Developer Linker and Libraries Guide Describes the operations of the Solaris link-editor and runtime linker and the objects on which they operate.

Programming Utilities Guide Provides information for developers about the special built-in programming tools that are available in the Solaris operating environment.

**TABLE P-1** Typographic 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** Shell Prompts
Shell	Prompt
C shell	`%`
Bourne shell and Korn shell	`$`
C shell, Bourne shell, and Korn shell superuser	`#`

`%` `echo $PATH`

`%` `man workshop`

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/sparse- blas/index.html
NIST (National Institute of Standards and Technology) Fortran Sparse BLAS	http://math.nist.gov/spblas/
LINPACK	http://www.netlib.org/linpack/

**TABLE P-3** Related Sun WorkShop 6 Documentation by Document Collection
Document Collection	Document Title	Description
Forte^TM Developer 6 / Sun WorkShop 6 Release Documents	About Sun WorkShop 6 Documentation	Describes the documentation available with this Sun WorkShop release and how to access it.
	What's New in Sun WorkShop 6	Provides information about the new features in the current and previous release of Sun WorkShop.
	Sun WorkShop 6 Release Notes	Contains installation details and other information that was not available until immediately before the final release of Sun WorkShop 6. This document complements the information that is available in the component readme files.
Forte Developer 6 / Sun WorkShop 6	Analyzing Program Performance With Sun WorkShop 6	Explains how to use the new Sampling Collector and Sampling Analyzer (with examples and a discussion of advanced profiling topics) and includes information about the command-line analysis tool `er_print`, the LoopTool and LoopReport utilities, and UNIX profiling tools `prof`, `gprof`, and `tcov`.
	Debugging a Program With dbx	Provides information on using dbx commands to debug a program with references to how the same debugging operations can be performed using the Sun WorkShop Debugging window.
	Introduction to Sun WorkShop	Acquaints you with the basic program development features of the Sun WorkShop integrated programming environment.
Forte^TM C 6 / Sun WorkShop 6 Compilers C	C User's Guide	Describes the C compiler options, Sun-specific capabilities such as pragmas, the `lint` tool, parallelization, migration to a 64-bit operating system, and ANSI/ISO-compliant C.
Forte^TM C++ 6 / Sun WorkShop 6 Compilers C++	C++ Library Reference	Describes the C++ libraries, including C++ Standard Library, Tools.h++ class library, Sun WorkShop Memory Monitor, Iostream, and Complex.
	C++ Migration Guide	Provides guidance on migrating code to this version of the Sun WorkShop C++ compiler.
	C++ Programming Guide	Explains how to use the new features to write more efficient programs and covers templates, exception handling, runtime type identification, cast operations, performance, and multithreaded programs.
	C++ User's Guide	Provides information on command-line options and how to use the compiler.
	Sun WorkShop Memory Monitor User's Manual	Describes how the Sun WorkShop Memory Monitor solves the problems of memory management in C and C++. This manual is only available through your installed product (see `/opt/SUNWspro/docs/index.html`) and not at the `docs.sun.com` Web site.
Forte^TM for High Performance Computing 6 / Sun WorkShop 6 Compilers Fortran 77/95	Fortran Library Reference	Provides details about the library routines supplied with the Fortran compiler.
	Fortran Programming Guide	Discusses issues relating to input/output, libraries, program analysis, debugging, and performance.
	Fortran User's Guide	Provides information on command-line options and how to use the compilers.
	FORTRAN 77 Language Reference	Provides a complete language reference.
	Interval Arithmetic Programming Reference	Describes the intrinsic `INTERVAL` data type supported by the Fortran 95 compiler.
Forte^TM TeamWare 6 / Sun WorkShop TeamWare 6	Sun WorkShop TeamWare 6 User's Guide	Describes how to use the Sun WorkShop TeamWare code management tools.
Forte Developer 6 / Sun WorkShop Visual 6	Sun WorkShop Visual User's Guide	Describes how to use Visual to create C++ and Java^TM graphical user interfaces.
Forte^TM / Sun Performance Library 6	Sun Performance Library Reference	Discusses the optimized library of subroutines and functions used to perform computational linear algebra and fast Fourier transforms.
	Sun Performance Library User's Guide	Describes how to use the Sun-specific features of the Sun Performance Library, which is a collection of subroutines and functions used to solve linear algebra problems.
Numerical Computation Guide	Numerical Computation Guide	Describes issues regarding the numerical accuracy of floating-point computations.
Standard Library 2	Standard C++ Class Library Reference	Provides details on the Standard C++ Library.
	Standard C++ Library User's Guide	Describes how to use the Standard C++ Library.
Tools.h++ 7	Tools.h++ Class Library Reference	Provides details on the `Tools.h++` class library.
	Tools.h++ User's Guide	Discusses use of the C++ classes for enhancing the efficiency of your programs.

**TABLE P-4** Related Solaris Documentation
Document Collection	Document Title	Description
Solaris Software Developer	Linker and Libraries Guide	Describes the operations of the Solaris link-editor and runtime linker and the objects on which they operate.
	Programming Utilities Guide	Provides information for developers about the special built-in programming tools that are available in the Solaris operating environment.

Library | Contents | Previous | Next | Index