Skip to content

Latest commit

 

History

History
178 lines (135 loc) · 6.98 KB

README.md

File metadata and controls

178 lines (135 loc) · 6.98 KB
Raw

ARPACK-NG is a collection of Fortran77 subroutines designed to solve large scale eigenvalue problems.


Coverage Status

Important Features:

  • Reverse Communication Interface.
  • Single and Double Precision Real Arithmetic Versions for Symmetric, Non-symmetric, Standard or Generalized Problems.
  • Single and Double Precision Complex Arithmetic Versions for Standard or Generalized Problems.
  • Routines for Banded Matrices - Standard or Generalized Problems.
  • Routines for The Singular Value Decomposition.
  • Example driver routines that may be used as templates to implement numerous Shift-Invert strategies for all problem types, data types and precision.
  • arpackmm: utility to test arpack with matrix market files. Note: to run this utility, you need the eigen library (to handle RCI).
  • ILP64 support:
    • reminder: you can NOT mix ILP64 with LP64. If you compile arpack-ng with ILP64 (resp. LP64) support, you MUST insure your BLAS/LAPACK is compliant with ILP64 (resp. LP64).
    • users: set INTERFACE64 at configure time.
    • F77/F90 developers:
      • all files which needs ILP64 support must include "arpackicb.h".
      • when coding, use i_int (defined in arpackicb.h) instead of c_int. i_int stands for "iso_c_binding int": it's #defined to c_int or c_int64_t according to the architecture.
    • C/C++ developers:
      • all files which needs ILP64 support must include "arpackdef.h".
      • when coding, use a_int (defined in arpackdef.h) instead of int. a_int stands for "architecture int": it's #defined to int or int64_t according to the architecture.
    • example: to test arpack with sequential ILP64 MKL assuming you use gnu compilers 
      $ export FFLAGS='-DMKL_ILP64 -I/usr/include/mkl'
$ export FCFLAGS='-DMKL_ILP64 -I/usr/include/mkl'
$ export LIBS='-Wl,--no-as-needed -L/usr/lib/x86_64-linux-gnu -lmkl_sequential -lmkl_core -lpthread -lm -ldl'
$ export INTERFACE64=1
$ ./configure --with-blas=mkl_gf_ilp64 --with-lapack=mkl_gf_ilp64
$ make all check```
  • pyarpack: python support based on Boost.Python.Numpy exposing C++ API.

This project started as a joint project between Debian, Octave and Scilab in order to provide a common and maintained version of arpack. This is now a community project maintained by a few volunteers.

Indeed, no single release has been published by Rice university for the last few years and since many software (Octave, Scilab, R, Matlab...) forked it and implemented their own modifications, arpack-ng aims to tackle this by providing a common repository, maintained versions with a testsuite.

arpack-ng is replacing arpack almost everywhere.

  1. You have successfully unbundled ARPACK-NG and are now in the ARPACK-NG directory that was created for you.

  2. The directory SRC contains the top level routines including the highest level reverse communication interface routines

  • ssaupd, dsaupd - symmetric single and double precision

  • snaupd, dnaupd - non-symmetric single and double precision

  • cnaupd, znaupd - complex non-symmetric single and double precision

    The headers of these routines contain full documentation of calling sequence and usage. Additional information is in the DOCUMENTS directory.

    The directory PARPACK contains the Parallel ARPACK routines.

  1. Example driver programs that illustrate all the computational modes, data types and precisions may be found in the EXAMPLES directory. Upon executing the 'ls EXAMPLES' command you should see

  • BAND

  • COMPLEX

  • NONSYM

  • README

  • SIMPLE

  • SVD

  • SYM

    Example programs for banded, complex, nonsymmetric, symmetric, and singular value decomposition may be found in the directories BAND, COMPLEX, NONSYM, SYM, SVD respectively. Look at the README file for further information. To get started, get into the SIMPLE directory to see example programs that illustrate the use of ARPACK in the simplest modes of operation for the most commonly posed standard eigenvalue problems.

    Example programs for Parallel ARPACK may be found in the directory PARPACK/EXAMPLES. Look at the README file for further information.

    The following instructions explain how to make the ARPACK library.

  1. Unlike ARPACK, ARPACK-NG is providing autotools and cmake based build system and iso_c_binding support (which enables to call fortran subroutines natively from C or C++).

Therefore, the classical commands should work as expected:

$ sh bootstrap
$ ./configure
$ make
$ make check
$ make install

Furthermore, ARPACK-NG now provides CMake functionality:

$ mkdir build
$ cd build
$ cmake -D EXAMPLES=ON -D MPI=ON -D BUILD_SHARED_LIBS=ON ..
$ make
$ make install

builds everything including examples and parallel support (with MPI).

To use arpack from CMake, use ARPACK::ARPACK target:

find_package(arpack-ng)
add_executable(main main.f)
target_include_directories(main PUBLIC ARPACK::ARPACK)
target_link_libraries(main ARPACK::ARPACK)

To use parpack from CMake, use PARPACK::PARPACK target:

find_package(arpack-ng)
add_executable(main main.f)
target_include_directories(main PUBLIC PARPACK::PARPACK)
target_link_libraries(main PARPACK::PARPACK)

On mac OS, with GNU compilers, you may need to customize options:

$ LIBS="-framework Accelerate" FFLAGS="-ff2c -fno-second-underscore" FCFLAGS="-ff2c -fno-second-underscore" ./configure

To build with code coverage:

$ mkdir build
$ cd build
$ cmake -DCOVERALLS=ON -DCMAKE_BUILD_TYPE=Debug ..
$ make all check test coveralls

To get iso_c_binding support:

$ ./configure --enable-icb
$ cmake -D ICB=ON

The install will now provide arpack.h/hpp, parpack.h/hpp and friends. Examples of use can be found in ./TESTS and ./PARPACK/TESTS/MPI. A few related links can be found here:

  1. Within DOCUMENTS directory there are three files

  • ex-sym.doc

  • ex-nonsym.doc and

  • ex-complex.doc

    for templates on how to invoke the computational modes of ARPACK. Also look in the README.MD file for explanations concerning the other documents.

  1. Custom installation examples:

    $ LIBSUFFIX="64" ./configure; make all install $ cmake -DLIBSUFFIX="64" ..; make all install

    $ INTERFACE64="1" ITF64SUFFIX="ILP64" ./configure; make all install $ cmake -DINTERFACE64=ON -DITF64SUFFIX="ILP64" ..; make all install

    $ LIBSUFFIX="64" INTERFACE64="1" ITF64SUFFIX="ILP64" ./configure; make all install $ cmake -DLIBSUFFIX="64" -DINTERFACE64=ON -DITF64SUFFIX="ILP64" ..; make all install

Good luck and enjoy.