Eigen  3.2.91
UnaryFunctors.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008-2010 Gael Guennebaud <gael.guennebaud@inria.fr>
5 //
6 // This Source Code Form is subject to the terms of the Mozilla
7 // Public License v. 2.0. If a copy of the MPL was not distributed
8 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 
10 #ifndef EIGEN_UNARY_FUNCTORS_H
11 #define EIGEN_UNARY_FUNCTORS_H
12 
13 namespace Eigen {
14 
15 namespace internal {
16 
22 template<typename Scalar> struct scalar_opposite_op {
23  EIGEN_EMPTY_STRUCT_CTOR(scalar_opposite_op)
24  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a) const { return -a; }
25  template<typename Packet>
26  EIGEN_STRONG_INLINE const Packet packetOp(const Packet& a) const
27  { return internal::pnegate(a); }
28 };
29 template<typename Scalar>
30 struct functor_traits<scalar_opposite_op<Scalar> >
31 { enum {
32  Cost = NumTraits<Scalar>::AddCost,
33  PacketAccess = packet_traits<Scalar>::HasNegate };
34 };
35 
41 template<typename Scalar> struct scalar_abs_op {
42  EIGEN_EMPTY_STRUCT_CTOR(scalar_abs_op)
43  typedef typename NumTraits<Scalar>::Real result_type;
44  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const result_type operator() (const Scalar& a) const { using std::abs; return abs(a); }
45  template<typename Packet>
46  EIGEN_STRONG_INLINE const Packet packetOp(const Packet& a) const
47  { return internal::pabs(a); }
48 };
49 template<typename Scalar>
50 struct functor_traits<scalar_abs_op<Scalar> >
51 {
52  enum {
53  Cost = NumTraits<Scalar>::AddCost,
54  PacketAccess = packet_traits<Scalar>::HasAbs
55  };
56 };
57 
63 template<typename Scalar> struct scalar_score_coeff_op : scalar_abs_op<Scalar>
64 {
65  typedef void Score_is_abs;
66 };
67 template<typename Scalar>
68 struct functor_traits<scalar_score_coeff_op<Scalar> > : functor_traits<scalar_abs_op<Scalar> > {};
69 
70 /* Avoid recomputing abs when we know the score and they are the same. Not a true Eigen functor. */
71 template<typename Scalar, typename=void> struct abs_knowing_score
72 {
73  EIGEN_EMPTY_STRUCT_CTOR(abs_knowing_score)
74  typedef typename NumTraits<Scalar>::Real result_type;
75  template<typename Score>
76  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const result_type operator() (const Scalar& a, const Score&) const { using std::abs; return abs(a); }
77 };
78 template<typename Scalar> struct abs_knowing_score<Scalar, typename scalar_score_coeff_op<Scalar>::Score_is_abs>
79 {
80  EIGEN_EMPTY_STRUCT_CTOR(abs_knowing_score)
81  typedef typename NumTraits<Scalar>::Real result_type;
82  template<typename Scal>
83  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const result_type operator() (const Scal&, const result_type& a) const { return a; }
84 };
85 
91 template<typename Scalar> struct scalar_abs2_op {
92  EIGEN_EMPTY_STRUCT_CTOR(scalar_abs2_op)
93  typedef typename NumTraits<Scalar>::Real result_type;
94  EIGEN_DEVICE_FUNC
95  EIGEN_STRONG_INLINE const result_type operator() (const Scalar& a) const { return numext::abs2(a); }
96  template<typename Packet>
97  EIGEN_STRONG_INLINE const Packet packetOp(const Packet& a) const
98  { return internal::pmul(a,a); }
99 };
100 template<typename Scalar>
101 struct functor_traits<scalar_abs2_op<Scalar> >
102 { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = packet_traits<Scalar>::HasAbs2 }; };
103 
109 template<typename Scalar> struct scalar_conjugate_op {
110  EIGEN_EMPTY_STRUCT_CTOR(scalar_conjugate_op)
111  EIGEN_DEVICE_FUNC
112  EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a) const { using numext::conj; return conj(a); }
113  template<typename Packet>
114  EIGEN_STRONG_INLINE const Packet packetOp(const Packet& a) const { return internal::pconj(a); }
115 };
116 template<typename Scalar>
117 struct functor_traits<scalar_conjugate_op<Scalar> >
118 {
119  enum {
120  Cost = NumTraits<Scalar>::IsComplex ? NumTraits<Scalar>::AddCost : 0,
121  PacketAccess = packet_traits<Scalar>::HasConj
122  };
123 };
124 
130 template<typename Scalar> struct scalar_arg_op {
131  EIGEN_EMPTY_STRUCT_CTOR(scalar_arg_op)
132  typedef typename NumTraits<Scalar>::Real result_type;
133  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const result_type operator() (const Scalar& a) const { using numext::arg; return arg(a); }
134  template<typename Packet>
135  EIGEN_STRONG_INLINE const Packet packetOp(const Packet& a) const
136  { return internal::parg(a); }
137 };
138 template<typename Scalar>
139 struct functor_traits<scalar_arg_op<Scalar> >
140 {
141  enum {
142  Cost = NumTraits<Scalar>::IsComplex ? 5 * NumTraits<Scalar>::MulCost : NumTraits<Scalar>::AddCost,
143  PacketAccess = packet_traits<Scalar>::HasArg
144  };
145 };
151 template<typename Scalar, typename NewType>
152 struct scalar_cast_op {
153  EIGEN_EMPTY_STRUCT_CTOR(scalar_cast_op)
154  typedef NewType result_type;
155  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const NewType operator() (const Scalar& a) const { return cast<Scalar, NewType>(a); }
156 };
157 template<typename Scalar, typename NewType>
158 struct functor_traits<scalar_cast_op<Scalar,NewType> >
159 { enum { Cost = is_same<Scalar, NewType>::value ? 0 : NumTraits<NewType>::AddCost, PacketAccess = false }; };
160 
166 template<typename Scalar>
167 struct scalar_real_op {
168  EIGEN_EMPTY_STRUCT_CTOR(scalar_real_op)
169  typedef typename NumTraits<Scalar>::Real result_type;
170  EIGEN_DEVICE_FUNC
171  EIGEN_STRONG_INLINE result_type operator() (const Scalar& a) const { return numext::real(a); }
172 };
173 template<typename Scalar>
174 struct functor_traits<scalar_real_op<Scalar> >
175 { enum { Cost = 0, PacketAccess = false }; };
176 
182 template<typename Scalar>
183 struct scalar_imag_op {
184  EIGEN_EMPTY_STRUCT_CTOR(scalar_imag_op)
185  typedef typename NumTraits<Scalar>::Real result_type;
186  EIGEN_DEVICE_FUNC
187  EIGEN_STRONG_INLINE result_type operator() (const Scalar& a) const { return numext::imag(a); }
188 };
189 template<typename Scalar>
190 struct functor_traits<scalar_imag_op<Scalar> >
191 { enum { Cost = 0, PacketAccess = false }; };
192 
198 template<typename Scalar>
199 struct scalar_real_ref_op {
200  EIGEN_EMPTY_STRUCT_CTOR(scalar_real_ref_op)
201  typedef typename NumTraits<Scalar>::Real result_type;
202  EIGEN_DEVICE_FUNC
203  EIGEN_STRONG_INLINE result_type& operator() (const Scalar& a) const { return numext::real_ref(*const_cast<Scalar*>(&a)); }
204 };
205 template<typename Scalar>
206 struct functor_traits<scalar_real_ref_op<Scalar> >
207 { enum { Cost = 0, PacketAccess = false }; };
208 
214 template<typename Scalar>
215 struct scalar_imag_ref_op {
216  EIGEN_EMPTY_STRUCT_CTOR(scalar_imag_ref_op)
217  typedef typename NumTraits<Scalar>::Real result_type;
218  EIGEN_DEVICE_FUNC
219  EIGEN_STRONG_INLINE result_type& operator() (const Scalar& a) const { return numext::imag_ref(*const_cast<Scalar*>(&a)); }
220 };
221 template<typename Scalar>
222 struct functor_traits<scalar_imag_ref_op<Scalar> >
223 { enum { Cost = 0, PacketAccess = false }; };
224 
231 template<typename Scalar> struct scalar_exp_op {
232  EIGEN_EMPTY_STRUCT_CTOR(scalar_exp_op)
233  EIGEN_DEVICE_FUNC inline const Scalar operator() (const Scalar& a) const { using std::exp; return exp(a); }
234  template <typename Packet>
235  inline Packet packetOp(const Packet& a) const { return internal::pexp(a); }
236 };
237 template<typename Scalar>
238 struct functor_traits<scalar_exp_op<Scalar> >
239 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = packet_traits<Scalar>::HasExp }; };
240 
247 template<typename Scalar> struct scalar_log_op {
248  EIGEN_EMPTY_STRUCT_CTOR(scalar_log_op)
249  EIGEN_DEVICE_FUNC inline const Scalar operator() (const Scalar& a) const { using std::log; return log(a); }
250  template <typename Packet>
251  inline Packet packetOp(const Packet& a) const { return internal::plog(a); }
252 };
253 template<typename Scalar>
254 struct functor_traits<scalar_log_op<Scalar> >
255 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = packet_traits<Scalar>::HasLog }; };
256 
263 template<typename Scalar> struct scalar_log10_op {
264  EIGEN_EMPTY_STRUCT_CTOR(scalar_log10_op)
265  EIGEN_DEVICE_FUNC inline const Scalar operator() (const Scalar& a) const { using std::log10; return log10(a); }
266  template <typename Packet>
267  inline Packet packetOp(const Packet& a) const { return internal::plog10(a); }
268 };
269 template<typename Scalar>
270 struct functor_traits<scalar_log10_op<Scalar> >
271 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = packet_traits<Scalar>::HasLog10 }; };
272 
277 template<typename Scalar> struct scalar_sqrt_op {
278  EIGEN_EMPTY_STRUCT_CTOR(scalar_sqrt_op)
279  EIGEN_DEVICE_FUNC inline const Scalar operator() (const Scalar& a) const { using std::sqrt; return sqrt(a); }
280  template <typename Packet>
281  inline Packet packetOp(const Packet& a) const { return internal::psqrt(a); }
282 };
283 template<typename Scalar>
284 struct functor_traits<scalar_sqrt_op<Scalar> >
285 { enum {
286  Cost = 5 * NumTraits<Scalar>::MulCost,
287  PacketAccess = packet_traits<Scalar>::HasSqrt
288  };
289 };
290 
295 template<typename Scalar> struct scalar_rsqrt_op {
296  EIGEN_EMPTY_STRUCT_CTOR(scalar_rsqrt_op)
297  EIGEN_DEVICE_FUNC inline const Scalar operator() (const Scalar& a) const { using std::sqrt; return Scalar(1)/sqrt(a); }
298  template <typename Packet>
299  inline Packet packetOp(const Packet& a) const { return internal::prsqrt(a); }
300 };
301 
302 template<typename Scalar>
303 struct functor_traits<scalar_rsqrt_op<Scalar> >
304 { enum {
305  Cost = 5 * NumTraits<Scalar>::MulCost,
306  PacketAccess = packet_traits<Scalar>::HasRsqrt
307  };
308 };
309 
314 template<typename Scalar> struct scalar_cos_op {
315  EIGEN_EMPTY_STRUCT_CTOR(scalar_cos_op)
316  EIGEN_DEVICE_FUNC inline Scalar operator() (const Scalar& a) const { using std::cos; return cos(a); }
317  template <typename Packet>
318  inline Packet packetOp(const Packet& a) const { return internal::pcos(a); }
319 };
320 template<typename Scalar>
321 struct functor_traits<scalar_cos_op<Scalar> >
322 {
323  enum {
324  Cost = 5 * NumTraits<Scalar>::MulCost,
325  PacketAccess = packet_traits<Scalar>::HasCos
326  };
327 };
328 
333 template<typename Scalar> struct scalar_sin_op {
334  EIGEN_EMPTY_STRUCT_CTOR(scalar_sin_op)
335  EIGEN_DEVICE_FUNC inline const Scalar operator() (const Scalar& a) const { using std::sin; return sin(a); }
336  template <typename Packet>
337  inline Packet packetOp(const Packet& a) const { return internal::psin(a); }
338 };
339 template<typename Scalar>
340 struct functor_traits<scalar_sin_op<Scalar> >
341 {
342  enum {
343  Cost = 5 * NumTraits<Scalar>::MulCost,
344  PacketAccess = packet_traits<Scalar>::HasSin
345  };
346 };
347 
348 
353 template<typename Scalar> struct scalar_tan_op {
354  EIGEN_EMPTY_STRUCT_CTOR(scalar_tan_op)
355  EIGEN_DEVICE_FUNC inline const Scalar operator() (const Scalar& a) const { using std::tan; return tan(a); }
356  template <typename Packet>
357  inline Packet packetOp(const Packet& a) const { return internal::ptan(a); }
358 };
359 template<typename Scalar>
360 struct functor_traits<scalar_tan_op<Scalar> >
361 {
362  enum {
363  Cost = 5 * NumTraits<Scalar>::MulCost,
364  PacketAccess = packet_traits<Scalar>::HasTan
365  };
366 };
367 
372 template<typename Scalar> struct scalar_acos_op {
373  EIGEN_EMPTY_STRUCT_CTOR(scalar_acos_op)
374  EIGEN_DEVICE_FUNC inline const Scalar operator() (const Scalar& a) const { using std::acos; return acos(a); }
375  template <typename Packet>
376  inline Packet packetOp(const Packet& a) const { return internal::pacos(a); }
377 };
378 template<typename Scalar>
379 struct functor_traits<scalar_acos_op<Scalar> >
380 {
381  enum {
382  Cost = 5 * NumTraits<Scalar>::MulCost,
383  PacketAccess = packet_traits<Scalar>::HasACos
384  };
385 };
386 
391 template<typename Scalar> struct scalar_asin_op {
392  EIGEN_EMPTY_STRUCT_CTOR(scalar_asin_op)
393  EIGEN_DEVICE_FUNC inline const Scalar operator() (const Scalar& a) const { using std::asin; return asin(a); }
394  template <typename Packet>
395  inline Packet packetOp(const Packet& a) const { return internal::pasin(a); }
396 };
397 template<typename Scalar>
398 struct functor_traits<scalar_asin_op<Scalar> >
399 {
400  enum {
401  Cost = 5 * NumTraits<Scalar>::MulCost,
402  PacketAccess = packet_traits<Scalar>::HasASin
403  };
404 };
405 
410 template<typename Scalar> struct scalar_atan_op {
411  EIGEN_EMPTY_STRUCT_CTOR(scalar_atan_op)
412  inline const Scalar operator() (const Scalar& a) const { using std::atan; return atan(a); }
413  template <typename Packet>
414  inline Packet packetOp(const Packet& a) const { return internal::patan(a); }
415 };
416 template<typename Scalar>
417 struct functor_traits<scalar_atan_op<Scalar> >
418 {
419  enum {
420  Cost = 5 * NumTraits<Scalar>::MulCost,
421  PacketAccess = packet_traits<Scalar>::HasATan
422  };
423 };
424 
429 template<typename Scalar> struct scalar_tanh_op {
430  EIGEN_EMPTY_STRUCT_CTOR(scalar_tanh_op)
431  inline const Scalar operator() (const Scalar& a) const { using std::tanh; return tanh(a); }
432  template <typename Packet>
433  inline Packet packetOp(const Packet& a) const { return internal::ptanh(a); }
434 };
435 template<typename Scalar>
436 struct functor_traits<scalar_tanh_op<Scalar> >
437 {
438  enum {
439  Cost = 5 * NumTraits<Scalar>::MulCost,
440  PacketAccess = packet_traits<Scalar>::HasTanh
441  };
442 };
443 
448 template<typename Scalar> struct scalar_sinh_op {
449  EIGEN_EMPTY_STRUCT_CTOR(scalar_sinh_op)
450  inline const Scalar operator() (const Scalar& a) const { using std::sinh; return sinh(a); }
451  template <typename Packet>
452  inline Packet packetOp(const Packet& a) const { return internal::psinh(a); }
453 };
454 template<typename Scalar>
455 struct functor_traits<scalar_sinh_op<Scalar> >
456 {
457  enum {
458  Cost = 5 * NumTraits<Scalar>::MulCost,
459  PacketAccess = packet_traits<Scalar>::HasSinh
460  };
461 };
462 
467 template<typename Scalar> struct scalar_cosh_op {
468  EIGEN_EMPTY_STRUCT_CTOR(scalar_cosh_op)
469  inline const Scalar operator() (const Scalar& a) const { using std::cosh; return cosh(a); }
470  template <typename Packet>
471  inline Packet packetOp(const Packet& a) const { return internal::pcosh(a); }
472 };
473 template<typename Scalar>
474 struct functor_traits<scalar_cosh_op<Scalar> >
475 {
476  enum {
477  Cost = 5 * NumTraits<Scalar>::MulCost,
478  PacketAccess = packet_traits<Scalar>::HasCosh
479  };
480 };
481 
486 template<typename Scalar>
487 struct scalar_inverse_op {
488  EIGEN_EMPTY_STRUCT_CTOR(scalar_inverse_op)
489  EIGEN_DEVICE_FUNC inline Scalar operator() (const Scalar& a) const { return Scalar(1)/a; }
490  template<typename Packet>
491  inline const Packet packetOp(const Packet& a) const
492  { return internal::pdiv(pset1<Packet>(Scalar(1)),a); }
493 };
494 template<typename Scalar>
495 struct functor_traits<scalar_inverse_op<Scalar> >
496 { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = packet_traits<Scalar>::HasDiv }; };
497 
502 template<typename Scalar>
503 struct scalar_square_op {
504  EIGEN_EMPTY_STRUCT_CTOR(scalar_square_op)
505  EIGEN_DEVICE_FUNC inline Scalar operator() (const Scalar& a) const { return a*a; }
506  template<typename Packet>
507  inline const Packet packetOp(const Packet& a) const
508  { return internal::pmul(a,a); }
509 };
510 template<typename Scalar>
511 struct functor_traits<scalar_square_op<Scalar> >
512 { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = packet_traits<Scalar>::HasMul }; };
513 
518 template<typename Scalar>
519 struct scalar_cube_op {
520  EIGEN_EMPTY_STRUCT_CTOR(scalar_cube_op)
521  EIGEN_DEVICE_FUNC inline Scalar operator() (const Scalar& a) const { return a*a*a; }
522  template<typename Packet>
523  inline const Packet packetOp(const Packet& a) const
524  { return internal::pmul(a,pmul(a,a)); }
525 };
526 template<typename Scalar>
527 struct functor_traits<scalar_cube_op<Scalar> >
528 { enum { Cost = 2*NumTraits<Scalar>::MulCost, PacketAccess = packet_traits<Scalar>::HasMul }; };
529 
534 template<typename Scalar> struct scalar_round_op {
535  EIGEN_EMPTY_STRUCT_CTOR(scalar_round_op)
536  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a) const { return numext::round(a); }
537  template <typename Packet>
538  inline Packet packetOp(const Packet& a) const { return internal::pround(a); }
539 };
540 template<typename Scalar>
541 struct functor_traits<scalar_round_op<Scalar> >
542 {
543  enum {
544  Cost = NumTraits<Scalar>::MulCost,
545  PacketAccess = packet_traits<Scalar>::HasRound
546  };
547 };
548 
553 template<typename Scalar> struct scalar_floor_op {
554  EIGEN_EMPTY_STRUCT_CTOR(scalar_floor_op)
555  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a) const { return numext::floor(a); }
556  template <typename Packet>
557  inline Packet packetOp(const Packet& a) const { return internal::pfloor(a); }
558 };
559 template<typename Scalar>
560 struct functor_traits<scalar_floor_op<Scalar> >
561 {
562  enum {
563  Cost = NumTraits<Scalar>::MulCost,
564  PacketAccess = packet_traits<Scalar>::HasFloor
565  };
566 };
567 
572 template<typename Scalar> struct scalar_ceil_op {
573  EIGEN_EMPTY_STRUCT_CTOR(scalar_ceil_op)
574  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar operator() (const Scalar& a) const { return numext::ceil(a); }
575  typedef typename packet_traits<Scalar>::type Packet;
576  inline Packet packetOp(const Packet& a) const { return internal::pceil(a); }
577 };
578 template<typename Scalar>
579 struct functor_traits<scalar_ceil_op<Scalar> >
580 {
581  enum {
582  Cost = NumTraits<Scalar>::MulCost,
583  PacketAccess = packet_traits<Scalar>::HasCeil
584  };
585 };
586 
591 template<typename Scalar> struct scalar_isnan_op {
592  EIGEN_EMPTY_STRUCT_CTOR(scalar_isnan_op)
593  typedef bool result_type;
594  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE result_type operator() (const Scalar& a) const { return (numext::isnan)(a); }
595 };
596 template<typename Scalar>
597 struct functor_traits<scalar_isnan_op<Scalar> >
598 {
599  enum {
600  Cost = NumTraits<Scalar>::MulCost,
601  PacketAccess = false
602  };
603 };
604 
609 template<typename Scalar> struct scalar_isinf_op {
610  EIGEN_EMPTY_STRUCT_CTOR(scalar_isinf_op)
611  typedef bool result_type;
612  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE result_type operator() (const Scalar& a) const { return (numext::isinf)(a); }
613 };
614 template<typename Scalar>
615 struct functor_traits<scalar_isinf_op<Scalar> >
616 {
617  enum {
618  Cost = NumTraits<Scalar>::MulCost,
619  PacketAccess = false
620  };
621 };
622 
627 template<typename Scalar> struct scalar_isfinite_op {
628  EIGEN_EMPTY_STRUCT_CTOR(scalar_isfinite_op)
629  typedef bool result_type;
630  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE result_type operator() (const Scalar& a) const { return (numext::isfinite)(a); }
631 };
632 template<typename Scalar>
633 struct functor_traits<scalar_isfinite_op<Scalar> >
634 {
635  enum {
636  Cost = NumTraits<Scalar>::MulCost,
637  PacketAccess = false
638  };
639 };
640 
646 template<typename Scalar> struct scalar_boolean_not_op {
647  EIGEN_EMPTY_STRUCT_CTOR(scalar_boolean_not_op)
648  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE bool operator() (const bool& a) const { return !a; }
649 };
650 template<typename Scalar>
651 struct functor_traits<scalar_boolean_not_op<Scalar> > {
652  enum {
653  Cost = NumTraits<bool>::AddCost,
654  PacketAccess = false
655  };
656 };
657 
658 
659 } // end namespace internal
660 
661 } // end namespace Eigen
662 
663 #endif // EIGEN_FUNCTORS_H
Definition: LDLT.h:16
Definition: Eigen_Colamd.h:54