Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Core / Functors.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 //
6 // Eigen is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 3 of the License, or (at your option) any later version.
10 //
11 // Alternatively, you can redistribute it and/or
12 // modify it under the terms of the GNU General Public License as
13 // published by the Free Software Foundation; either version 2 of
14 // the License, or (at your option) any later version.
15 //
16 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public
22 // License and a copy of the GNU General Public License along with
23 // Eigen. If not, see <http://www.gnu.org/licenses/>.
24
25 #ifndef EIGEN_FUNCTORS_H
26 #define EIGEN_FUNCTORS_H
27
28 // associative functors:
29
30 /** \internal
31   * \brief Template functor to compute the sum of two scalars
32   *
33   * \sa class CwiseBinaryOp, MatrixBase::operator+, class PartialRedux, MatrixBase::sum()
34   */
35 template<typename Scalar> struct ei_scalar_sum_op EIGEN_EMPTY_STRUCT {
36   EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a, const Scalar& b) const { return a + b; }
37   template<typename PacketScalar>
38   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a, const PacketScalar& b) const
39   { return ei_padd(a,b); }
40 };
41 template<typename Scalar>
42 struct ei_functor_traits<ei_scalar_sum_op<Scalar> > {
43   enum {
44     Cost = NumTraits<Scalar>::AddCost,
45     PacketAccess = ei_packet_traits<Scalar>::size>1
46   };
47 };
48
49 /** \internal
50   * \brief Template functor to compute the product of two scalars
51   *
52   * \sa class CwiseBinaryOp, Cwise::operator*(), class PartialRedux, MatrixBase::redux()
53   */
54 template<typename Scalar> struct ei_scalar_product_op EIGEN_EMPTY_STRUCT {
55   EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a, const Scalar& b) const { return a * b; }
56   template<typename PacketScalar>
57   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a, const PacketScalar& b) const
58   { return ei_pmul(a,b); }
59 };
60 template<typename Scalar>
61 struct ei_functor_traits<ei_scalar_product_op<Scalar> > {
62   enum {
63     Cost = NumTraits<Scalar>::MulCost,
64     PacketAccess = ei_packet_traits<Scalar>::size>1
65   };
66 };
67
68 /** \internal
69   * \brief Template functor to compute the min of two scalars
70   *
71   * \sa class CwiseBinaryOp, MatrixBase::cwiseMin, class PartialRedux, MatrixBase::minCoeff()
72   */
73 template<typename Scalar> struct ei_scalar_min_op EIGEN_EMPTY_STRUCT {
74   EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a, const Scalar& b) const { return std::min(a, b); }
75   template<typename PacketScalar>
76   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a, const PacketScalar& b) const
77   { return ei_pmin(a,b); }
78 };
79 template<typename Scalar>
80 struct ei_functor_traits<ei_scalar_min_op<Scalar> > {
81   enum {
82     Cost = NumTraits<Scalar>::AddCost,
83     PacketAccess = ei_packet_traits<Scalar>::size>1
84   };
85 };
86
87 /** \internal
88   * \brief Template functor to compute the max of two scalars
89   *
90   * \sa class CwiseBinaryOp, MatrixBase::cwiseMax, class PartialRedux, MatrixBase::maxCoeff()
91   */
92 template<typename Scalar> struct ei_scalar_max_op EIGEN_EMPTY_STRUCT {
93   EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a, const Scalar& b) const { return std::max(a, b); }
94   template<typename PacketScalar>
95   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a, const PacketScalar& b) const
96   { return ei_pmax(a,b); }
97 };
98 template<typename Scalar>
99 struct ei_functor_traits<ei_scalar_max_op<Scalar> > {
100   enum {
101     Cost = NumTraits<Scalar>::AddCost,
102     PacketAccess = ei_packet_traits<Scalar>::size>1
103   };
104 };
105
106
107 // other binary functors:
108
109 /** \internal
110   * \brief Template functor to compute the difference of two scalars
111   *
112   * \sa class CwiseBinaryOp, MatrixBase::operator-
113   */
114 template<typename Scalar> struct ei_scalar_difference_op EIGEN_EMPTY_STRUCT {
115   EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a, const Scalar& b) const { return a - b; }
116   template<typename PacketScalar>
117   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a, const PacketScalar& b) const
118   { return ei_psub(a,b); }
119 };
120 template<typename Scalar>
121 struct ei_functor_traits<ei_scalar_difference_op<Scalar> > {
122   enum {
123     Cost = NumTraits<Scalar>::AddCost,
124     PacketAccess = ei_packet_traits<Scalar>::size>1
125   };
126 };
127
128 /** \internal
129   * \brief Template functor to compute the quotient of two scalars
130   *
131   * \sa class CwiseBinaryOp, Cwise::operator/()
132   */
133 template<typename Scalar> struct ei_scalar_quotient_op EIGEN_EMPTY_STRUCT {
134   EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a, const Scalar& b) const { return a / b; }
135   template<typename PacketScalar>
136   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a, const PacketScalar& b) const
137   { return ei_pdiv(a,b); }
138 };
139 template<typename Scalar>
140 struct ei_functor_traits<ei_scalar_quotient_op<Scalar> > {
141   enum {
142     Cost = 2 * NumTraits<Scalar>::MulCost,
143     PacketAccess = ei_packet_traits<Scalar>::size>1
144                   #if (defined EIGEN_VECTORIZE_SSE)
145                   && NumTraits<Scalar>::HasFloatingPoint
146                   #endif
147   };
148 };
149
150 // unary functors:
151
152 /** \internal
153   * \brief Template functor to compute the opposite of a scalar
154   *
155   * \sa class CwiseUnaryOp, MatrixBase::operator-
156   */
157 template<typename Scalar> struct ei_scalar_opposite_op EIGEN_EMPTY_STRUCT {
158   EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a) const { return -a; }
159 };
160 template<typename Scalar>
161 struct ei_functor_traits<ei_scalar_opposite_op<Scalar> >
162 { enum { Cost = NumTraits<Scalar>::AddCost, PacketAccess = false }; };
163
164 /** \internal
165   * \brief Template functor to compute the absolute value of a scalar
166   *
167   * \sa class CwiseUnaryOp, Cwise::abs
168   */
169 template<typename Scalar> struct ei_scalar_abs_op EIGEN_EMPTY_STRUCT {
170   typedef typename NumTraits<Scalar>::Real result_type;
171   EIGEN_STRONG_INLINE const result_type operator() (const Scalar& a) const { return ei_abs(a); }
172 };
173 template<typename Scalar>
174 struct ei_functor_traits<ei_scalar_abs_op<Scalar> >
175 {
176   enum {
177     Cost = NumTraits<Scalar>::AddCost,
178     PacketAccess = false // this could actually be vectorized with SSSE3.
179   };
180 };
181
182 /** \internal
183   * \brief Template functor to compute the squared absolute value of a scalar
184   *
185   * \sa class CwiseUnaryOp, Cwise::abs2
186   */
187 template<typename Scalar> struct ei_scalar_abs2_op EIGEN_EMPTY_STRUCT {
188   typedef typename NumTraits<Scalar>::Real result_type;
189   EIGEN_STRONG_INLINE const result_type operator() (const Scalar& a) const { return ei_abs2(a); }
190   template<typename PacketScalar>
191   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a) const
192   { return ei_pmul(a,a); }
193 };
194 template<typename Scalar>
195 struct ei_functor_traits<ei_scalar_abs2_op<Scalar> >
196 { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = int(ei_packet_traits<Scalar>::size)>1 }; };
197
198 /** \internal
199   * \brief Template functor to compute the conjugate of a complex value
200   *
201   * \sa class CwiseUnaryOp, MatrixBase::conjugate()
202   */
203 template<typename Scalar> struct ei_scalar_conjugate_op EIGEN_EMPTY_STRUCT {
204   EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a) const { return ei_conj(a); }
205   template<typename PacketScalar>
206   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a) const { return a; }
207 };
208 template<typename Scalar>
209 struct ei_functor_traits<ei_scalar_conjugate_op<Scalar> >
210 {
211   enum {
212     Cost = NumTraits<Scalar>::IsComplex ? NumTraits<Scalar>::AddCost : 0,
213     PacketAccess = int(ei_packet_traits<Scalar>::size)>1
214   };
215 };
216
217 /** \internal
218   * \brief Template functor to cast a scalar to another type
219   *
220   * \sa class CwiseUnaryOp, MatrixBase::cast()
221   */
222 template<typename Scalar, typename NewType>
223 struct ei_scalar_cast_op EIGEN_EMPTY_STRUCT {
224   typedef NewType result_type;
225   EIGEN_STRONG_INLINE const NewType operator() (const Scalar& a) const { return static_cast<NewType>(a); }
226 };
227 template<typename Scalar, typename NewType>
228 struct ei_functor_traits<ei_scalar_cast_op<Scalar,NewType> >
229 { enum { Cost = ei_is_same_type<Scalar, NewType>::ret ? 0 : NumTraits<NewType>::AddCost, PacketAccess = false }; };
230
231 /** \internal
232   * \brief Template functor to extract the real part of a complex
233   *
234   * \sa class CwiseUnaryOp, MatrixBase::real()
235   */
236 template<typename Scalar>
237 struct ei_scalar_real_op EIGEN_EMPTY_STRUCT {
238   typedef typename NumTraits<Scalar>::Real result_type;
239   EIGEN_STRONG_INLINE result_type operator() (const Scalar& a) const { return ei_real(a); }
240 };
241 template<typename Scalar>
242 struct ei_functor_traits<ei_scalar_real_op<Scalar> >
243 { enum { Cost = 0, PacketAccess = false }; };
244
245 /** \internal
246   * \brief Template functor to extract the imaginary part of a complex
247   *
248   * \sa class CwiseUnaryOp, MatrixBase::imag()
249   */
250 template<typename Scalar>
251 struct ei_scalar_imag_op EIGEN_EMPTY_STRUCT {
252   typedef typename NumTraits<Scalar>::Real result_type;
253   EIGEN_STRONG_INLINE result_type operator() (const Scalar& a) const { return ei_imag(a); }
254 };
255 template<typename Scalar>
256 struct ei_functor_traits<ei_scalar_imag_op<Scalar> >
257 { enum { Cost = 0, PacketAccess = false }; };
258
259 /** \internal
260   * \brief Template functor to multiply a scalar by a fixed other one
261   *
262   * \sa class CwiseUnaryOp, MatrixBase::operator*, MatrixBase::operator/
263   */
264 /* NOTE why doing the ei_pset1() in packetOp *is* an optimization ?
265  * indeed it seems better to declare m_other as a PacketScalar and do the ei_pset1() once
266  * in the constructor. However, in practice:
267  *  - GCC does not like m_other as a PacketScalar and generate a load every time it needs it
268  *  - one the other hand GCC is able to moves the ei_pset1() away the loop :)
269  *  - simpler code ;)
270  * (ICC and gcc 4.4 seems to perform well in both cases, the issue is visible with y = a*x + b*y)
271  */
272 template<typename Scalar>
273 struct ei_scalar_multiple_op {
274   typedef typename ei_packet_traits<Scalar>::type PacketScalar;
275   // FIXME default copy constructors seems bugged with std::complex<>
276   EIGEN_STRONG_INLINE ei_scalar_multiple_op(const ei_scalar_multiple_op& other) : m_other(other.m_other) { }
277   EIGEN_STRONG_INLINE ei_scalar_multiple_op(const Scalar& other) : m_other(other) { }
278   EIGEN_STRONG_INLINE Scalar operator() (const Scalar& a) const { return a * m_other; }
279   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a) const
280   { return ei_pmul(a, ei_pset1(m_other)); }
281   const Scalar m_other;
282 };
283 template<typename Scalar>
284 struct ei_functor_traits<ei_scalar_multiple_op<Scalar> >
285 { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = ei_packet_traits<Scalar>::size>1 }; };
286
287 template<typename Scalar, bool HasFloatingPoint>
288 struct ei_scalar_quotient1_impl {
289   typedef typename ei_packet_traits<Scalar>::type PacketScalar;
290   // FIXME default copy constructors seems bugged with std::complex<>
291   EIGEN_STRONG_INLINE ei_scalar_quotient1_impl(const ei_scalar_quotient1_impl& other) : m_other(other.m_other) { }
292   EIGEN_STRONG_INLINE ei_scalar_quotient1_impl(const Scalar& other) : m_other(static_cast<Scalar>(1) / other) {}
293   EIGEN_STRONG_INLINE Scalar operator() (const Scalar& a) const { return a * m_other; }
294   EIGEN_STRONG_INLINE const PacketScalar packetOp(const PacketScalar& a) const
295   { return ei_pmul(a, ei_pset1(m_other)); }
296   const Scalar m_other;
297 };
298 template<typename Scalar>
299 struct ei_functor_traits<ei_scalar_quotient1_impl<Scalar,true> >
300 { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = ei_packet_traits<Scalar>::size>1 }; };
301
302 template<typename Scalar>
303 struct ei_scalar_quotient1_impl<Scalar,false> {
304   // FIXME default copy constructors seems bugged with std::complex<>
305   EIGEN_STRONG_INLINE ei_scalar_quotient1_impl(const ei_scalar_quotient1_impl& other) : m_other(other.m_other) { }
306   EIGEN_STRONG_INLINE ei_scalar_quotient1_impl(const Scalar& other) : m_other(other) {}
307   EIGEN_STRONG_INLINE Scalar operator() (const Scalar& a) const { return a / m_other; }
308   const Scalar m_other;
309 };
310 template<typename Scalar>
311 struct ei_functor_traits<ei_scalar_quotient1_impl<Scalar,false> >
312 { enum { Cost = 2 * NumTraits<Scalar>::MulCost, PacketAccess = false }; };
313
314 /** \internal
315   * \brief Template functor to divide a scalar by a fixed other one
316   *
317   * This functor is used to implement the quotient of a matrix by
318   * a scalar where the scalar type is not necessarily a floating point type.
319   *
320   * \sa class CwiseUnaryOp, MatrixBase::operator/
321   */
322 template<typename Scalar>
323 struct ei_scalar_quotient1_op : ei_scalar_quotient1_impl<Scalar, NumTraits<Scalar>::HasFloatingPoint > {
324   EIGEN_STRONG_INLINE ei_scalar_quotient1_op(const Scalar& other)
325     : ei_scalar_quotient1_impl<Scalar, NumTraits<Scalar>::HasFloatingPoint >(other) {}
326 };
327
328 // nullary functors
329
330 template<typename Scalar>
331 struct ei_scalar_constant_op {
332   typedef typename ei_packet_traits<Scalar>::type PacketScalar;
333   EIGEN_STRONG_INLINE ei_scalar_constant_op(const ei_scalar_constant_op& other) : m_other(other.m_other) { }
334   EIGEN_STRONG_INLINE ei_scalar_constant_op(const Scalar& other) : m_other(other) { }
335   EIGEN_STRONG_INLINE const Scalar operator() (int, int = 0) const { return m_other; }
336   EIGEN_STRONG_INLINE const PacketScalar packetOp() const { return ei_pset1(m_other); }
337   const Scalar m_other;
338 };
339 template<typename Scalar>
340 struct ei_functor_traits<ei_scalar_constant_op<Scalar> >
341 { enum { Cost = 1, PacketAccess = ei_packet_traits<Scalar>::size>1, IsRepeatable = true }; };
342
343 template<typename Scalar> struct ei_scalar_identity_op EIGEN_EMPTY_STRUCT {
344   EIGEN_STRONG_INLINE ei_scalar_identity_op(void) {}
345   EIGEN_STRONG_INLINE const Scalar operator() (int row, int col) const { return row==col ? Scalar(1) : Scalar(0); }
346 };
347 template<typename Scalar>
348 struct ei_functor_traits<ei_scalar_identity_op<Scalar> >
349 { enum { Cost = NumTraits<Scalar>::AddCost, PacketAccess = false, IsRepeatable = true }; };
350
351 // allow to add new functors and specializations of ei_functor_traits from outside Eigen.
352 // this macro is really needed because ei_functor_traits must be specialized after it is declared but before it is used...
353 #ifdef EIGEN_FUNCTORS_PLUGIN
354 #include EIGEN_FUNCTORS_PLUGIN
355 #endif
356
357 // all functors allow linear access, except ei_scalar_identity_op. So we fix here a quick meta
358 // to indicate whether a functor allows linear access, just always answering 'yes' except for
359 // ei_scalar_identity_op.
360 template<typename Functor> struct ei_functor_has_linear_access { enum { ret = 1 }; };
361 template<typename Scalar> struct ei_functor_has_linear_access<ei_scalar_identity_op<Scalar> > { enum { ret = 0 }; };
362
363 // in CwiseBinaryOp, we require the Lhs and Rhs to have the same scalar type, except for multiplication
364 // where we only require them to have the same _real_ scalar type so one may multiply, say, float by complex<float>.
365 template<typename Functor> struct ei_functor_allows_mixing_real_and_complex { enum { ret = 0 }; };
366 template<typename Scalar> struct ei_functor_allows_mixing_real_and_complex<ei_scalar_product_op<Scalar> > { enum { ret = 1 }; };
367
368 #endif // EIGEN_FUNCTORS_H