CSML - C# Matrix Library - is a compact and lightweight package for numerical linear algebra. Many matrix operations known from Matlab, Scilab and Co. are implemented.
Version 0.91 - Last update: November 29, 2007.
Make sure to return to this article once in a while for updates. A project of this size a is big thing for one man to handle. Scilab (free Matlab clone), for instance, has been created by an academic consortium, and Matlab's creator, Mathworks, is a well-fed enterprise.
Bug fixes will always come as updates, and if you have a look at the history below, you will see there have been quit a number of, ehm, improvements in a short period of time.
What it can do
The core of the library, the
Matrix class, includes over 90 methods for matrix operations such as multiplication, summation, exponentiation, and solving linear equation systems; matrix manipulations such as concatenation, insertion, transpose, inverse, flipping, symmetrizing, insertion, and extraction; for matrix computations such as determinant, trace, permanent, norm (Frobenius, Euclidian, maximum norm, taxi norm, p-norm), condition number; for matrix decompositions such as LU factorization, Gram-Schmidtian orthogonalization, and Cholesky factorization.
Now the entire library has been updated to work with complex arithmetic. A real matrix M is to be considered a special complex matrix, where M.Re() == M, e.i., the imaginary part of each entry equals 0.
The project is nearly entirely PDF-documented; most methods are also illustrated with examples. Difficult algorithms like the computation of the inverse are explained on a mathematical level as well. If vitally necessary, complexity classes of certain algorithms are noted.
What it cannot do
At this time, there is no implementation of
- polynomials, interpolation, integration (*);
- eigenvectors (*);
(*) - Working on it. Any contribution is welcome. A complex numbers library has been issued by me here on CodeProject, look for CompLib. A library for polynomials has been released as well, PolyLib.
How to use CSML
Two general ways for using the code:
- Include CSML.dll as a reference to your project and type "
using CSML;" on top of your source file
- Include classes Matrix.cs and Complex.cs to your project and adjust namespaces
Let us see an example. Say, we want to compute the determinant and the inverse of the 2 by 2 matrix [1, 1; 1, 2]:
Matrix M = new Matrix("1,1;1,2");
Complex det = M.Determinant();
Matrix Minv = M.Inverse();
string buf = M.ToString();
For details of implementation and usage, refer to the documentation.
Points of interest
This project is issued without license and warranty, it should be considered a gift to the developer's community in general and to this page in particular - most of my programming knowledge is based on free code, on examples and tutorials submitted without the greed for money. I am now in the happy position not having to turn anything into bucks: this is the result.
A word about speed issues
None of the algorithms presented here is optimized for speed. The idea behind this project is to demonstrate many common and well-known algorithms for matrices in a straightforward and understandable way.
Possible optimization ideas are:
- port the methods you need to C++
- many small methods should be declared inline
- use double arrays instead of a matrix data type; C++ allows for dimension extensions during runtime via pointer arithmetic
A word about Eigenvalues
Eigenvalues() method in its current state uses basic QR iteration based upon Gram-Schmidtian orthogonalization. This implies two things:
- for now, computation of Eigenvalues is possible only for real matrices
- if a matrix has multiple Eigenvalues or complex Eigenvalues, the method works, but junk may be returned
In fact, I had thoroughly satisfying results only for triangular matrices and symmetric positive definite matrices.
These problems mirror the difficulties buried under the Eigenvalue problem. Since the Eigenvalues of a matrix A are defined as the roots of the characteristic polynomial:
p(L) = det(A-L*id)
computation is mathematically equivalent to the computation of a determinant and the n roots of p. (Well, this would work for all matrices with any distribution of Eigenvalues, but it is numerically the worst idea, since Weierstrass iteration (compare the
Roots() method in PolyLib) is badly conditioned for polynomials with roots not being well-separated.)
Therefore, I am working on a canonical double-shift QR iteration based upon Givens rotations. That is the way Matlab's function
That I am forced to talk at length about Eigenvalues, although there are so many other difficult computations implemented, reveals to me that this problem is one of the deepest and most bothersome in basic numerical linear algebra.
Conjugate gradient method (
SolveCG() is implemented but buggy); I'm going to issue an example project showing the usage and basic functionality of CSML one of these days.
Update November 29, 2007
- Bug in matrix addition/subtraction (found by Raven123) and bug in horizontal/vertical concatenation fixed (found by alexei_s).
Update July 4, 2007
- Added Hessenberg-Householder reduction, Householder reflection, and Givens rotation;
HessenbergHouseholder() works nicely;
QRIterationHessenberg() are still buggy.
- Alightly modified constructors for vector initialization.
- Bug in
InverseLeverrier() fixed; this black box method should now be standard for matrix inversion (
Inverse() is much slower for general matrices, but fast for special matrices being orthogonal, unitary, or diagonal).
ToString(string format) method in Complex.cs beautified; multiplication of double and complex values slightly changed (no bugs there, but inconsistencies).
Update July 3, 2007 #2
- Major bug in
Arg() fixed (thanks Petr Stanislav!); this affected
Update July 3, 2007
- Minor bug within the matrix access routine fixed, making two
try-catch blocks obsolete and increasing speed enormously.
- Defined matrix exponentiation with negative exponent k as exponentiation of the inverse with (-k); (3) major bug within the
Insert() method fixed.
- Old matrix class (without complex number support) deleted.
Update July 2, 2007
- A rainy Monday in Bavaria... Instead of learning for my exams, I updated and finished the documentation and added the hyperbolic functions
Csch to the
SolveSafe fixed, renamed to
Solve and made static. This method is now nearly equivalent to the Matlab backslash operator. Fixation of
SolveSafe (using LU decomposition with column pivoting) suddenly made the old
Solve method superfluous, which has been removed.
Size method removed and replaced with read-only properties
IsVector method renamed with
VectorLength (tests if a matrix is a vector, e.i. n by 1 or 1 by n).
Update June 29, 2007
- Finally complex numbers and complex matrices; any matrix consists of complex entries now.
New in this version:
- Major bug in
IsPermutation() removed (now: permutation matrices are precisely the involuntary 0-1 matrices; refer to doc).
- Tests for complex matrices implemented:
- Test added:
- Gram-Schmidtian orthogonalization.
- QR iteration based on Gram-Schmidt.
- Function for Eigenvalues (slow!).
- General method
Insert() to insert a submatrix at a certain position.
- General method
Extract() to copy a submatrix from a given matrix.
BlockMatrix() to build a matrix from four given matrices.
ChessboardMatrix() to construct matrices with interchanging 0-1 entries.
Random() extended to generate not just double, but also integer matrices.
Im() to extract the real/imaginary parts of a matrix.
SolveSafe() marked as buggy.
HouseholderVector() implemented but yet (correctly) marked as buggy.
- Documentation updated (but not finished).
- Faster method for matrix inversion:
InverseLeverrier(), using the Leverrier method (RTFM).
Update June 10, 2007
- Major multiplication bug removed; in "
Matrix operator *(Matrix A, double x)".
- Test for definiteness added (works for symmetric matrices only); needs beta-testing!
- Test for symmetric positive definiteness (SPD) added and used within
Cholesky(); Cholesky decomposition is possible only for SPD matrices.
- Undocumented basic graph algorithms: BFS (broad-first search), DFS (depth-first search), and Floyd (shortest paths between all vertices of a graph).