1 /*
2  Copyright (c) 2011, Intel Corporation. All rights reserved.
3 
4  Redistribution and use in source and binary forms, with or without modification,
5  are permitted provided that the following conditions are met:
6 
7  * Redistributions of source code must retain the above copyright notice, this
8    list of conditions and the following disclaimer.
9  * Redistributions in binary form must reproduce the above copyright notice,
10    this list of conditions and the following disclaimer in the documentation
11    and/or other materials provided with the distribution.
12  * Neither the name of Intel Corporation nor the names of its contributors may
13    be used to endorse or promote products derived from this software without
14    specific prior written permission.
15 
16  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 
27  ********************************************************************************
28  *   Content : Eigen bindings to Intel(R) MKL
29  *   Include file with common MKL declarations
30  ********************************************************************************
31 */
32 
33 #ifndef EIGEN_MKL_SUPPORT_H
34 #define EIGEN_MKL_SUPPORT_H
35 
36 #ifdef EIGEN_USE_MKL_ALL
37   #ifndef EIGEN_USE_BLAS
38     #define EIGEN_USE_BLAS
39   #endif
40   #ifndef EIGEN_USE_LAPACKE
41     #define EIGEN_USE_LAPACKE
42   #endif
43   #ifndef EIGEN_USE_MKL_VML
44     #define EIGEN_USE_MKL_VML
45   #endif
46 #endif
47 
48 #ifdef EIGEN_USE_LAPACKE_STRICT
49   #define EIGEN_USE_LAPACKE
50 #endif
51 
52 #if defined(EIGEN_USE_MKL_VML)
53   #define EIGEN_USE_MKL
54 #endif
55 
56 #if defined EIGEN_USE_MKL
57 #   include <mkl.h>
58 /*Check IMKL version for compatibility: < 10.3 is not usable with Eigen*/
59 #   ifndef INTEL_MKL_VERSION
60 #       undef EIGEN_USE_MKL /* INTEL_MKL_VERSION is not even defined on older versions */
61 #   elif INTEL_MKL_VERSION < 100305    /* the intel-mkl-103-release-notes say this was when the lapacke.h interface was added*/
62 #       undef EIGEN_USE_MKL
63 #   endif
64 #   ifndef EIGEN_USE_MKL
65     /*If the MKL version is too old, undef everything*/
66 #       undef   EIGEN_USE_MKL_ALL
67 #       undef   EIGEN_USE_LAPACKE
68 #       undef   EIGEN_USE_MKL_VML
69 #       undef   EIGEN_USE_LAPACKE_STRICT
70 #       undef   EIGEN_USE_LAPACKE
71 #   endif
72 #endif
73 
74 #if defined EIGEN_USE_MKL
75 
76 #define EIGEN_MKL_VML_THRESHOLD 128
77 
78 /* MKL_DOMAIN_BLAS, etc are defined only in 10.3 update 7 */
79 /* MKL_BLAS, etc are not defined in 11.2 */
80 #ifdef MKL_DOMAIN_ALL
81 #define EIGEN_MKL_DOMAIN_ALL MKL_DOMAIN_ALL
82 #else
83 #define EIGEN_MKL_DOMAIN_ALL MKL_ALL
84 #endif
85 
86 #ifdef MKL_DOMAIN_BLAS
87 #define EIGEN_MKL_DOMAIN_BLAS MKL_DOMAIN_BLAS
88 #else
89 #define EIGEN_MKL_DOMAIN_BLAS MKL_BLAS
90 #endif
91 
92 #ifdef MKL_DOMAIN_FFT
93 #define EIGEN_MKL_DOMAIN_FFT MKL_DOMAIN_FFT
94 #else
95 #define EIGEN_MKL_DOMAIN_FFT MKL_FFT
96 #endif
97 
98 #ifdef MKL_DOMAIN_VML
99 #define EIGEN_MKL_DOMAIN_VML MKL_DOMAIN_VML
100 #else
101 #define EIGEN_MKL_DOMAIN_VML MKL_VML
102 #endif
103 
104 #ifdef MKL_DOMAIN_PARDISO
105 #define EIGEN_MKL_DOMAIN_PARDISO MKL_DOMAIN_PARDISO
106 #else
107 #define EIGEN_MKL_DOMAIN_PARDISO MKL_PARDISO
108 #endif
109 #endif
110 
111 namespace Eigen {
112 
113 typedef std::complex<double> dcomplex;
114 typedef std::complex<float>  scomplex;
115 
116 #if defined(EIGEN_USE_MKL)
117 typedef MKL_INT BlasIndex;
118 #else
119 typedef int BlasIndex;
120 #endif
121 
122 } // end namespace Eigen
123 
124 #if defined(EIGEN_USE_BLAS)
125 #include "../../misc/blas.h"
126 #endif
127 
128 #endif // EIGEN_MKL_SUPPORT_H
129