ARPACK++ (beta version 1.0). aug/1/1997.
ARPACK++ is a c++ interface to the ARPACK package.
ARPACK is a FORTRAN library which implements the implicit restarted
Arnoldi method for solving sparse eigenvalue problems.
This is ARPACK++ main directory.
1) Files included in this directory:
An include file used to compile arpack++ examples. You must change
some directories and machine-dependent directives contained into
this file prior to compiling the examples.
Sample Makefile.inc (compatible with the CC compiler).
Sample Makefile.inc (compatible with the Gnu g++ compiler).
2) ARPACK++ subdirectories:
The directory that contains arpack++ library, i.e., all header
files that define arpack++ class templates.
The directory where all arpack++ examples can be found.
These examples are intended to illustrate how to use and compile
arpack++ classes and are divided according to the type of problem
being solved and also the kind of information that the user is
supposed to supply. Look at the examples/README file for further
The directory that contains a PostScript version of Arpack++
user's manual and some instructions on how to install the
libraries required by ARPACK++.
3) Libraries required by ARPACK++:
a) ARPACK (fortran version):
ARPACK++ is a c++ interface to ARPACK fortran code, so the original
ARPACK library must be installed prior to using the c++ version.
ARPACK may be obtained from Netlib or directly from the URL
b) BLAS and LAPACK (fortran versions):
BLAS and LAPACK routines required by ARPACK are distributed along
with the software, but you should use vendor-optimized versions of
these libraries if they are available.
Some ARPACK++ classes call SUPERLU library functions to solve
eigenvalue problems that require complex or real nonsymmetric matrix
decompositions. Thus, SUPERLU must also be installed if you intend
to use one of these classes. SUPERLU is available at the URL:
UMFPACK package can also be used to solve eigenvalue problems that
require real or complex nonsymmetric/non-Hermitian matrix
decompositions. However, UMFPACK may be used SOLELY for educational,
research, and benchmarking purposes by non-profit organizations and
the U.S. government. Commercial and other organizations may make use
of UMFPACK SOLELY for benchmarking purposes. UMFPACK can be obtained
from ftp://ftp.cis.ufl.edu/pub/umfpack. The MA38 Package in the
Harwell Subroutine Library (HSL) has equivalent functionality (and
identical calling interface) as UMFPACK and is available for
commercial use. Technical reports and information on HSL can be found
at http://www.cis.rl.ac.uk/struct/ARCD/NUM.html. However, neither MA38
nor older versions of UMFPACK are able to handle complex matrices.
4) ARPACK++ documentation:
ARPACK++ user's manual is available in the doc directory. It contains
all information needed to declare and solve eigenvalue problems using
arpack++ classes and functions. Arpack++ computational modes and data
types are also described in the manual.
Instructions on how to install the above mentioned libraries are
given in the doc/install.txt file.
Moreover, README files were include in many Arpack++ directories
to give aditional information about arpack++ files and examples.
5) Using Arpack++:
As a collection of class templates, arpack++ need not to be compiled.
Because templates are defined in header (.h) files, no object (.o)
or library (.a) files have to be built, except those corresponding to
other libraries required by arpack++ (arpack, lapack, blas, superlu
and umfpack). Arpack++ header files are included in the "include"
directory and can be moved to another directory if desired. An option
in the form
should be added to the command line when compiling programs that
use arpack++. Here, ARPACKPP_INC is the name of the directory that
contains all arpack++ header files.
6) Compiler-dependent instructions.
Some compiler-dependent functions and data types used by arpack++ were
grouped in the file include/arch.h. Thus, this file should be changed
to reflect the characteristics of your system. Because at the present
time the library was only compiled with the CC and GNU g++ compilers
and tested in a SUN SparcStation, further work must be done in order to
allow the use of ARPACK++ in other environments.
Moreover, arpack++ also includes a file, include/arcomp,h, that contains
the definition of a class template called arcomplex, created to emulate
the g++ complex class when other compilers are being used. arcomplex is
the only complex type referenced by other ARPACK++ files, so you must
change the definition of this class in order to work with complex
numbers if g++ (or CC) is not being used.
7) Compiling and running ARPACK++ examples:
Arpack++ example directories contain Makefiles that should be used
to compile the examples. For example, to compile example "symsimp"
(that can be found in the examples/product/simple directory, you
just need to write
File symsimp.cc will be compiled and linked to arpack libraries,
and an executable file named symsimp will be created.
8) Reporting bugs and questions:
To report bugs and also to obtain more information about obscure parts
of the ARPACK++ user's manual, send an e-mail to email@example.com.
9) ARPACK (fortran) authors:
Danny Sorensen (firstname.lastname@example.org)
Richard Lehoucq (email@example.com)
Chao Yang (firstname.lastname@example.org)
Kristi Maschhoff (email@example.com)