Using Sun Performance Library Fast Fourier Transform Routines

Preface

This book describes how to use the Sun Performance Library^TM fast Fourier transform (FFT) routines that are supported by the Sun WorkShop^TM 6 update 1 FORTRAN 77, Fortran 95, and C compilers. Sun Performance Library FFT routines are based on the FFTPACK and VFFTPACK libraries, which are available from Netlib (http://www.netlib.org).

This book does not describe the mathematics of the FFT or details of how the FFT algorithm is implemented. For information on these topics, see the sources listed in References.

Who Should Use This Book

This book is intended for programmers who want to use the Sun Performance Library FFT routines in their code. Users should have a working knowledge of the Fortran or C language and some understanding of the base FFTPACK and VFFTPACK libraries available from Netlib.

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 products are installed in the /opt directory. If your Sun WorkShop products are not installed in the /opt directory, contact your system administrator for the equivalent path on your system.

---

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.

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.




Related Documentation

For more information about this product, see the following sources. (The names of our development tools has changed from Sun WorkShop^TM to Forte^TM Developer products; you might see both product names used.)

---

Note – If your Sun WorkShop 6 update 1 software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.

---

• Man pages and readmes. This documentation describes the new features, performance enhancements, problems and workarounds, and software corrections in this Sun WorkShop 6 update 1 release.

  You can access these documents in HTML on your local system or network by pointing your browser to file:/opt/SUNWspro/docs/index.html.

• The Sun WorkShop and Sun WorkShop TeamWare online help. The online help has been updated for the new features in this Sun WorkShop 6 update 1 release.

  You can access the online help on your local system or network by pointing your browser to file:/opt/SUNWspro/docs/index.html. You can access the online help from the Help menu in the Sun WorkShop products.

• What's New in Sun WorkShop 6 update 1. This book describes the new features in this Sun WorkShop 6 update 1 release and in the Sun WorkShop 6 release.

  You can access this book on your local system or network by pointing your browser to file:/opt/SUNWspro/docs/index.html. You can also access it by pointing your browser to http://docs.sun.com and searching for the Forte Developer 6 update 1 collection.

• Sun WorkShop 6 manuals. These manuals were provided with Sun WorkShop 6. Information in the Sun WorkShop 6 update 1 man pages, readmes, and online help supersedes information in the Sun WorkShop 6 manuals.

  You can access the manuals on your local system or network by pointing your browser to the Sun WorkShop 6 update 1 Documentation Index (file:/opt/SUNWspro/docs/index.html). You can also access them by pointing your browser to http://docs.sun.com and searching for the Forte C, Forte C++, Forte for High Performance Computing, and Forte TeamWare products.

  The following Sun WorkShop manuals are only accessible on your local system or network (by pointing your browser to file:/opt/SUNWspro/docs/index.html) and not through http://docs.sun.com:

  
  
  • Sun WorkShop Memory Monitor User's Manual
    
  • Standard C++ Class Library Reference
    
  • Standard C++ Library User's Guide
    
  • Tools.h++ Class Library Reference
    
  • Tools.h++ User's Guide
    
  • Sun Performance Library Reference
• Sun WorkShop 6 update 1 supplements. The supplements provide more detailed information on some of the major new features in this Sun WorkShop 6 update 1 release.

  You can access the supplements by pointing your browser to http://docs.sun.com and searching for the Forte Developer 6 update 1 collection.

• Sun WorkShop 6 update 1 Release Notes. These notes provide installation-related and late-breaking information about this Sun WorkShop 6 update 1 release. Information in the release notes supersedes information in any of the other documentation.

  The release notes are available as a text file on the Forte Developer 6 update 1 CD at /cdrom/devpro_v8n1_platform/release_notes.txt. They are also available in HTML on the Forte Developer Products Hot News page by pointing your browser at http://www.sun.com/forte/developer/hotnews.html.