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