mirror of
https://gitlab.com/libeigen/eigen.git
synced 2024-12-21 07:19:46 +08:00
16 lines
675 B
Plaintext
16 lines
675 B
Plaintext
namespace Eigen {
|
|
|
|
o /** \mainpage Eigen
|
|
|
|
This is the API documentation for Eigen.
|
|
|
|
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.
|
|
|
|
For a first contact with Eigen, it is enough to look at Matrix and MatrixBase. 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.
|
|
|
|
The many other classes are typically return types for MatrixBase methods.
|
|
|
|
*/
|
|
|
|
}
|