Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / extern / Eigen2 / Eigen / src / Core / util / XprHelper.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_XPRHELPER_H
27 #define EIGEN_XPRHELPER_H
28
29 // just a workaround because GCC seems to not really like empty structs
30 #ifdef __GNUG__
31   struct ei_empty_struct{char _ei_dummy_;};
32   #define EIGEN_EMPTY_STRUCT : Eigen::ei_empty_struct
33 #else
34   #define EIGEN_EMPTY_STRUCT
35 #endif
36
37 //classes inheriting ei_no_assignment_operator don't generate a default operator=.
38 class ei_no_assignment_operator
39 {
40   private:
41     ei_no_assignment_operator& operator=(const ei_no_assignment_operator&);
42 };
43
44 /** \internal If the template parameter Value is Dynamic, this class is just a wrapper around an int variable that
45   * can be accessed using value() and setValue().
46   * Otherwise, this class is an empty structure and value() just returns the template parameter Value.
47   */
48 template<int Value> class ei_int_if_dynamic EIGEN_EMPTY_STRUCT
49 {
50   public:
51     ei_int_if_dynamic() {}
52     explicit ei_int_if_dynamic(int) {}
53     static int value() { return Value; }
54     void setValue(int) {}
55 };
56
57 template<> class ei_int_if_dynamic<Dynamic>
58 {
59     int m_value;
60     ei_int_if_dynamic() {}
61   public:
62     explicit ei_int_if_dynamic(int value) : m_value(value) {}
63     int value() const { return m_value; }
64     void setValue(int value) { m_value = value; }
65 };
66
67 template<typename T> struct ei_functor_traits
68 {
69   enum
70   {
71     Cost = 10,
72     PacketAccess = false
73   };
74 };
75
76 template<typename T> struct ei_packet_traits
77 {
78   typedef T type;
79   enum {size=1};
80 };
81
82 template<typename T> struct ei_unpacket_traits
83 {
84   typedef T type;
85   enum {size=1};
86 };
87
88 template<typename Scalar, int Rows, int Cols, int Options, int MaxRows, int MaxCols>
89 class ei_compute_matrix_flags
90 {
91     enum {
92       row_major_bit = Options&RowMajor ? RowMajorBit : 0,
93       inner_max_size = row_major_bit ? MaxCols : MaxRows,
94       is_big = inner_max_size == Dynamic,
95       is_packet_size_multiple = (Cols*Rows) % ei_packet_traits<Scalar>::size == 0,
96       aligned_bit = ((Options&AutoAlign) && (is_big || is_packet_size_multiple)) ? AlignedBit : 0,
97       packet_access_bit = ei_packet_traits<Scalar>::size > 1 && aligned_bit ? PacketAccessBit : 0
98     };
99
100   public:
101     enum { ret = LinearAccessBit | DirectAccessBit | packet_access_bit | row_major_bit | aligned_bit };
102 };
103
104 template<int _Rows, int _Cols> struct ei_size_at_compile_time
105 {
106   enum { ret = (_Rows==Dynamic || _Cols==Dynamic) ? Dynamic : _Rows * _Cols };
107 };
108
109 /* ei_eval : the return type of eval(). For matrices, this is just a const reference
110  * in order to avoid a useless copy
111  */
112
113 template<typename T, int Sparseness = ei_traits<T>::Flags&SparseBit> class ei_eval;
114
115 template<typename T> struct ei_eval<T,IsDense>
116 {
117   typedef Matrix<typename ei_traits<T>::Scalar,
118                 ei_traits<T>::RowsAtCompileTime,
119                 ei_traits<T>::ColsAtCompileTime,
120                 AutoAlign | (ei_traits<T>::Flags&RowMajorBit ? RowMajor : ColMajor),
121                 ei_traits<T>::MaxRowsAtCompileTime,
122                 ei_traits<T>::MaxColsAtCompileTime
123           > type;
124 };
125
126 // for matrices, no need to evaluate, just use a const reference to avoid a useless copy
127 template<typename _Scalar, int _Rows, int _Cols, int _StorageOrder, int _MaxRows, int _MaxCols>
128 struct ei_eval<Matrix<_Scalar, _Rows, _Cols, _StorageOrder, _MaxRows, _MaxCols>, IsDense>
129 {
130   typedef const Matrix<_Scalar, _Rows, _Cols, _StorageOrder, _MaxRows, _MaxCols>& type;
131 };
132
133 /* ei_plain_matrix_type : the difference from ei_eval is that ei_plain_matrix_type is always a plain matrix type,
134  * whereas ei_eval is a const reference in the case of a matrix
135  */
136 template<typename T> struct ei_plain_matrix_type
137 {
138   typedef Matrix<typename ei_traits<T>::Scalar,
139                 ei_traits<T>::RowsAtCompileTime,
140                 ei_traits<T>::ColsAtCompileTime,
141                 AutoAlign | (ei_traits<T>::Flags&RowMajorBit ? RowMajor : ColMajor),
142                 ei_traits<T>::MaxRowsAtCompileTime,
143                 ei_traits<T>::MaxColsAtCompileTime
144           > type;
145 };
146
147 /* ei_plain_matrix_type_column_major : same as ei_plain_matrix_type but guaranteed to be column-major
148  */
149 template<typename T> struct ei_plain_matrix_type_column_major
150 {
151   typedef Matrix<typename ei_traits<T>::Scalar,
152                 ei_traits<T>::RowsAtCompileTime,
153                 ei_traits<T>::ColsAtCompileTime,
154                 AutoAlign | ColMajor,
155                 ei_traits<T>::MaxRowsAtCompileTime,
156                 ei_traits<T>::MaxColsAtCompileTime
157           > type;
158 };
159
160 template<typename T> struct ei_must_nest_by_value { enum { ret = false }; };
161 template<typename T> struct ei_must_nest_by_value<NestByValue<T> > { enum { ret = true }; };
162
163 /** \internal Determines how a given expression should be nested into another one.
164   * For example, when you do a * (b+c), Eigen will determine how the expression b+c should be
165   * nested into the bigger product expression. The choice is between nesting the expression b+c as-is, or
166   * evaluating that expression b+c into a temporary variable d, and nest d so that the resulting expression is
167   * a*d. Evaluating can be beneficial for example if every coefficient access in the resulting expression causes
168   * many coefficient accesses in the nested expressions -- as is the case with matrix product for example.
169   *
170   * \param T the type of the expression being nested
171   * \param n the number of coefficient accesses in the nested expression for each coefficient access in the bigger expression.
172   *
173   * Example. Suppose that a, b, and c are of type Matrix3d. The user forms the expression a*(b+c).
174   * b+c is an expression "sum of matrices", which we will denote by S. In order to determine how to nest it,
175   * the Product expression uses: ei_nested<S, 3>::ret, which turns out to be Matrix3d because the internal logic of
176   * ei_nested determined that in this case it was better to evaluate the expression b+c into a temporary. On the other hand,
177   * since a is of type Matrix3d, the Product expression nests it as ei_nested<Matrix3d, 3>::ret, which turns out to be
178   * const Matrix3d&, because the internal logic of ei_nested determined that since a was already a matrix, there was no point
179   * in copying it into another matrix.
180   */
181 template<typename T, int n=1, typename PlainMatrixType = typename ei_eval<T>::type> struct ei_nested
182 {
183   enum {
184     CostEval   = (n+1) * int(NumTraits<typename ei_traits<T>::Scalar>::ReadCost),
185     CostNoEval = (n-1) * int(ei_traits<T>::CoeffReadCost)
186   };
187   typedef typename ei_meta_if<
188     ei_must_nest_by_value<T>::ret,
189     T,
190     typename ei_meta_if<
191       (int(ei_traits<T>::Flags) & EvalBeforeNestingBit)
192       || ( int(CostEval) <= int(CostNoEval) ),
193       PlainMatrixType,
194       const T&
195     >::ret
196   >::ret type;
197 };
198
199 template<unsigned int Flags> struct ei_are_flags_consistent
200 {
201   enum { ret = !( (Flags&UnitDiagBit && Flags&ZeroDiagBit) )
202   };
203 };
204
205 /** \internal Gives the type of a sub-matrix or sub-vector of a matrix of type \a ExpressionType and size \a Size
206   * TODO: could be a good idea to define a big ReturnType struct ??
207   */
208 template<typename ExpressionType, int RowsOrSize=Dynamic, int Cols=Dynamic> struct BlockReturnType {
209   typedef Block<ExpressionType, (ei_traits<ExpressionType>::RowsAtCompileTime == 1 ? 1 : RowsOrSize),
210                                 (ei_traits<ExpressionType>::ColsAtCompileTime == 1 ? 1 : RowsOrSize)> SubVectorType;
211   typedef Block<ExpressionType, RowsOrSize, Cols> Type;
212 };
213
214 template<typename CurrentType, typename NewType> struct ei_cast_return_type
215 {
216   typedef typename ei_meta_if<ei_is_same_type<CurrentType,NewType>::ret,const CurrentType&,NewType>::ret type;
217 };
218
219 #endif // EIGEN_XPRHELPER_H