aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2009-06-19 20:46:55 +0200
committerGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2009-06-19 20:46:55 +0200
commit8be088bfb0247659decb9d8fd1690fbea66ec958 (patch)
tree7ea2d4e5d4c8d9b2aa2ce41e652edc731fc20307
parentfe8ab0147b06fb0867f0fb9a573bf6b6f5ad9ccd (diff)
add Eigen/Eigen
-rw-r--r--Eigen/Eigen2
-rw-r--r--doc/C01_QuickStartGuide.dox16
2 files changed, 8 insertions, 10 deletions
diff --git a/Eigen/Eigen b/Eigen/Eigen
new file mode 100644
index 000000000..654c8dc63
--- /dev/null
+++ b/Eigen/Eigen
@@ -0,0 +1,2 @@
+#include "Dense"
+#include "Sparse"
diff --git a/doc/C01_QuickStartGuide.dox b/doc/C01_QuickStartGuide.dox
index 7c434f7e2..b60b2ac63 100644
--- a/doc/C01_QuickStartGuide.dox
+++ b/doc/C01_QuickStartGuide.dox
@@ -41,13 +41,6 @@ There is no library to link to. For good performance, add the \c -O2 compile-fla
On the x86 architecture, the SSE2 instruction set is not enabled by default. Use \c -msse2 to enable it, and Eigen will then automatically enable its vectorized paths. On x86-64 and AltiVec-based architectures, vectorization is enabled by default.
-<a name="warningarraymodule"></a>
-\warning \redstar In most cases it is enough to include the \c Eigen/Core header only to get started with Eigen. However, some features presented in this tutorial require the Array module to be included (\c \#include \c <Eigen/Array>). Those features are highlighted with a red star \redstar. Notice that if you want to include all dense (i.e. all except sparse) Eigen functionality at once, you can do:
-\code
-#include <Eigen/Dense>
-\endcode
-This slows compilation by roughly 10-20% but at least you don't have to worry anymore about including the correct files!
-
\section TutorialCoreSimpleExampleFixedSize Simple example with fixed-size matrices and vectors
By fixed-size, we mean that the number of rows and columns are fixed at compile-time. In this case, Eigen avoids dynamic memory allocation, and unroll loops when that makes sense. This is useful for very small sizes: typically up to 4x4, sometimes up to 16x16.
@@ -72,9 +65,12 @@ output:
\include Tutorial_simple_example_dynamic_size.out
</td></tr></table>
-
-
-
+<a name="warningarraymodule"></a>
+\warning \redstar In most cases it is enough to include the \c Eigen/Core header only to get started with Eigen. However, some features presented in this tutorial require the Array module to be included (\c \#include \c <Eigen/Array>). Those features are highlighted with a red star \redstar. Notice that if you want to include all Eigen functionality at once, you can do:
+\code
+#include <Eigen/Eigen>
+\endcode
+This slows compilation down but at least you don't have to worry anymore about including the correct files! There also is the Eigen/Dense header including all dense functionality i.e. leaving out the Sparse module.
<a href="#" class="top">top</a>\section TutorialCoreMatrixTypes Matrix and vector types