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