Eigen

Getting started | Tutorial | Short reference

This is the API documentation for Eigen3.

Eigen2 users: here is a Porting from Eigen2 to Eigen3 guide to help porting your application.

For a first contact with Eigen, the best place is to have a look at the tutorial. The short reference page gives you a quite complete description of the API in a very condensed format that is specially useful to recall the syntax of a particular feature, or to have a quick look at the API. For Matlab users, there is also a ASCII quick reference with Matlab translations. The Modules and Classes tabs at the top of this page give you access to the API documentation of individual classes and functions.

Table of contents

• Porting from Eigen2 to Eigen3
• Getting started
• Tutorial
  • Tutorial page 1 - The Matrix class
  • Tutorial page 2 - Matrix and vector arithmetic
  • Tutorial page 3 - The Array class and coefficient-wise operations
  • Tutorial page 4 - Block operations
  • Tutorial page 5 - Advanced initialization
  • Tutorial page 6 - Linear algebra and decompositions
  • Tutorial page 7 - Reductions, visitors and broadcasting
  • Tutorial page 8 - Geometry
  • Tutorial page 9 - Sparse Matrix
• Quick reference guide
• Advanced topics
  • Aliasing
  • Lazy Evaluation and Aliasing
  • Linear algebra and decompositions
  • Customizing/Extending Eigen
  • Preprocessor directives
  • Storage orders
  • What happens inside Eigen, on a simple example
  • Writing efficient matrix product expressions
  • The class hierarchy
  • Writing Functions Taking Eigen Types as Parameters
• Topics related to alignment issues
  • Explanation of the assertion on unaligned arrays
  • Fixed-size vectorizable Eigen objects
  • Using STL Containers with Eigen
  • Structures Having Eigen Members
  • Passing Eigen objects by value to functions
  • Compiler making a wrong assumption on stack alignment

Want more? Checkout the unsupported modules documentation.