diff --git a/doc/UsingIntelMKL.dox b/doc/UsingIntelMKL.dox index dbe559e53..a5c1a20b9 100644 --- a/doc/UsingIntelMKL.dox +++ b/doc/UsingIntelMKL.dox @@ -32,11 +32,13 @@ namespace Eigen { -/** \page TopicUsingIntelMKL Using Intel® Math Kernel Library from Eigen +/** \page TopicUsingIntelMKL Using BLAS/LAPACK and Intel® Math Kernel Library from Eigen -\section TopicUsingIntelMKL_Intro Eigen and Intel® Math Kernel Library (Intel® MKL) + + +Since %Eigen version 3.1 and later, users can benefit from built-in Intel MKL optimizations with an installed copy of Intel MKL 10.3 (or later). +Since %Eigen version 3.3 and later, any BLAS or LAPACK libraries can be used as backends. -Since Eigen version 3.1 and later, users can benefit from built-in Intel MKL optimizations with an installed copy of Intel MKL 10.3 (or later). Intel MKL provides highly optimized multi-threaded mathematical routines for x86-compatible architectures. Intel MKL is available on Linux, Mac and Windows for both Intel64 and IA32 architectures. @@ -56,8 +58,8 @@ In addition you can choose which parts will be substituted by defining one or mu
\c EIGEN_USE_BLAS | Enables the use of external BLAS level 2 and 3 routines (compatible with any F77 BLAS interface, not only Intel MKL) |
\c EIGEN_USE_LAPACKE | Enables the use of external Lapack routines via the Intel Lapacke C interface to Lapack (currently works with Intel MKL only) |
\c EIGEN_USE_LAPACKE_STRICT | Same as \c EIGEN_USE_LAPACKE but algorithm of lower robustness are disabled. This currently concerns only JacobiSVD which otherwise would be replaced by \c gesvd that is less robust than Jacobi rotations. |
\c EIGEN_USE_LAPACKE | Enables the use of external Lapack routines via the Lapacke C interface to Lapack (compatible with any F77 LAPACK interface) |
\c EIGEN_USE_LAPACKE_STRICT | Same as \c EIGEN_USE_LAPACKE but algorithm of lower robustness are disabled. \n This currently concerns only JacobiSVD which otherwise would be replaced by \c gesvd that is less robust than Jacobi rotations. |
\c EIGEN_USE_MKL_VML | Enables the use of Intel VML (vector operations) |
\c EIGEN_USE_MKL_ALL | Defines \c EIGEN_USE_BLAS, \c EIGEN_USE_LAPACKE, and \c EIGEN_USE_MKL_VML |