ezARPACK

ezARPACK is a C++11 wrapper around ARPACK-NG, a FORTRAN 77 library designed to solve large scale sparse eigenproblems. It allows for solving eigenproblems for symmetric, asymmetric and complex double precision matrices with a minimal amount of boilerplate code. Both standard and generalized problems are supported, as well as all advanced spectral transformation modes from the original FORTRAN implementation.

The main goal of this header-only library is providing easy access to the powerful ARPACK and Parallel ARPACK (PARPACK) algorithms from modern C++ code. ezARPACK pursues this goal by implementing two crucial features.

• Following the ideology of ARPACK, ezARPACK does not force the user to stick with a predefined matrix storage format. Instead, user code is expected to apply a linear operator to a vector (memory buffer) passed to it and to store the result in another buffer at each iteration of the Arnoldi/Lanczos algorithm. Any callable C++ object with a suitable signature can be used to implement action of the operator on a vector.

• Input, output and temporary data arrays used by ARPACK subroutines are allocated and stored as matrix/vector objects from a supported C++ matrix algebra library. Currently, there are a few supported storage backends.

  • Eigen 3

  • Blaze >= 3

  • Armadillo

  • Boost uBLAS >= 1.58

  • TRIQS arrays (part of the TRIQS libraries 2.0–3.0.x)

  • TRIQS/nda library >= 1.1.0

  • xtensor >= 0.20.0

  Upon choosing the right backend via a template parameter of the solver class ezarpack::arpack_solver (or ezarpack::mpi::arpack_solver), programmer can use callable objects to act on the vectors from their library of choice. The output eigenvalues and eigenvectors are accessible to the calling code in a compatible format too.

  Besides covering a range of popular matrix frameworks, ezARPACK allows for easy addition of new backends via specialization of a traits structure.

You can learn about library’s capabilities and the most common usage patterns from the User guide. For an in-depth description of ezARPACK’s API consult the API reference. The source code repository and the issue tracker are hosted on GitHub.

Being a header-only library, ezARPACK does not require installation. However, you may still choose to follow the Installation instructions to build and run unit tests, build examples, and install the library so that it is discoverable by other CMake-based projects.

ezARPACK is distributed under the terms of the Mozilla Public License, v. 2.0. You can obtain a copy of the MPL at http://mozilla.org/MPL/2.0/.

Contents

• Installation instructions
• User guide
  • How to use ezARPACK in your project
    • Makefiles/no build system
    • CMake
  • What algorithm variant is right for your problem?
  • Symmetric real eigenproblems
  • General real eigenproblems
  • General complex eigenproblems
  • Parallel ARPACK versions of eigensolvers
  • List of supported matrix/vector algebra libraries
  • Advanced: Customization of Lanczos/Arnoldi implicit restarting
  • Advanced: Adding a new storage backend
    • Basic header structure
    • Member type definitions of the traits structure
    • Static member functions of the traits structure
    • Optional: Eigenvalue/eigenvector post-processing functions
  • Usage examples: serial solvers
    • Eigen 3
    • Blaze
    • Armadillo
    • Boost uBLAS
    • TRIQS arrays
    • TRIQS/nda
    • xtensor
  • Usage examples: MPI-parallelized solvers
    • Eigen 3
    • Blaze
    • Armadillo
    • Boost uBLAS
    • TRIQS arrays
    • TRIQS/nda
    • xtensor
• API reference
  • Specializations of the arpack_solver class template
    • ezarpack/solver_symmetric.hpp - symmetric real eigenproblems
    • ezarpack/solver_asymmetric.hpp - general real eigenproblems
    • ezarpack/solver_complex.hpp - general complex eigenproblems
  • Specializations of the mpi::arpack_solver class template
    • ezarpack/mpi/solver_symmetric.hpp - symmetric real eigenproblems
    • ezarpack/mpi/solver_asymmetric.hpp - general real eigenproblems
    • ezarpack/mpi/solver_complex.hpp - general complex eigenproblems
  • Data storage backends
    • ezarpack/storages/base.hpp - definition of storage_traits structure
    • ezarpack/storages/eigen.hpp - Eigen 3
    • ezarpack/storages/blaze.hpp - Blaze
    • ezarpack/storages/armadillo.hpp - Armadillo
    • ezarpack/storages/ublas.hpp - Boost uBLAS
    • ezarpack/storages/triqs.hpp - TRIQS arrays
    • ezarpack/storages/nda.hpp - TRIQS/nda
    • ezarpack/storages/xtensor.hpp - xtensor
  • Auxiliary headers
    • ezarpack/common.hpp - declarations of common types and exceptions
    • ezarpack/solver_base.hpp - primary arpack_solver class template
    • ezarpack/arpack_solver.hpp - include all arpack_solver specializations
    • ezarpack/arpack.hpp - low level C++ interface to FORTRAN routines of ARPACK
    • ezarpack/mpi/solver_base.hpp - primary mpi::arpack_solver class template
    • ezarpack/mpi/arpack_solver.hpp - include all mpi::arpack_solver specializations
    • ezarpack/mpi/parpack.hpp - low level C++ interface to FORTRAN routines of PARPACK
    • ezarpack/mpi/mpi_util.hpp - MPI utility functions
    • ezarpack/version.hpp - ezARPACK version information
• Changelog
  • [1.0] - 2022-09-04
  • [0.10] - 2022-02-08
  • [0.9] - 2020-07-04
• Index
• Search Page