Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / extern / Eigen2 / Eigen / src / Array / 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_ARRAY_FUNCTORS_H
26 #define EIGEN_ARRAY_FUNCTORS_H
27
28 /** \internal
29   * \array_module
30   *
31   * \brief Template functor to add a scalar to a fixed other one
32   *
33   * \sa class CwiseUnaryOp, Array::operator+
34   */
35 /* If you wonder why doing the ei_pset1() in packetOp() is an optimization check ei_scalar_multiple_op */
36 template<typename Scalar>
37 struct ei_scalar_add_op {
38   typedef typename ei_packet_traits<Scalar>::type PacketScalar;
39   // FIXME default copy constructors seems bugged with std::complex<>
40   inline ei_scalar_add_op(const ei_scalar_add_op& other) : m_other(other.m_other) { }
41   inline ei_scalar_add_op(const Scalar& other) : m_other(other) { }
42   inline Scalar operator() (const Scalar& a) const { return a + m_other; }
43   inline const PacketScalar packetOp(const PacketScalar& a) const
44   { return ei_padd(a, ei_pset1(m_other)); }
45   const Scalar m_other;
46 private:
47   ei_scalar_add_op& operator=(const ei_scalar_add_op&);
48 };
49 template<typename Scalar>
50 struct ei_functor_traits<ei_scalar_add_op<Scalar> >
51 { enum { Cost = NumTraits<Scalar>::AddCost, PacketAccess = ei_packet_traits<Scalar>::size>1 }; };
52
53 /** \internal
54   *
55   * \array_module
56   *
57   * \brief Template functor to compute the square root of a scalar
58   *
59   * \sa class CwiseUnaryOp, Cwise::sqrt()
60   */
61 template<typename Scalar> struct ei_scalar_sqrt_op EIGEN_EMPTY_STRUCT {
62   inline const Scalar operator() (const Scalar& a) const { return ei_sqrt(a); }
63 };
64 template<typename Scalar>
65 struct ei_functor_traits<ei_scalar_sqrt_op<Scalar> >
66 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = false }; };
67
68 /** \internal
69   *
70   * \array_module
71   *
72   * \brief Template functor to compute the exponential of a scalar
73   *
74   * \sa class CwiseUnaryOp, Cwise::exp()
75   */
76 template<typename Scalar> struct ei_scalar_exp_op EIGEN_EMPTY_STRUCT {
77   inline const Scalar operator() (const Scalar& a) const { return ei_exp(a); }
78 };
79 template<typename Scalar>
80 struct ei_functor_traits<ei_scalar_exp_op<Scalar> >
81 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = false }; };
82
83 /** \internal
84   *
85   * \array_module
86   *
87   * \brief Template functor to compute the logarithm of a scalar
88   *
89   * \sa class CwiseUnaryOp, Cwise::log()
90   */
91 template<typename Scalar> struct ei_scalar_log_op EIGEN_EMPTY_STRUCT {
92   inline const Scalar operator() (const Scalar& a) const { return ei_log(a); }
93 };
94 template<typename Scalar>
95 struct ei_functor_traits<ei_scalar_log_op<Scalar> >
96 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = false }; };
97
98 /** \internal
99   *
100   * \array_module
101   *
102   * \brief Template functor to compute the cosine of a scalar
103   *
104   * \sa class CwiseUnaryOp, Cwise::cos()
105   */
106 template<typename Scalar> struct ei_scalar_cos_op EIGEN_EMPTY_STRUCT {
107   inline const Scalar operator() (const Scalar& a) const { return ei_cos(a); }
108 };
109 template<typename Scalar>
110 struct ei_functor_traits<ei_scalar_cos_op<Scalar> >
111 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = false }; };
112
113 /** \internal
114   *
115   * \array_module
116   *
117   * \brief Template functor to compute the sine of a scalar
118   *
119   * \sa class CwiseUnaryOp, Cwise::sin()
120   */
121 template<typename Scalar> struct ei_scalar_sin_op EIGEN_EMPTY_STRUCT {
122   inline const Scalar operator() (const Scalar& a) const { return ei_sin(a); }
123 };
124 template<typename Scalar>
125 struct ei_functor_traits<ei_scalar_sin_op<Scalar> >
126 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = false }; };
127
128 /** \internal
129   *
130   * \array_module
131   *
132   * \brief Template functor to raise a scalar to a power
133   *
134   * \sa class CwiseUnaryOp, Cwise::pow
135   */
136 template<typename Scalar>
137 struct ei_scalar_pow_op {
138   // FIXME default copy constructors seems bugged with std::complex<>
139   inline ei_scalar_pow_op(const ei_scalar_pow_op& other) : m_exponent(other.m_exponent) { }
140   inline ei_scalar_pow_op(const Scalar& exponent) : m_exponent(exponent) {}
141   inline Scalar operator() (const Scalar& a) const { return ei_pow(a, m_exponent); }
142   const Scalar m_exponent;
143 private:
144   ei_scalar_pow_op& operator=(const ei_scalar_pow_op&);
145 };
146 template<typename Scalar>
147 struct ei_functor_traits<ei_scalar_pow_op<Scalar> >
148 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = false }; };
149
150 /** \internal
151   *
152   * \array_module
153   *
154   * \brief Template functor to compute the inverse of a scalar
155   *
156   * \sa class CwiseUnaryOp, Cwise::inverse()
157   */
158 template<typename Scalar>
159 struct ei_scalar_inverse_op {
160   inline Scalar operator() (const Scalar& a) const { return Scalar(1)/a; }
161   template<typename PacketScalar>
162   inline const PacketScalar packetOp(const PacketScalar& a) const
163   { return ei_pdiv(ei_pset1(Scalar(1)),a); }
164 };
165 template<typename Scalar>
166 struct ei_functor_traits<ei_scalar_inverse_op<Scalar> >
167 { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = int(ei_packet_traits<Scalar>::size)>1 }; };
168
169 /** \internal
170   *
171   * \array_module
172   *
173   * \brief Template functor to compute the square of a scalar
174   *
175   * \sa class CwiseUnaryOp, Cwise::square()
176   */
177 template<typename Scalar>
178 struct ei_scalar_square_op {
179   inline Scalar operator() (const Scalar& a) const { return a*a; }
180   template<typename PacketScalar>
181   inline const PacketScalar packetOp(const PacketScalar& a) const
182   { return ei_pmul(a,a); }
183 };
184 template<typename Scalar>
185 struct ei_functor_traits<ei_scalar_square_op<Scalar> >
186 { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = int(ei_packet_traits<Scalar>::size)>1 }; };
187
188 /** \internal
189   *
190   * \array_module
191   *
192   * \brief Template functor to compute the cube of a scalar
193   *
194   * \sa class CwiseUnaryOp, Cwise::cube()
195   */
196 template<typename Scalar>
197 struct ei_scalar_cube_op {
198   inline Scalar operator() (const Scalar& a) const { return a*a*a; }
199   template<typename PacketScalar>
200   inline const PacketScalar packetOp(const PacketScalar& a) const
201   { return ei_pmul(a,ei_pmul(a,a)); }
202 };
203 template<typename Scalar>
204 struct ei_functor_traits<ei_scalar_cube_op<Scalar> >
205 { enum { Cost = 2*NumTraits<Scalar>::MulCost, PacketAccess = int(ei_packet_traits<Scalar>::size)>1 }; };
206
207 // default ei_functor_traits for STL functors:
208
209 template<typename T>
210 struct ei_functor_traits<std::multiplies<T> >
211 { enum { Cost = NumTraits<T>::MulCost, PacketAccess = false }; };
212
213 template<typename T>
214 struct ei_functor_traits<std::divides<T> >
215 { enum { Cost = NumTraits<T>::MulCost, PacketAccess = false }; };
216
217 template<typename T>
218 struct ei_functor_traits<std::plus<T> >
219 { enum { Cost = NumTraits<T>::AddCost, PacketAccess = false }; };
220
221 template<typename T>
222 struct ei_functor_traits<std::minus<T> >
223 { enum { Cost = NumTraits<T>::AddCost, PacketAccess = false }; };
224
225 template<typename T>
226 struct ei_functor_traits<std::negate<T> >
227 { enum { Cost = NumTraits<T>::AddCost, PacketAccess = false }; };
228
229 template<typename T>
230 struct ei_functor_traits<std::logical_or<T> >
231 { enum { Cost = 1, PacketAccess = false }; };
232
233 template<typename T>
234 struct ei_functor_traits<std::logical_and<T> >
235 { enum { Cost = 1, PacketAccess = false }; };
236
237 template<typename T>
238 struct ei_functor_traits<std::logical_not<T> >
239 { enum { Cost = 1, PacketAccess = false }; };
240
241 template<typename T>
242 struct ei_functor_traits<std::greater<T> >
243 { enum { Cost = 1, PacketAccess = false }; };
244
245 template<typename T>
246 struct ei_functor_traits<std::less<T> >
247 { enum { Cost = 1, PacketAccess = false }; };
248
249 template<typename T>
250 struct ei_functor_traits<std::greater_equal<T> >
251 { enum { Cost = 1, PacketAccess = false }; };
252
253 template<typename T>
254 struct ei_functor_traits<std::less_equal<T> >
255 { enum { Cost = 1, PacketAccess = false }; };
256
257 template<typename T>
258 struct ei_functor_traits<std::equal_to<T> >
259 { enum { Cost = 1, PacketAccess = false }; };
260
261 template<typename T>
262 struct ei_functor_traits<std::not_equal_to<T> >
263 { enum { Cost = 1, PacketAccess = false }; };
264
265 template<typename T>
266 struct ei_functor_traits<std::binder2nd<T> >
267 { enum { Cost = ei_functor_traits<T>::Cost, PacketAccess = false }; };
268
269 template<typename T>
270 struct ei_functor_traits<std::binder1st<T> >
271 { enum { Cost = ei_functor_traits<T>::Cost, PacketAccess = false }; };
272
273 template<typename T>
274 struct ei_functor_traits<std::unary_negate<T> >
275 { enum { Cost = 1 + ei_functor_traits<T>::Cost, PacketAccess = false }; };
276
277 template<typename T>
278 struct ei_functor_traits<std::binary_negate<T> >
279 { enum { Cost = 1 + ei_functor_traits<T>::Cost, PacketAccess = false }; };
280
281 #ifdef EIGEN_STDEXT_SUPPORT
282
283 template<typename T0,typename T1>
284 struct ei_functor_traits<std::project1st<T0,T1> >
285 { enum { Cost = 0, PacketAccess = false }; };
286
287 template<typename T0,typename T1>
288 struct ei_functor_traits<std::project2nd<T0,T1> >
289 { enum { Cost = 0, PacketAccess = false }; };
290
291 template<typename T0,typename T1>
292 struct ei_functor_traits<std::select2nd<std::pair<T0,T1> > >
293 { enum { Cost = 0, PacketAccess = false }; };
294
295 template<typename T0,typename T1>
296 struct ei_functor_traits<std::select1st<std::pair<T0,T1> > >
297 { enum { Cost = 0, PacketAccess = false }; };
298
299 template<typename T0,typename T1>
300 struct ei_functor_traits<std::unary_compose<T0,T1> >
301 { enum { Cost = ei_functor_traits<T0>::Cost + ei_functor_traits<T1>::Cost, PacketAccess = false }; };
302
303 template<typename T0,typename T1,typename T2>
304 struct ei_functor_traits<std::binary_compose<T0,T1,T2> >
305 { enum { Cost = ei_functor_traits<T0>::Cost + ei_functor_traits<T1>::Cost + ei_functor_traits<T2>::Cost, PacketAccess = false }; };
306
307 #endif // EIGEN_STDEXT_SUPPORT
308
309 #endif // EIGEN_ARRAY_FUNCTORS_H