Online Sample Code and Man Pages

Sample Code Directories

The online sample programs are located in subdirectories of the S3L examples directory. Separate C and F77 versions are provided. The generic relative path for these examples is

examples/s3l/operation_class[-language_suffix]/example_name.language

where examples/s3l is installed in a site-specific location.

operation_class is the name of the general class of Sun S3L routines that are illustrated by the example.

The -language_suffix is used to denote F77 implementations. Examples implemented in C do not include the -language_suffix.

example_name.language is the name given to the example. The language extension is .c, or .f. For example,

examples/s3l/dense_matrix_ops-f/outer_prod.f

is the F77 version of a program example that illustrates use of s3l_outer_prod routines. The equivalent examples for C applications is

examples/s3l/dense_matrix_ops/outer_prod.c

Compiling and Running the Examples

Each example subdirectory has a makefile. Each makefile references the file ../Make.simple. If you are copying the example sources and makefiles to one of your own subdirectories, you should also copy Make.simple to your subdirectory's parent directory. Make.simple contains definitions of compilers, compiler flags and other variables that are needed to compile and run the examples. Note that the compiler flags in this file will not provide you with highly optimized executables. Information on optimization flags is best obtained from the documentation for the compiler of interest.

Each makefile has several targets that are meant to simplify the compilation and execution of examples. If you want to compile the source codes and create all executables in a particular example directory, use the command make.

If you wish to run the executables, enter make run. This command will also perform any necessary compilation and linking steps, so you need not issue make before entering make run.

By default, your executables will be run on two processes. You can change this by specifying the NPROCS variable on the command line. For example,

% make run NPROCS=4

will start your runs on four processes.

Executables and object files can be deleted by make clean.

Man Pages

To read the online man page for a Sun S3L routine, enter

% man routine_name

Chapter 7, Sun S3L Toolkit Routines and Chapter 8, Sun S3L Core Library Functions also describe the Sun S3L routines. Chapter 7, Sun S3L Toolkit Routines covers the set of toolkit routines and Chapter 8, Sun S3L Core Library Functions describes the core (computational) routines.