source: pacpussensors/trunk/Vislab/lib3dv-1.2.0/lib3dv/eigen/doc/Manual.dox

Last change on this file was 136, checked in by ldecherf, 9 years ago

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