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