You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

169 lines
5.5 KiB

  1. // This file strutures pages and modules into a convenient hierarchical structure.
  2. namespace StormEigen {
  3. /** \page UserManual_Generalities General topics
  4. - \subpage Eigen2ToEigen3
  5. - \subpage TopicFunctionTakingEigenTypes
  6. - \subpage TopicPreprocessorDirectives
  7. - \subpage TopicAssertions
  8. - \subpage TopicCustomizingEigen
  9. - \subpage TopicMultiThreading
  10. - \subpage TopicUsingIntelMKL
  11. - \subpage TopicCUDA
  12. - \subpage TopicPitfalls
  13. - \subpage TopicTemplateKeyword
  14. - \subpage TopicNewExpressionType
  15. - \subpage UserManual_UnderstandingEigen
  16. */
  17. /** \page UserManual_UnderstandingEigen Understanding Eigen
  18. - \subpage TopicInsideEigenExample
  19. - \subpage TopicClassHierarchy
  20. - \subpage TopicLazyEvaluation
  21. */
  22. /** \page UnclassifiedPages Unclassified pages
  23. - \subpage TopicResizing
  24. - \subpage TopicVectorization
  25. - \subpage TopicEigenExpressionTemplates
  26. - \subpage TopicScalarTypes
  27. - \subpage GettingStarted
  28. - \subpage TutorialSparse_example_details
  29. - \subpage TopicWritingEfficientProductExpression
  30. - \subpage Experimental
  31. */
  32. /** \defgroup Support_modules Support modules
  33. * Category of modules which add support for external libraries.
  34. */
  35. /** \defgroup DenseMatrixManipulation_chapter Dense matrix and array manipulation */
  36. /** \defgroup DenseMatrixManipulation_Alignement Alignment issues */
  37. /** \defgroup DenseMatrixManipulation_Reference Reference */
  38. /** \addtogroup TutorialMatrixClass
  39. \ingroup DenseMatrixManipulation_chapter */
  40. /** \addtogroup TutorialMatrixArithmetic
  41. \ingroup DenseMatrixManipulation_chapter */
  42. /** \addtogroup TutorialArrayClass
  43. \ingroup DenseMatrixManipulation_chapter */
  44. /** \addtogroup TutorialBlockOperations
  45. \ingroup DenseMatrixManipulation_chapter */
  46. /** \addtogroup TutorialAdvancedInitialization
  47. \ingroup DenseMatrixManipulation_chapter */
  48. /** \addtogroup TutorialReductionsVisitorsBroadcasting
  49. \ingroup DenseMatrixManipulation_chapter */
  50. /** \addtogroup TutorialMapClass
  51. \ingroup DenseMatrixManipulation_chapter */
  52. /** \addtogroup TopicAliasing
  53. \ingroup DenseMatrixManipulation_chapter */
  54. /** \addtogroup TopicStorageOrders
  55. \ingroup DenseMatrixManipulation_chapter */
  56. /** \addtogroup DenseMatrixManipulation_Alignement
  57. \ingroup DenseMatrixManipulation_chapter */
  58. /** \addtogroup TopicUnalignedArrayAssert
  59. \ingroup DenseMatrixManipulation_Alignement */
  60. /** \addtogroup TopicFixedSizeVectorizable
  61. \ingroup DenseMatrixManipulation_Alignement */
  62. /** \addtogroup TopicStructHavingEigenMembers
  63. \ingroup DenseMatrixManipulation_Alignement */
  64. /** \addtogroup TopicStlContainers
  65. \ingroup DenseMatrixManipulation_Alignement */
  66. /** \addtogroup TopicPassingByValue
  67. \ingroup DenseMatrixManipulation_Alignement */
  68. /** \addtogroup TopicWrongStackAlignment
  69. \ingroup DenseMatrixManipulation_Alignement */
  70. /** \addtogroup DenseMatrixManipulation_Reference
  71. \ingroup DenseMatrixManipulation_chapter */
  72. /** \addtogroup Core_Module
  73. \ingroup DenseMatrixManipulation_Reference */
  74. /** \addtogroup Jacobi_Module
  75. \ingroup DenseMatrixManipulation_Reference */
  76. /** \addtogroup Householder_Module
  77. \ingroup DenseMatrixManipulation_Reference */
  78. /** \addtogroup QuickRefPage
  79. \ingroup DenseMatrixManipulation_chapter */
  80. /** \defgroup DenseLinearSolvers_chapter Dense linear problems and decompositions */
  81. /** \defgroup DenseLinearSolvers_Reference Reference */
  82. /** \addtogroup TutorialLinearAlgebra
  83. \ingroup DenseLinearSolvers_chapter */
  84. /** \addtogroup TopicLinearAlgebraDecompositions
  85. \ingroup DenseLinearSolvers_chapter */
  86. /** \addtogroup LeastSquares
  87. \ingroup DenseLinearSolvers_chapter */
  88. /** \addtogroup DenseLinearSolvers_Reference
  89. \ingroup DenseLinearSolvers_chapter */
  90. /** \addtogroup Cholesky_Module
  91. \ingroup DenseLinearSolvers_Reference */
  92. /** \addtogroup LU_Module
  93. \ingroup DenseLinearSolvers_Reference */
  94. /** \addtogroup QR_Module
  95. \ingroup DenseLinearSolvers_Reference */
  96. /** \addtogroup SVD_Module
  97. \ingroup DenseLinearSolvers_Reference*/
  98. /** \addtogroup Eigenvalues_Module
  99. \ingroup DenseLinearSolvers_Reference */
  100. /** \defgroup Sparse_chapter Sparse linear algebra */
  101. /** \defgroup Sparse_Reference Reference */
  102. /** \addtogroup TutorialSparse
  103. \ingroup Sparse_chapter */
  104. /** \addtogroup TopicSparseSystems
  105. \ingroup Sparse_chapter */
  106. /** \addtogroup MatrixfreeSolverExample
  107. \ingroup Sparse_chapter */
  108. /** \addtogroup Sparse_Reference
  109. \ingroup Sparse_chapter */
  110. /** \addtogroup SparseCore_Module
  111. \ingroup Sparse_Reference */
  112. /** \addtogroup OrderingMethods_Module
  113. \ingroup Sparse_Reference */
  114. /** \addtogroup SparseCholesky_Module
  115. \ingroup Sparse_Reference */
  116. /** \addtogroup SparseLU_Module
  117. \ingroup Sparse_Reference */
  118. /** \addtogroup SparseQR_Module
  119. \ingroup Sparse_Reference */
  120. /** \addtogroup IterativeLinearSolvers_Module
  121. \ingroup Sparse_Reference */
  122. /** \addtogroup Sparse_Module
  123. \ingroup Sparse_Reference */
  124. /** \addtogroup Support_modules
  125. \ingroup Sparse_Reference */
  126. /** \addtogroup SparseQuickRefPage
  127. \ingroup Sparse_chapter */
  128. /** \defgroup Geometry_chapter Geometry */
  129. /** \defgroup Geometry_Reference Reference */
  130. /** \addtogroup TutorialGeometry
  131. \ingroup Geometry_chapter */
  132. /** \addtogroup Geometry_Reference
  133. \ingroup Geometry_chapter */
  134. /** \addtogroup Geometry_Module
  135. \ingroup Geometry_Reference */
  136. /** \addtogroup Splines_Module
  137. \ingroup Geometry_Reference */
  138. /** \internal \brief Namespace containing low-level routines from the %Eigen library. */
  139. namespace internal {}
  140. }