1*bf2c3715SXin Linamespace Eigen { 2*bf2c3715SXin Li 3*bf2c3715SXin Li/** \mainpage notitle 4*bf2c3715SXin Li 5*bf2c3715SXin LiThis is the API documentation for Eigen3. You can <a href="eigen-doc.tgz">download</a> it as a tgz archive for offline reading. 6*bf2c3715SXin Li 7*bf2c3715SXin LiFor a first contact with Eigen, the best place is to have a look at the \link GettingStarted getting started \endlink page that show you how to write and compile your first program with Eigen. 8*bf2c3715SXin Li 9*bf2c3715SXin LiThen, the \b quick \b reference \b pages give 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. They currently cover the two following feature sets, and more will come in the future: 10*bf2c3715SXin Li - \link QuickRefPage [QuickRef] Dense matrix and array manipulations \endlink 11*bf2c3715SXin Li - \link SparseQuickRefPage [QuickRef] Sparse linear algebra \endlink 12*bf2c3715SXin Li 13*bf2c3715SXin LiYou're a MatLab user? There is also a <a href="AsciiQuickReference.txt">short ASCII reference</a> with Matlab translations. 14*bf2c3715SXin Li 15*bf2c3715SXin LiThe \b main \b documentation is organized into \em chapters covering different domains of features. 16*bf2c3715SXin LiThey are themselves composed of \em user \em manual pages describing the different features in a comprehensive way, and \em reference pages that gives you access to the API documentation through the related Eigen's \em modules and \em classes. 17*bf2c3715SXin Li 18*bf2c3715SXin LiUnder the \subpage UserManual_CustomizingEigen section, you will find discussions and examples on extending %Eigen's features and supporting custom scalar types. 19*bf2c3715SXin Li 20*bf2c3715SXin LiUnder the \subpage UserManual_Generalities section, you will find documentation on more general topics such as preprocessor directives, controlling assertions, multi-threading, MKL support, some Eigen's internal insights, and much more... 21*bf2c3715SXin Li 22*bf2c3715SXin LiFinally, do not miss the search engine, useful to quickly get to the documentation of a given class or function. 23*bf2c3715SXin Li 24*bf2c3715SXin LiWant more? Checkout the <a href="unsupported/index.html">\em unsupported \em modules </a> documentation. 25*bf2c3715SXin Li 26*bf2c3715SXin Li*/ 27*bf2c3715SXin Li 28*bf2c3715SXin Li} 29