Main Page

From Eigen
Jump to: navigation, search

Eigen is a C++ template library for linear algebra: matrices, vectors, numerical solvers, and related algorithms.


Announcements

Eigen 3.2.1 released! (26.02.2014) doc

Eigen 3.1.4 & 3.0.7 released! (02.08.2013) doc

Eigen 3.2 released! (24.07.2013) doc

Eigen 3.2-rc2 released! (19.07.2013) doc

Eigen 3.2-rc1 released! (17.07.2013) doc

Get it

The latest stable release is Eigen 3.2.1. Get it here: tar.bz2, tar.gz, zip. Changelog.

The latest 3.1 (previous series) release is Eigen 3.1.4. Get it here: tar.bz2, tar.gz, zip. Changelog.

The latest 3.0 (old series) release is Eigen 3.0.7. Get it here: tar.bz2, tar.gz, zip. Changelog.

The unstable source code from the development branch is there: tar.bz2, tar.gz, zip.

To check out the Eigen repository using Mercurial, also known as "hg", do:

hg clone https://bitbucket.org/eigen/eigen/

Looking for the outdated Eigen2 version? Check it here.

[ other downloads ] [ browse the source code ]


Overview

Documentation

Requirements

Eigen doesn't have any dependencies other than the C++ standard library.

We use the CMake build system, but only to build the documentation and unit-tests, and to automate installation. If you just want to use Eigen, you can use the header files right away. There is no binary library to link to, and no configured header file. Eigen is a pure template library defined in the headers.


License

Eigen is Free Software. Starting from the 3.1.1 version, it is licensed under the MPL2, which is a simple weak copyleft license. Common questions about the MPL2 are answered in the official MPL2 FAQ.

Earlier versions were licensed under the LGPL3+.

Note that currently, a few features rely on third-party code licensed under the LGPL: SimplicialCholesky, AMD ordering, and constrained_cg. Such features can be explicitly disabled by compiling with the EIGEN_MPL2_ONLY preprocessor symbol defined.

Virtually any software may use Eigen. For example, closed-source software may use Eigen without having to disclose its own source code. Many proprietary and closed-source software projects are using Eigen right now, as well as many BSD-licensed projects.

See the MPL2 FAQ for more information, and do not hesitate to contact us if you have any questions.

Compiler support

Eigen is standard C++98 and so should theoretically be compatible with any compliant compiler. Whenever we use some non-standard feature, that is optional and can be disabled.

Eigen is being successfully used with the following compilers:

Projects using Eigen

Extensions, numerical computation and bindings

Science

Robotics and engineering

Computer Graphics

Google

Mobile apps

KDE (our origins!)

Others

If you are aware of some interesting projects using Eigen, please send us a message or directly edit this wiki page !

Get support

Need help using Eigen? Try this:

Bug reports

For bug reports and feature requests, please use the issue tracker. To file a new bug, go there. See this page for some instructions.

Mailing list

Address: eigen@lists.tuxfamily.org

The Eigen mailing list can be used for discussing general Eigen development topics. Notice that:

This mailing list is public and has public archives.

Important: You must subscribe before you may post. Sorry, this is our only way to prevent spam.

Important: After you sent your subscription request, you will receive a confirmation e-mail. Check your spam folder, as these confirmation e-mails are often filtered as spam!

Core Team Mailing list

This private mailing list should only be used for matters that need to be discussed privately. It is read by Benoît, Gaël and Jitse.

Its address is eigen-core-team at the same lists server as for the Eigen mailing list.

No need to subscribe (actually, subscription is closed).

For all Eigen development discussion, use the public Eigen mailing list or Bugzilla instead.

The point of the eigen-core-team list is that sometimes, people want to write privately to a few core developers. This list provides a simple way of doing so.

IRC Channel

Our IRC channel is #eigen on irc.freenode.net.

Everybody's welcome to discuss Eigen-related topics or just chat. Some quick Eigen development chat happens over IRC, but the main place for Eigen development discussion remains the Eigen mailing list. Some user support also happens over IRC, but the main place for Eigen user support is the Users Forum.

