Manual.dox 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. // This file strutures pages and modules into a convenient hierarchical structure.
  2. namespace Eigen {
  3. /** \page UserManual_CustomizingEigen Extending/Customizing Eigen
  4. %Eigen can be extended in several ways, for instance, by defining global methods, by inserting custom methods within main %Eigen's classes through the \ref TopicCustomizing_Plugins "plugin" mechanism, by adding support to \ref TopicCustomizing_CustomScalar "custom scalar types" etc. See below for the respective sub-topics.
  5. - \subpage TopicCustomizing_Plugins
  6. - \subpage TopicCustomizing_InheritingMatrix
  7. - \subpage TopicCustomizing_CustomScalar
  8. - \subpage TopicCustomizing_NullaryExpr
  9. - \subpage TopicNewExpressionType
  10. \sa \ref TopicPreprocessorDirectives
  11. */
  12. /** \page UserManual_Generalities General topics
  13. - \subpage TopicFunctionTakingEigenTypes
  14. - \subpage TopicPreprocessorDirectives
  15. - \subpage TopicAssertions
  16. - \subpage TopicMultiThreading
  17. - \subpage TopicUsingBlasLapack
  18. - \subpage TopicUsingIntelMKL
  19. - \subpage TopicCUDA
  20. - \subpage TopicPitfalls
  21. - \subpage TopicTemplateKeyword
  22. - \subpage UserManual_UnderstandingEigen
  23. - \subpage TopicCMakeGuide
  24. */
  25. /** \page UserManual_UnderstandingEigen Understanding Eigen
  26. - \subpage TopicInsideEigenExample
  27. - \subpage TopicClassHierarchy
  28. - \subpage TopicLazyEvaluation
  29. */
  30. /** \page UnclassifiedPages Unclassified pages
  31. - \subpage TopicResizing
  32. - \subpage TopicVectorization
  33. - \subpage TopicEigenExpressionTemplates
  34. - \subpage TopicScalarTypes
  35. - \subpage GettingStarted
  36. - \subpage TutorialSparse_example_details
  37. - \subpage TopicWritingEfficientProductExpression
  38. - \subpage Experimental
  39. */
  40. /** \defgroup Support_modules Support modules
  41. * Category of modules which add support for external libraries.
  42. */
  43. /** \defgroup DenseMatrixManipulation_chapter Dense matrix and array manipulation */
  44. /** \defgroup DenseMatrixManipulation_Alignement Alignment issues */
  45. /** \defgroup DenseMatrixManipulation_Reference Reference */
  46. /** \addtogroup TutorialMatrixClass
  47. \ingroup DenseMatrixManipulation_chapter */
  48. /** \addtogroup TutorialMatrixArithmetic
  49. \ingroup DenseMatrixManipulation_chapter */
  50. /** \addtogroup TutorialArrayClass
  51. \ingroup DenseMatrixManipulation_chapter */
  52. /** \addtogroup TutorialBlockOperations
  53. \ingroup DenseMatrixManipulation_chapter */
  54. /** \addtogroup TutorialSlicingIndexing
  55. \ingroup DenseMatrixManipulation_chapter */
  56. /** \addtogroup TutorialAdvancedInitialization
  57. \ingroup DenseMatrixManipulation_chapter */
  58. /** \addtogroup TutorialReductionsVisitorsBroadcasting
  59. \ingroup DenseMatrixManipulation_chapter */
  60. /** \addtogroup TutorialReshape
  61. \ingroup DenseMatrixManipulation_chapter */
  62. /** \addtogroup TutorialSTL
  63. \ingroup DenseMatrixManipulation_chapter */
  64. /** \addtogroup TutorialMapClass
  65. \ingroup DenseMatrixManipulation_chapter */
  66. /** \addtogroup TopicAliasing
  67. \ingroup DenseMatrixManipulation_chapter */
  68. /** \addtogroup TopicStorageOrders
  69. \ingroup DenseMatrixManipulation_chapter */
  70. /** \addtogroup DenseMatrixManipulation_Alignement
  71. \ingroup DenseMatrixManipulation_chapter */
  72. /** \addtogroup TopicUnalignedArrayAssert
  73. \ingroup DenseMatrixManipulation_Alignement */
  74. /** \addtogroup TopicFixedSizeVectorizable
  75. \ingroup DenseMatrixManipulation_Alignement */
  76. /** \addtogroup TopicStructHavingEigenMembers
  77. \ingroup DenseMatrixManipulation_Alignement */
  78. /** \addtogroup TopicStlContainers
  79. \ingroup DenseMatrixManipulation_Alignement */
  80. /** \addtogroup TopicPassingByValue
  81. \ingroup DenseMatrixManipulation_Alignement */
  82. /** \addtogroup TopicWrongStackAlignment
  83. \ingroup DenseMatrixManipulation_Alignement */
  84. /** \addtogroup DenseMatrixManipulation_Reference
  85. \ingroup DenseMatrixManipulation_chapter */
  86. /** \addtogroup Core_Module
  87. \ingroup DenseMatrixManipulation_Reference */
  88. /** \addtogroup Jacobi_Module
  89. \ingroup DenseMatrixManipulation_Reference */
  90. /** \addtogroup Householder_Module
  91. \ingroup DenseMatrixManipulation_Reference */
  92. /** \addtogroup CoeffwiseMathFunctions
  93. \ingroup DenseMatrixManipulation_chapter */
  94. /** \addtogroup QuickRefPage
  95. \ingroup DenseMatrixManipulation_chapter */
  96. /** \defgroup DenseLinearSolvers_chapter Dense linear problems and decompositions */
  97. /** \defgroup DenseLinearSolvers_Reference Reference */
  98. /** \addtogroup TutorialLinearAlgebra
  99. \ingroup DenseLinearSolvers_chapter */
  100. /** \addtogroup TopicLinearAlgebraDecompositions
  101. \ingroup DenseLinearSolvers_chapter */
  102. /** \addtogroup LeastSquares
  103. \ingroup DenseLinearSolvers_chapter */
  104. /** \addtogroup InplaceDecomposition
  105. \ingroup DenseLinearSolvers_chapter */
  106. /** \addtogroup DenseDecompositionBenchmark
  107. \ingroup DenseLinearSolvers_chapter */
  108. /** \addtogroup DenseLinearSolvers_Reference
  109. \ingroup DenseLinearSolvers_chapter */
  110. /** \addtogroup Cholesky_Module
  111. \ingroup DenseLinearSolvers_Reference */
  112. /** \addtogroup LU_Module
  113. \ingroup DenseLinearSolvers_Reference */
  114. /** \addtogroup QR_Module
  115. \ingroup DenseLinearSolvers_Reference */
  116. /** \addtogroup SVD_Module
  117. \ingroup DenseLinearSolvers_Reference*/
  118. /** \addtogroup Eigenvalues_Module
  119. \ingroup DenseLinearSolvers_Reference */
  120. /** \defgroup Sparse_chapter Sparse linear algebra */
  121. /** \defgroup Sparse_Reference Reference */
  122. /** \addtogroup TutorialSparse
  123. \ingroup Sparse_chapter */
  124. /** \addtogroup TopicSparseSystems
  125. \ingroup Sparse_chapter */
  126. /** \addtogroup MatrixfreeSolverExample
  127. \ingroup Sparse_chapter */
  128. /** \addtogroup Sparse_Reference
  129. \ingroup Sparse_chapter */
  130. /** \addtogroup SparseCore_Module
  131. \ingroup Sparse_Reference */
  132. /** \addtogroup OrderingMethods_Module
  133. \ingroup Sparse_Reference */
  134. /** \addtogroup SparseCholesky_Module
  135. \ingroup Sparse_Reference */
  136. /** \addtogroup SparseLU_Module
  137. \ingroup Sparse_Reference */
  138. /** \addtogroup SparseQR_Module
  139. \ingroup Sparse_Reference */
  140. /** \addtogroup IterativeLinearSolvers_Module
  141. \ingroup Sparse_Reference */
  142. /** \addtogroup Sparse_Module
  143. \ingroup Sparse_Reference */
  144. /** \addtogroup Support_modules
  145. \ingroup Sparse_Reference */
  146. /** \addtogroup SparseQuickRefPage
  147. \ingroup Sparse_chapter */
  148. /** \defgroup Geometry_chapter Geometry */
  149. /** \defgroup Geometry_Reference Reference */
  150. /** \addtogroup TutorialGeometry
  151. \ingroup Geometry_chapter */
  152. /** \addtogroup Geometry_Reference
  153. \ingroup Geometry_chapter */
  154. /** \addtogroup Geometry_Module
  155. \ingroup Geometry_Reference */
  156. /** \addtogroup Splines_Module
  157. \ingroup Geometry_Reference */
  158. /** \internal \brief Namespace containing low-level routines from the %Eigen library. */
  159. namespace internal {}
  160. }