Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Core / util / Meta.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra. Eigen itself is part of the KDE project.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <g.gael@free.fr>
5 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6 //
7 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25
26 #ifndef EIGEN_META_H
27 #define EIGEN_META_H
28
29 /** \internal
30   * \file Meta.h
31   * This file contains generic metaprogramming classes which are not specifically related to Eigen.
32   * \note In case you wonder, yes we're aware that Boost already provides all these features,
33   * we however don't want to add a dependency to Boost.
34   */
35
36 struct ei_meta_true {  enum { ret = 1 }; };
37 struct ei_meta_false { enum { ret = 0 }; };
38
39 template<bool Condition, typename Then, typename Else>
40 struct ei_meta_if { typedef Then ret; };
41
42 template<typename Then, typename Else>
43 struct ei_meta_if <false, Then, Else> { typedef Else ret; };
44
45 template<typename T, typename U> struct ei_is_same_type { enum { ret = 0 }; };
46 template<typename T> struct ei_is_same_type<T,T> { enum { ret = 1 }; };
47
48 template<typename T> struct ei_unref { typedef T type; };
49 template<typename T> struct ei_unref<T&> { typedef T type; };
50
51 template<typename T> struct ei_unpointer { typedef T type; };
52 template<typename T> struct ei_unpointer<T*> { typedef T type; };
53 template<typename T> struct ei_unpointer<T*const> { typedef T type; };
54
55 template<typename T> struct ei_unconst { typedef T type; };
56 template<typename T> struct ei_unconst<const T> { typedef T type; };
57 template<typename T> struct ei_unconst<T const &> { typedef T & type; };
58 template<typename T> struct ei_unconst<T const *> { typedef T * type; };
59
60 template<typename T> struct ei_cleantype { typedef T type; };
61 template<typename T> struct ei_cleantype<const T>   { typedef typename ei_cleantype<T>::type type; };
62 template<typename T> struct ei_cleantype<const T&>  { typedef typename ei_cleantype<T>::type type; };
63 template<typename T> struct ei_cleantype<T&>        { typedef typename ei_cleantype<T>::type type; };
64 template<typename T> struct ei_cleantype<const T*>  { typedef typename ei_cleantype<T>::type type; };
65 template<typename T> struct ei_cleantype<T*>        { typedef typename ei_cleantype<T>::type type; };
66
67 /** \internal
68   * Convenient struct to get the result type of a unary or binary functor.
69   *
70   * It supports both the current STL mechanism (using the result_type member) as well as
71   * upcoming next STL generation (using a templated result member).
72   * If none of these members is provided, then the type of the first argument is returned. FIXME, that behavior is a pretty bad hack.
73   */
74 template<typename T> struct ei_result_of {};
75
76 struct ei_has_none {int a[1];};
77 struct ei_has_std_result_type {int a[2];};
78 struct ei_has_tr1_result {int a[3];};
79
80 template<typename Func, typename ArgType, int SizeOf=sizeof(ei_has_none)>
81 struct ei_unary_result_of_select {typedef ArgType type;};
82
83 template<typename Func, typename ArgType>
84 struct ei_unary_result_of_select<Func, ArgType, sizeof(ei_has_std_result_type)> {typedef typename Func::result_type type;};
85
86 template<typename Func, typename ArgType>
87 struct ei_unary_result_of_select<Func, ArgType, sizeof(ei_has_tr1_result)> {typedef typename Func::template result<Func(ArgType)>::type type;};
88
89 template<typename Func, typename ArgType>
90 struct ei_result_of<Func(ArgType)> {
91     template<typename T>
92     static ei_has_std_result_type testFunctor(T const *, typename T::result_type const * = 0);
93     template<typename T>
94     static ei_has_tr1_result      testFunctor(T const *, typename T::template result<T(ArgType)>::type const * = 0);
95     static ei_has_none            testFunctor(...);
96
97     // note that the following indirection is needed for gcc-3.3
98     enum {FunctorType = sizeof(testFunctor(static_cast<Func*>(0)))};
99     typedef typename ei_unary_result_of_select<Func, ArgType, FunctorType>::type type;
100 };
101
102 template<typename Func, typename ArgType0, typename ArgType1, int SizeOf=sizeof(ei_has_none)>
103 struct ei_binary_result_of_select {typedef ArgType0 type;};
104
105 template<typename Func, typename ArgType0, typename ArgType1>
106 struct ei_binary_result_of_select<Func, ArgType0, ArgType1, sizeof(ei_has_std_result_type)>
107 {typedef typename Func::result_type type;};
108
109 template<typename Func, typename ArgType0, typename ArgType1>
110 struct ei_binary_result_of_select<Func, ArgType0, ArgType1, sizeof(ei_has_tr1_result)>
111 {typedef typename Func::template result<Func(ArgType0,ArgType1)>::type type;};
112
113 template<typename Func, typename ArgType0, typename ArgType1>
114 struct ei_result_of<Func(ArgType0,ArgType1)> {
115     template<typename T>
116     static ei_has_std_result_type testFunctor(T const *, typename T::result_type const * = 0);
117     template<typename T>
118     static ei_has_tr1_result      testFunctor(T const *, typename T::template result<T(ArgType0,ArgType1)>::type const * = 0);
119     static ei_has_none            testFunctor(...);
120
121     // note that the following indirection is needed for gcc-3.3
122     enum {FunctorType = sizeof(testFunctor(static_cast<Func*>(0)))};
123     typedef typename ei_binary_result_of_select<Func, ArgType0, ArgType1, FunctorType>::type type;
124 };
125
126 /** \internal In short, it computes int(sqrt(\a Y)) with \a Y an integer.
127   * Usage example: \code ei_meta_sqrt<1023>::ret \endcode
128   */
129 template<int Y,
130          int InfX = 0,
131          int SupX = ((Y==1) ? 1 : Y/2),
132          bool Done = ((SupX-InfX)<=1 ? true : ((SupX*SupX <= Y) && ((SupX+1)*(SupX+1) > Y))) >
133                                 // use ?: instead of || just to shut up a stupid gcc 4.3 warning
134 class ei_meta_sqrt
135 {
136     enum {
137       MidX = (InfX+SupX)/2,
138       TakeInf = MidX*MidX > Y ? 1 : 0,
139       NewInf = int(TakeInf) ? InfX : int(MidX),
140       NewSup = int(TakeInf) ? int(MidX) : SupX
141     };
142   public:
143     enum { ret = ei_meta_sqrt<Y,NewInf,NewSup>::ret };
144 };
145
146 template<int Y, int InfX, int SupX>
147 class ei_meta_sqrt<Y, InfX, SupX, true> { public:  enum { ret = (SupX*SupX <= Y) ? SupX : InfX }; };
148
149 /** \internal determines whether the product of two numeric types is allowed and what the return type is */
150 template<typename T, typename U> struct ei_scalar_product_traits
151 {
152   // dummy general case where T and U aren't compatible -- not allowed anyway but we catch it elsewhere
153   //enum { Cost = NumTraits<T>::MulCost };
154   typedef T ReturnType;
155 };
156
157 template<typename T> struct ei_scalar_product_traits<T,T>
158 {
159   //enum { Cost = NumTraits<T>::MulCost };
160   typedef T ReturnType;
161 };
162
163 template<typename T> struct ei_scalar_product_traits<T,std::complex<T> >
164 {
165   //enum { Cost = 2*NumTraits<T>::MulCost };
166   typedef std::complex<T> ReturnType;
167 };
168
169 template<typename T> struct ei_scalar_product_traits<std::complex<T>, T>
170 {
171   //enum { Cost = 2*NumTraits<T>::MulCost  };
172   typedef std::complex<T> ReturnType;
173 };
174
175 // FIXME quick workaround around current limitation of ei_result_of
176 template<typename Scalar, typename ArgType0, typename ArgType1>
177 struct ei_result_of<ei_scalar_product_op<Scalar>(ArgType0,ArgType1)> {
178 typedef typename ei_scalar_product_traits<typename ei_cleantype<ArgType0>::type, typename ei_cleantype<ArgType1>::type>::ReturnType type;
179 };
180
181
182
183 #endif // EIGEN_META_H