mirror of
https://gitlab.com/libeigen/eigen.git
synced 2024-12-15 07:10:37 +08:00
8bfa354ee3
* remove non-existant reference to CwiseAll * define \householder_module (used in HouseholderSequence.h) * update I01_TopicLazyEvaluation.dox - Product is now called GeneralProduct * remove reference to list of examples which was deleted ages ago * rename PartialLU_solve.cpp snippet to PartialPivLU_solve.cpp
27 lines
1.3 KiB
Plaintext
27 lines
1.3 KiB
Plaintext
namespace Eigen {
|
|
|
|
o /** \mainpage Eigen
|
|
|
|
<div class="eimainmenu">\b Overview
|
|
| \ref TutorialCore "Core features"
|
|
| \ref TutorialGeometry "Geometry"
|
|
| \ref TutorialAdvancedLinearAlgebra "Advanced linear algebra"
|
|
| \ref TutorialSparse "Sparse matrix"
|
|
</div>
|
|
|
|
This is the API documentation for Eigen.
|
|
|
|
For a first contact with Eigen, the best place is to have a look at the \ref TutorialCore "tutorial". For an even shorter overview, we have an <a href="AsciiQuickReference.txt">ASCII quick reference</a> with Matlab translations.
|
|
|
|
Most of the API is available as methods in MatrixBase, so this is a good starting point for browsing. Also have a look at Matrix, as a few methods and the matrix constructors are there. Other notable classes for the Eigen API are Cwise, which contains the methods for doing certain coefficient-wise operations, and Part.
|
|
|
|
In fact, except for advanced use, the only class that you'll have to explicitly name in your program, i.e. of which you'll explicitly contruct objects, is Matrix. For instance, vectors are handled as a special case of Matrix with one column. Typedefs are provided, e.g. Vector2f is a typedef for Matrix<float, 2, 1>.
|
|
|
|
Most of the other classes are just return types for MatrixBase methods.
|
|
|
|
Want more? Checkout the \ref Unsupported_modules "unsupported modules" <a href="unsupported/index.html">documentation</a>.
|
|
|
|
*/
|
|
|
|
}
|