Eigen
Eigen
From Eigen
Please, help us to better know about our user community by
answering the following short survey:
https://forms.gle/wpyrxWi18ox9Z5ae9
Contents
1 Overview
2 Documentation
3 Requirements
4 License
5 Compiler support
6 Get support
7 Bug reports
8 Mailing list
9 Discord Server
10 Contributing to
Eigen
11 Projects using Eigen
12 Credits
Announcements Get it
The latest stable release is Eigen 3.4.0. Get it here:
Eigen 3.4.0 tar.bz2
released! (https://gitlab.com/libeigen/eigen/-/archive/3.4.0/eigen-
(18.08.2021) 3.4.0.tar.bz2), tar.gz
(https://gitlab.com/libeigen/eigen/-/archive/3.4.0/eigen-
3.4.0.tar.gz), zip
(https://gitlab.com/libeigen/eigen/-/archive/3.4.0/eigen-
Eigen 3.4-rc1
3.4.0.zip). Changelog.
released!
(19.04.2021)
The latest 3.3 release is Eigen 3.3.9. Get it here: tar.bz2
(https://gitlab.com/libeigen/eigen/-/archive/3.3.9/eigen-
3.3.9.tar.bz2), tar.gz
Eigen 3.3.9 (https://gitlab.com/libeigen/eigen/-/archive/3.3.9/eigen-
released! 3.3.9.tar.gz), zip
(04.12.2020) (https://gitlab.com/libeigen/eigen/-/archive/3.3.9/eigen-
3.3.9.zip). Changelog.
Eigen on Discord The latest 3.2 release is Eigen 3.2.10. Get it here:
(16.11.2020)
tar.bz2
(https://gitlab.com/libeigen/eigen/-/archive/3.2.10/eigen-
3.2.10.tar.bz2), tar.gz
(https://gitlab.com/libeigen/eigen/-/archive/3.2.10/eigen-
https://eigen.tuxfamily.org/index.php?title=Main_Page 1/12
08/12/2021 12:49 Eigen
3.2.10.tar.gz), zip
Eigen 3.3.8 (https://gitlab.com/libeigen/eigen/-/archive/3.2.10/eigen-
released! 3.2.10.zip). Changelog.
(05.10.2020)
The unstable source code from the master is there:
tar.bz2
(https://gitlab.com/libeigen/eigen/-/archive/master/eigen-
master.tar.bz2), tar.gz
(https://gitlab.com/libeigen/eigen/-/archive/master/eigen-
master.tar.gz), zip
(https://gitlab.com/libeigen/eigen/-/archive/master/eigen-
master.zip).
[ other downloads
(https://gitlab.com/libeigen/eigen/-/releases) ] [ browse
the source code
(https://gitlab.com/libeigen/eigen/tree/master) ]
Overview
Eigen is versatile.
It supports all matrix sizes, from small fixed-size matrices to arbitrarily large dense matrices, and
even sparse matrices.
It supports all standard numeric types, including std::complex, integers, and is easily extensible to
custom numeric types
(https://eigen.tuxfamily.org/dox/TopicCustomizingEigen.html#CustomScalarType).
It supports various matrix decompositions
(https://eigen.tuxfamily.org/dox/group__TopicLinearAlgebraDecompositions.html) and geometry
features (https://eigen.tuxfamily.org/dox/group__TutorialGeometry.html).
Its ecosystem of unsupported modules (https://eigen.tuxfamily.org/dox/unsupported/index.html)
provides many specialized features such as non-linear optimization, matrix functions, a polynomial
solver, FFT, and much more.
Eigen is fast.
Expression templates allow intelligently removing temporaries and enable lazy evaluation
(https://eigen.tuxfamily.org/dox/TopicLazyEvaluation.html), when that is appropriate.
Explicit vectorization is performed for SSE 2/3/4, AVX, AVX2, FMA, AVX512, ARM NEON (32-
bit and 64-bit), PowerPC AltiVec/VSX (32-bit and 64-bit), ZVector (s390x/zEC13) SIMD
instruction sets, and since 3.4 MIPS MSA with graceful fallback to non-vectorized code.
Fixed-size matrices are fully optimized: dynamic memory allocation is avoided, and the loops are
unrolled when that makes sense.
For large matrices, special attention is paid to cache-friendliness.
Eigen is reliable.
Algorithms are carefully selected for reliability. Reliability trade-offs are clearly documented
(https://eigen.tuxfamily.org/dox/group__TopicLinearAlgebraDecompositions.html) and extremely
(https://eigen.tuxfamily.org/dox/classEigen_1_1JacobiSVD.html) safe
(https://eigen.tuxfamily.org/dox/classEigen_1_1FullPivHouseholderQR.html) decompositions
(https://eigen.tuxfamily.org/dox/classEigen_1_1FullPivLU.html) are available.
Eigen is thoroughly tested through its own test suite (over 500 executables), the standard BLAS test
suite, and parts of the LAPACK test suite.
https://eigen.tuxfamily.org/index.php?title=Main_Page 2/12
08/12/2021 12:49 Eigen
Eigen is elegant.
The API is extremely clean and expressive while feeling natural to C++ programmers, thanks to
expression templates.
Implementing an algorithm on top of Eigen feels like just copying pseudocode.
Eigen has good compiler support as we run our test suite against many compilers to guarantee reliability
and work around any compiler bugs. Eigen up to version 3.4 is standard C++03 and maintains reasonable
compilation times. Versions following 3.4 will be C++14.
Documentation
Eigen 3 documentation (https://eigen.tuxfamily.org/dox/): this includes a getting started guide
(https://eigen.tuxfamily.org/dox/GettingStarted.html), a long tutorial
(https://eigen.tuxfamily.org/dox/group__TutorialMatrixClass.html), a quick reference
(https://eigen.tuxfamily.org/dox/group__QuickRefPage.html), and page about porting from Eigen 2 to
Eigen 3 (https://eigen.tuxfamily.org/dox/Eigen2ToEigen3.html).
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 (http://www.gnu.org/philosophy/free-sw.html). Starting from the 3.1.1 version, it is
licensed under the MPL2 (https://www.mozilla.org/en-US/MPL/2.0/), which is a simple weak copyleft license.
Common questions about the MPL2 are answered in the official MPL2 FAQ (https://www.mozilla.org/en-
US/MPL/2.0/FAQ/).
Note that currently, a few features rely on third-party code licensed under the LGPL: constrained_cg. Such
features can be explicitly disabled by compiling with the EIGEN_MPL2_ONLY preprocessor symbol defined.
Furthermore, Eigen provides interface classes for various third-party libraries (usually recognizable by the
<Eigen/*Support> header name). Of course you have to mind the license of the so-included library when using
them.
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 (https://www.mozilla.org/en-US/MPL/2.0/FAQ/) for more information, and do not
hesitate to contact us if you have any questions.
https://eigen.tuxfamily.org/index.php?title=Main_Page 3/12
08/12/2021 12:49 Eigen
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.
GCC (http://gcc.gnu.org), version 4.8 and newer. Older versions of gcc might work as well but they are
not tested anymore.
MSVC (https://en.wikipedia.org/wiki/Visual_C%2B%2B) (Visual Studio), 2012 and newer. Be aware that
enabling IntelliSense (/FR flag) is known to trigger some internal compilation errors. The old 3.2 version
of Eigen supports MSVC 2010, and the 3.1 version supports MSVC 2008.
Intel C++ compiler (https://en.wikipedia.org/wiki/Intel_C%2B%2B_Compiler). Enabling the -inline-
forceinline option is highly recommended.
LLVM/CLang++ (http://clang.llvm.org/cxx_status.html), version 3.4 and newer. (The 2.8 version used to
work fine, but it is not tested with up-to-date versions of Eigen)
XCode 7 and newer. Based on LLVM/CLang.
MinGW (https://en.wikipedia.org/wiki/Mingw), recent versions. Based on GCC.
QNX's QCC compiler.
Regarding performance, Eigen performs best with compilers based on GCC or LLVM/Clang. See this page for
some known compilation issues.
Get support
Need help using Eigen? Try this:
Bug reports
For bug reports and feature requests, please use the issue tracker on GitLab
(https://gitlab.com/libeigen/eigen/-/issues).
Mailing list
Address: eigen@lists.tuxfamily.org
In both cases, you will get a confirmation mail to which you need to reply. If you have any trouble please ask at
the eigen-core-team address for help.
The Eigen mailing list can be used for discussing general Eigen development topics. End-user questions are
often better asked on the Use our Discord server or Users Forum (https://forum.kde.org/viewforum.php?f=74).
Development of specific features is best tracked and discussed on our issue tracker on GitLab
(https://gitlab.com/libeigen/eigen/-/issues).
https://eigen.tuxfamily.org/index.php?title=Main_Page 4/12
08/12/2021 12:49 Eigen
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!
There is also a private mailing list which should only be used if you want to write privately to a few core
developers (it is read by Gaël, Christoph, Rasmus, Antonio, David, and Constantino). The address is eigen-core-
team at the same lists server as for the Eigen mailing list. You do not need to subscribe (actually, subscription is
closed). For all Eigen development discussion, use the public mailing list or the issue tracker on GitLab
(https://gitlab.com/libeigen/eigen/-/issues) instead.
Discord Server
Join our Discord server (https://discord.com/invite/2SkEJGqZjR)!
Everybody's welcome to discuss Eigen-related topics or just chat. Bugs should still be reported on the issue
tracker on GitLab (https://gitlab.com/libeigen/eigen/-/issues) and formal discussions should happen on the
mailing list. Discord is an ideal place to ask other users and developers for help.
Contributing to Eigen
Eigen is written and maintained by volunteers. You can contribute in many ways to help: give support to new
users, write and improve documentation, helping with bugs and other issues in the issue tracker on GitLab
(https://gitlab.com/libeigen/eigen/-/issues), discussing the design and the API, running tests and writing code.
See our page on Contributing to Eigen for pointers to get you started.
https://eigen.tuxfamily.org/index.php?title=Main_Page 5/12
08/12/2021 12:49 Eigen
Bindings
Science
GINESTRA (https://www.appliedmaterials.com/semiconductor/products/materials-to-device-simulation),
a semiconductor device simulator with a focus on advanced dielectric materials and interfaces.
G+Smo (https://github.com/gismo/gismo/wiki), an open-source library for geometric design and numerical
simulation with isogeometric analyis.
FlexibleSUSY (https://flexiblesusy.hepforge.org/), a spectrum generator which calculates the masses of
elementary particles.
The ATLAS (https://home.cern/science/experiments/atlas) experiment at the LHC (Large Hadron Collider)
(https://home.cern/science/accelerators/large-hadron-collider) at CERN is using Eigen, as reported in this
article (http://iopscience.iop.org/article/10.1088/1742-6596/608/1/012047/pdf), noting "Eigen was chosen
since it offered the largest performance improvements for ATLAS use cases of the options investigated."
The Large Survey Synoptic Telescope (website (http://www.lsst.org/lsst/); trac
(https://dev.lsstcorp.org/trac)) is a project to build a 3.2Mpixel camera on an 8.4m telescope and survey
the entire visible sky every three days.
Gnu Data Language (http://gnudatalanguage.sourceforge.net/), a GPL interpretor of IDL syntax codes.
Avogadro (https://avogadro.cc/), an opensource advanced molecular editor.
https://eigen.tuxfamily.org/index.php?title=Main_Page 6/12
08/12/2021 12:49 Eigen
The Yujin Robot (https://yujinrobot.com/) company uses Eigen for the navigation and arm control of their
next gen robots. (switched from blitz, ublas and tvmet)
The Robotic Operating System (ROS) (http://www.ros.org) developed by Willow Garage
(http://www.willowgarage.com).
openAHRS (https://github.com/cbecker/openahrs) Open Source IMU
(https://en.wikipedia.org/wiki/Inertial_Measurement_Unit) / AHRS
(https://en.wikipedia.org/wiki/Attitude_and_Heading_Reference_Systems)
The Darmstadt Dribblers (http://www.dribblers.de/) autonomous Humanoid Robot Soccer Team and
Darmstadt Rescue Robot Team (https://www.teamhector.de/) use Eigen for navigation and world
modeling.
The Mobile Robot Programming Toolkit (MRPT) (http://www.mrpt.org/), a set of libraries for SLAM,
localization and computer vision, moved to Eigen (switched from home made math classes).
RBDL (https://github.com/rbdl/rbdl): a C++ library for rigid body dynamics.
RL (https://www.roboticslibrary.org/) a self-contained C++ library for robot kinematics, motion planning
and control.
BTK (https://biomechanical-toolkit.github.io/) is a Biomechanical ToolKit, licensed under BSD whose
primary goal is to propose a set of tools for the analysis of the human body motion which is independent
of any acquisition system. It proposes bindings for Matlab/Octave and Python, and a GUI software called
Mokka to visualize/analyze 3D/2D motion capture data.
libpointmatcher (https://github.com/ethz-asl/libpointmatcher) is a "Iterative Closest Point" library for 3D
mapping in robotics.
RobOptim (http://roboptim.net/) is a modern, Open-Source, C++ library for numerical optimization
applied to robotics.
towr (https://github.com/ethz-adrl/towr) is a light-weight and extensible C++ library for trajectory
optimization for legged robots.
Pinocchio (https://github.com/stack-of-tasks/pinocchio): a fast and efficient Rigid Body Dynamics library
https://eigen.tuxfamily.org/index.php?title=Main_Page 7/12
08/12/2021 12:49 Eigen
Mobile apps
https://eigen.tuxfamily.org/index.php?title=Main_Page 8/12
08/12/2021 12:49 Eigen
If you are aware of some interesting projects using Eigen, please send us a message (including a link and short
description) or directly edit this wiki page!
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!)
https://eigen.tuxfamily.org/index.php?title=Main_Page 9/12
08/12/2021 12:49 Eigen
relicensing
CMake improvements. Laurent is (with Alexander) one of the CMake
Laurent Montel
gurus at KDE!
Eamon Nerbonne Compilation fixes for win32
CMake improvements. Alexander is (with Laurent) one of the CMake
Alexander Neundorf
gurus at KDE!
Jason Newton Componentwise tangent functions
Jitse Niesen Matrix functions, large improvements in the Eigenvalues module and in
(http://www.maths.leeds.ac.uk/~jitse/) the docs, and more ...
Desire Nuentsa Many improvements to Sparse module: SparseLU, SparseQR, ILUT,
(http://www.irisa.fr/sage/desire) 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
Introduce middleRows() / middleCols(), bug fix for nonstandard
Manoj Rajagopalan
numeric types
Stjepan Rajko MSVC compatibility fix
Jure Repinc CMake fixes
Lots of Windows/MSVC compatibility fixes, handling of alignment
Kenneth Frank Riddile
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
Antonio C. Sanches Core Developer
Guillaume Saupin Skyline matrices
Olivier Saut Typo in documentation
Benjamin Schindler gdb pretty printers
Fix in assembly when identifying CPU, Compilation fix connected to
Michael Schmidt
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
Benoit Steiner (http://bsteiner.info) Faster matrix multiplication, Tensor module, CUDA
Sven Strothoff Add intersects() method to AlignedBox
Leszek Swirski Fix oversight in installation scripts
Adam Szalkowski Bug fix in MatrixBase::makeHouseholder()
Silvio Traversaro Fix for FindEigen3.cmake
https://eigen.tuxfamily.org/index.php?title=Main_Page 11/12
08/12/2021 12:49 Eigen
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:
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.
https://eigen.tuxfamily.org/index.php?title=Main_Page 12/12