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