aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/Core
diff options
context:
space:
mode:
Diffstat (limited to 'Eigen/Core')
-rw-r--r--Eigen/Core23
1 files changed, 17 insertions, 6 deletions
diff --git a/Eigen/Core b/Eigen/Core
index 102f23229..9e753a517 100644
--- a/Eigen/Core
+++ b/Eigen/Core
@@ -6,16 +6,27 @@
#include <cstring>
#include <string>
-#ifdef EIGEN_VECTORIZE
-// it seems we cannot assume posix_memalign is defined in the stdlib header
-extern "C" int posix_memalign (void **, size_t, size_t) throw ();
-#endif
-
namespace Eigen {
+/** \defgroup Core_Module Core module
+ * This is the main module of Eigen providing dense matrix and vector support with
+ * features equivalent to a BLAS library and much more...
+ *
+ * \code
+ * #include <Eigen/Core>
+ * \endcode
+ *
+ * To speedup compilation, in header files you might only include the following file:
+ * \code
+ * #include <Eigen/CoreDeclaration>
+ * \endcode
+ * which gives access to matrix and vector types as well as coefficient accessor operators.
+ */
+
+#include "src/Core/util/Memory.h"
#include "src/Core/NumTraits.h"
#include "src/Core/MathFunctions.h"
-#include "src/Core/DummyPacketMath.h"
+#include "src/Core/GenericPacketMath.h"
#if defined EIGEN_VECTORIZE_SSE
#include "src/Core/arch/SSE/PacketMath.h"