Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Core / GenericPacketMath.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_GENERIC_PACKET_MATH_H
27 #define EIGEN_GENERIC_PACKET_MATH_H
28
29 /** \internal
30   * \file GenericPacketMath.h
31   *
32   * Default implementation for types not supported by the vectorization.
33   * In practice these functions are provided to make easier the writing
34   * of generic vectorized code.
35   */
36
37 /** \internal \returns a + b (coeff-wise) */
38 template<typename Packet> inline Packet
39 ei_padd(const Packet& a,
40         const Packet& b) { return a+b; }
41
42 /** \internal \returns a - b (coeff-wise) */
43 template<typename Packet> inline Packet
44 ei_psub(const Packet& a,
45         const Packet& b) { return a-b; }
46
47 /** \internal \returns a * b (coeff-wise) */
48 template<typename Packet> inline Packet
49 ei_pmul(const Packet& a,
50         const Packet& b) { return a*b; }
51
52 /** \internal \returns a / b (coeff-wise) */
53 template<typename Packet> inline Packet
54 ei_pdiv(const Packet& a,
55         const Packet& b) { return a/b; }
56
57 /** \internal \returns the min of \a a and \a b  (coeff-wise) */
58 template<typename Packet> inline Packet
59 ei_pmin(const Packet& a,
60         const Packet& b) { return std::min(a, b); }
61
62 /** \internal \returns the max of \a a and \a b  (coeff-wise) */
63 template<typename Packet> inline Packet
64 ei_pmax(const Packet& a,
65         const Packet& b) { return std::max(a, b); }
66
67 /** \internal \returns a packet version of \a *from, from must be 16 bytes aligned */
68 template<typename Scalar> inline typename ei_packet_traits<Scalar>::type
69 ei_pload(const Scalar* from) { return *from; }
70
71 /** \internal \returns a packet version of \a *from, (un-aligned load) */
72 template<typename Scalar> inline typename ei_packet_traits<Scalar>::type
73 ei_ploadu(const Scalar* from) { return *from; }
74
75 /** \internal \returns a packet with constant coefficients \a a, e.g.: (a,a,a,a) */
76 template<typename Scalar> inline typename ei_packet_traits<Scalar>::type
77 ei_pset1(const Scalar& a) { return a; }
78
79 /** \internal copy the packet \a from to \a *to, \a to must be 16 bytes aligned */
80 template<typename Scalar, typename Packet> inline void ei_pstore(Scalar* to, const Packet& from)
81 { (*to) = from; }
82
83 /** \internal copy the packet \a from to \a *to, (un-aligned store) */
84 template<typename Scalar, typename Packet> inline void ei_pstoreu(Scalar* to, const Packet& from)
85 { (*to) = from; }
86
87 /** \internal \returns the first element of a packet */
88 template<typename Packet> inline typename ei_unpacket_traits<Packet>::type ei_pfirst(const Packet& a)
89 { return a; }
90
91 /** \internal \returns a packet where the element i contains the sum of the packet of \a vec[i] */
92 template<typename Packet> inline Packet
93 ei_preduxp(const Packet* vecs) { return vecs[0]; }
94
95 /** \internal \returns the sum of the elements of \a a*/
96 template<typename Packet> inline typename ei_unpacket_traits<Packet>::type ei_predux(const Packet& a)
97 { return a; }
98
99
100 /***************************************************************************
101 * The following functions might not have to be overwritten for vectorized types
102 ***************************************************************************/
103
104 /** \internal \returns a * b + c (coeff-wise) */
105 template<typename Packet> inline Packet
106 ei_pmadd(const Packet&  a,
107          const Packet&  b,
108          const Packet&  c)
109 { return ei_padd(ei_pmul(a, b),c); }
110
111 /** \internal \returns a packet version of \a *from.
112   * \If LoadMode equals Aligned, \a from must be 16 bytes aligned */
113 template<typename Scalar, int LoadMode>
114 inline typename ei_packet_traits<Scalar>::type ei_ploadt(const Scalar* from)
115 {
116   if(LoadMode == Aligned)
117     return ei_pload(from);
118   else
119     return ei_ploadu(from);
120 }
121
122 /** \internal copy the packet \a from to \a *to.
123   * If StoreMode equals Aligned, \a to must be 16 bytes aligned */
124 template<typename Scalar, typename Packet, int LoadMode>
125 inline void ei_pstoret(Scalar* to, const Packet& from)
126 {
127   if(LoadMode == Aligned)
128     ei_pstore(to, from);
129   else
130     ei_pstoreu(to, from);
131 }
132
133 /** \internal default implementation of ei_palign() allowing partial specialization */
134 template<int Offset,typename PacketType>
135 struct ei_palign_impl
136 {
137   // by default data are aligned, so there is nothing to be done :)
138   inline static void run(PacketType&, const PacketType&) {}
139 };
140
141 /** \internal update \a first using the concatenation of the \a Offset last elements
142   * of \a first and packet_size minus \a Offset first elements of \a second */
143 template<int Offset,typename PacketType>
144 inline void ei_palign(PacketType& first, const PacketType& second)
145 {
146   ei_palign_impl<Offset,PacketType>::run(first,second);
147 }
148
149 #endif // EIGEN_GENERIC_PACKET_MATH_H
150