Rapid Numerical Prototyping - A simple library for common numerical computations.
C++ C Objective-C
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
devel
doc
inc
src
tests
README.md

README.md

RNP -- Rapid Numerical Prototyping

A simple library for common numerical computations.

The design rationale behind the library was to make it maximally easy to use, with performance a secondary consideration. It turns out however, that for most high level algorithms, there is only one good way to implement them, so the performance tends to be quite good.

Status

Currently, RNP supports all common linear algebra operations typically used in the physical sciences. In this respect, RNP is currently feature complete (the target feature set does not include the TODO items marked below), but some interfaces are not finalized, certain parameters are not respected, and memory allocation is not optimal.

Documentation

Documentation for the different modules is listed below. (Note that GitHub does not support the Discount Markdown extensions, so some of these pages will not render properly; view the actual HTML files for actual reference).

Documentation for activities related to the library is listed below.

Download

  • From now on, the code is hosted on GitHub. You can download the latest snapshot there.

FAQ

  • Are there specialized routines for symmetric or positive definite problems?

    No, not yet. Chances are you can find code on the Internet for symmetric routines, since those are far simpler.

  • How do I invert a matrix?

    Perform a matrix solve with your matrix and use the identity matrix for the right hand side. A slightly more optimal way is to perform the factorization and invert the L and U factors yourself. Seriously, this is the best way. There is no built function since matrix solves are destructive, and the storage conventions depend on the application. You can write your own suitable wrapper for this if you really want it to be more convenient.

  • How do I compile the documentation?

    You have to use the discount package. I use several of its extensions to make things look extra nice. Use the makepage command on each md file.

TODO

  • Ensure IterativeGeneralizedEigensolvers respect iteration limits and multiply limits.
  • Improve tests.
  • Rework JDQZ into its own namespace.
  • Port some Hermitian LAPACK routines.

License

I'm not big on keeping track of licenses, but I will do my best below. Since this library is intended for prototyping, I think it is unlikely anyone will have to bother with looking at licenses.

The code contained in RNP is a mixture of code I wrote and code translated from other sources. Modules IO, Sparse, and the Jacobi eigenssolver are written by myself, and are in the public domain. Modules Random, most of TBLAS, LinearSolve, Eigensystems, and GeneralizedEigensystems are translated from BLAS/LAPACK, and are subject to its license. IterativeLinearSolvers and IterativeGeneralizedEigensystems are translated from Matlab/Fortran code by Martin van Gijzen, Peter Sonneveld, and Gerard L. G. Sleijpen, and are under the GNU General Public License version 2 or later.

Author/collector

This library is maintained by Victor Liu. Email is vee kay ell (three letters) at stanford dot edu.