Credits

The Eigen project was started by Benoît Jacob (founder) and Gaël Guennebaud (guru). Many other people have since contributed their talents to help make Eigen successful. Here's an alphabetical list: (note to contributors: do add yourself!)

Philip Avery Fix bug and add functionality to AutoDiff module
Abraham Bachrach Added functions for cwise min/max with a scalar
Sebastien Barthelemy Fix EIGEN_INITIALIZE_MATRICES_BY_NAN
Carlos Becker Wrote some of the pages of the tutorial
David Benjamin Artwork: the owls
Cyrille Berger Fix error in logic of installation script
Armin Berres Lots of fixes (compilation warnings and errors)
Jose Luis Blanco Build fixes for MSVC and AMD64, correction in docs
Mark Borgerding FFT module
Romain Bossart Updates to Sparse solvers
Kolja Brix Added documentation to Householder module, fixes for ARPACK wrapper and KroneckerProduct
Gauthier Brun Making a start with a divide-and-conquer SVD implementation
Thomas Capricelli Migration to mercurial, Non-linear optimization and numerical differentiation, cron-job to update the online dox
Nicolas Carre Making a start with a divide-and-conquer SVD implementation
Jean Ceccato Making a start with a divide-and-conquer SVD implementation
Andrew Coles Fixes (including a compilation error)r
Marton Danoczy MSVC compilation fix, support for ARM NEON with Clang 3.0 and LLVM-GCC
Jeff Dean Fix in vectorized square root for small arguments
Christian Ehrlicher MSVC compilation fix
Martinho Fernandes Make our aligned allocator support C++11
Daniel Gomez Ferro Improvements in Sparse and in matrix product
Rohit Garg Vectorized quaternion and cross products, improved integer product
Mathieu Gautier QuaternionMap and related improvements
Anton Gladky Visual Studio 2008 and GCC 4.6 compilation fixes
Stuart Glaser Prevent allocations in LU decomposition
Marc Glisse C++11 compilation issues (suffices for literals)
Frederic Gosselin Improve filter for hidden files in CMake
Gaël Guennebaud Core developer
Philippe Hamelin Allow CMake project to be included in another project
Marcus D. Hanwell CMake improvements. Marcus is a developer at Kitware!
David Harmon Arpack support module
Chen-Pang He Many improvements to MatrixFunctions and KroneckerProduct modules
Hauke Heibel Extended matrix functions, STL compatibility, Splines, CMake improvements, and more ...
Christoph Hertzberg Quaternions, shifts for Cholmod, bug fixes, lots of user support on forums and IRC
Pavel Holoborodko Multi-precision support with MPFR C++, bug fixes for non-standard scalar types
Tim Holy Improvements to tutorial, LDLT update and downdate
Intel Back-end to Intel Math Kernel Library (MKL)
Trevor Irons Square root for complex numbers, fix compile errors and mistake in docs
Benoît Jacob Core developer
Bram de Jong Improvement to benchmark suite
Kibeom Kim Implement *= /= * / operations for VectorwiseOp
Claas Köhler Improvements to Fortran and FFTW in CMake
Alexey Korepanov Add RealQZ class
Igor Krivenko Properly cast constants when using non-standard scalars
Marijn Kruisselbrink CMake fixes
Moritz Lenz Allow solving transposed problem with SuperLU
Sebastian Lipponer MSVC compilation support
Daniel Lowenberg Add SparseView class
David J. Luitz Bug fix for sparse * dense matrix product
Angelos Mantzaflaris Fix to allow IncompleteLUT to be used with MPFR
D J Marcin Fix operator& precedence bug
Konstantinos A. Margaritis AltiVec and ARM NEON vectorization
Ricard Marxer Reverse, redux improvements, the count() method, some dox
Vincenzo Di Massa CMake fix
Christian Mayer Early code review and input in technical/design discussions
Frank Meier-Dörnberg MSVC compatibility fixes
Keir Mierle LDLT decomposition and other improvements, help with MPL relicensing
Laurent Montel CMake improvements. Laurent is (with Alexander) one of the CMake gurus at KDE!
Eamon Nerbonne Compilation fixes for win32
Alexander Neundorf CMake improvements. Alexander is (with Laurent) one of the CMake gurus at KDE!
Jason Newton Componentwise tangent functions
Jitse Niesen Matrix functions, large improvements in the Eigenvalues module and in the docs, and more ...
Desire Nuentsa Many improvements to Sparse module: SparseLU, SparseQR, ILUT, PaStiXSupport, …
Jan Oberländer Compatibility with termios.h
Jos van den Oever Compilation fix
Michael Olbrich Early patches, including the initial loop meta-unroller
Simon Pilgrim Optimizations for NEON
Bjorn Piltz Visual C compilation fix
Benjamin Piwowarski Add conservativeResize() for sparse matrices
Zach Ploskey Copy-editing of tutorial
Giacomo Po MINRES iterative solver
Sergey Popov Fix bug in SelfAdjointEigenSolver
Manoj Rajagopalan Introduce middleRows() / middleCols(), bug fix for nonstandard numeric types
Stjepan Rajko MSVC compatibility fix
Jure Repinc CMake fixes
Kenneth Frank Riddile Lots of Windows/MSVC compatibility fixes, handling of alignment issues
Richard Roberts Bug fix in selection of MKL Householder QR
Adolfo Rodriguez Prevent allocations in matrix decompositions
Peter Román Support for SuperLU's ILU factorization
Oliver Ruepp Bug fix in sparse matrix product with row-major matrices
Radu Bogdan Rusu Fix compilation warning
Guillaume Saupin Skyline matrices
Benjamin Schindler gdb pretty printers
Michael Schmidt Fix in assembly when identifying CPU, Compilation fix connected to min/max
Dennis Schridde New typedefs like AlignedBox3f
Jakob Schwendner Test for unaligned quaternions, Benchmark for Geometry module
Christian Seiler The Tensor module
Martin Senst Bug fix for empty matrices
Sameer Sheorey Fix gdb pretty printer for variable-size matrices
Andy Somerville Functions to get intersection between two ParametrizedLines
Alex Stapleton Help with tough C++ questions
Sven Strothoff Add intersects() method to AlignedBox
Leszek Swirski Fix oversight in installation scripts
Adam Szalkowski Bug fix in MatrixBase::makeHouseholder()
Piotr Trojanek QCC compilation fixes
Anthony Truchet Bugfix in QTransform and QMatrix support
Adolfo Rodriguez Tsourouksdissian Version of JacobiSVD that pre-allocates its resources
James Richard Tyrer CMake fix
Rhys Ulerich Pkg-config support, improved GDB pretty-printer
Ingmar Vanhassel CMake fix
Scott Wheeler Documentation improvements
Urs Wolfer Fixed a serious warning
Manuel Yguel Bug fixes, work on inverse-with-check, the Polynomial module
Pierre Zoppitelli Making a start with a divide-and-conquer SVD implementation

Eigen is also using code that we copied from other sources. They are acknowledged in our sources and in the Mercurial history, but let's also mention them here:

Intel Corporation SSE code for 4x4 matrix inversion taken from here.
Tim Davis AMD reordering simplicial sparse Cholesky factorization adapted from SuiteSparse
Julien Pommier SSE implementation of exp,log,cos,sin math functions from GMM++
Yousef Saad IncompleteLUT preconditioner coming from ITSOL
Minpack authors Algorithms for non linear optimization.

Special thanks to Tuxfamily for the wonderful quality of their services, and the GCC Compile Farm Project that gives us access to many various systems including ARM NEON.

If you are looking for a BibTeX entry to use to cite Eigen in academic papers, see the BibTeX page.

Personal tools
Namespaces
Variants
Actions
Navigation
Documentation
Toolbox