// This file is part of Eigen, a lightweight C++ template library // for linear algebra. Eigen itself is part of the KDE project. // // Copyright (C) 2008 Gael Guennebaud // Copyright (C) 2006-2008 Benoit Jacob // // Eigen is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public // License as published by the Free Software Foundation; either // version 3 of the License, or (at your option) any later version. // // Alternatively, you can redistribute it and/or // modify it under the terms of the GNU General Public License as // published by the Free Software Foundation; either version 2 of // the License, or (at your option) any later version. // // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the // GNU General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License and a copy of the GNU General Public License along with // Eigen. If not, see . #ifndef EIGEN_GENERIC_PACKET_MATH_H #define EIGEN_GENERIC_PACKET_MATH_H /** \internal * \file GenericPacketMath.h * * Default implementation for types not supported by the vectorization. * In practice these functions are provided to make easier the writing * of generic vectorized code. */ struct ei_default_packet_traits { enum { HasAdd = 1, HasSub = 1, HasMul = 1, HasNegate = 1, HasAbs = 1, HasMin = 1, HasMax = 1, HasDiv = 0, HasSqrt = 0, HasExp = 0, HasLog = 0, HasPow = 0, HasSin = 0, HasCos = 0, HasTan = 0, HasASin = 0, HasACos = 0, HasATan = 0 }; }; template struct ei_packet_traits : ei_default_packet_traits { typedef T type; enum {size=1}; enum { HasAdd = 0, HasSub = 0, HasMul = 0, HasNegate = 0, HasAbs = 0, HasMin = 0, HasMax = 0 }; }; /** \internal \returns a + b (coeff-wise) */ template inline Packet ei_padd(const Packet& a, const Packet& b) { return a+b; } /** \internal \returns a - b (coeff-wise) */ template inline Packet ei_psub(const Packet& a, const Packet& b) { return a-b; } /** \internal \returns -a (coeff-wise) */ template inline Packet ei_pnegate(const Packet& a) { return -a; } /** \internal \returns a * b (coeff-wise) */ template inline Packet ei_pmul(const Packet& a, const Packet& b) { return a*b; } /** \internal \returns a / b (coeff-wise) */ template inline Packet ei_pdiv(const Packet& a, const Packet& b) { return a/b; } /** \internal \returns the min of \a a and \a b (coeff-wise) */ template inline Packet ei_pmin(const Packet& a, const Packet& b) { return std::min(a, b); } /** \internal \returns the max of \a a and \a b (coeff-wise) */ template inline Packet ei_pmax(const Packet& a, const Packet& b) { return std::max(a, b); } /** \internal \returns the absolute value of \a a */ template inline Packet ei_pabs(const Packet& a) { return ei_abs(a); } /** \internal \returns the bitwise and of \a a and \a b */ template inline Packet ei_pand(const Packet& a, const Packet& b) { return a & b; } /** \internal \returns the bitwise or of \a a and \a b */ template inline Packet ei_por(const Packet& a, const Packet& b) { return a | b; } /** \internal \returns the bitwise xor of \a a and \a b */ template inline Packet ei_pxor(const Packet& a, const Packet& b) { return a ^ b; } /** \internal \returns the bitwise andnot of \a a and \a b */ template inline Packet ei_pandnot(const Packet& a, const Packet& b) { return a & (!b); } /** \internal \returns a packet version of \a *from, from must be 16 bytes aligned */ template inline typename ei_packet_traits::type ei_pload(const Scalar* from) { return *from; } /** \internal \returns a packet version of \a *from, (un-aligned load) */ template inline typename ei_packet_traits::type ei_ploadu(const Scalar* from) { return *from; } /** \internal \returns a packet with constant coefficients \a a, e.g.: (a,a,a,a) */ template inline typename ei_packet_traits::type ei_pset1(const Scalar& a) { return a; } /** \internal copy the packet \a from to \a *to, \a to must be 16 bytes aligned */ template inline void ei_pstore(Scalar* to, const Packet& from) { (*to) = from; } /** \internal copy the packet \a from to \a *to, (un-aligned store) */ template inline void ei_pstoreu(Scalar* to, const Packet& from) { (*to) = from; } /** \internal \returns the first element of a packet */ template inline typename ei_unpacket_traits::type ei_pfirst(const Packet& a) { return a; } /** \internal \returns a packet where the element i contains the sum of the packet of \a vec[i] */ template inline Packet ei_preduxp(const Packet* vecs) { return vecs[0]; } /** \internal \returns the sum of the elements of \a a*/ template inline typename ei_unpacket_traits::type ei_predux(const Packet& a) { return a; } /** \internal \returns the product of the elements of \a a*/ template inline typename ei_unpacket_traits::type ei_predux_mul(const Packet& a) { return a; } /** \internal \returns the min of the elements of \a a*/ template inline typename ei_unpacket_traits::type ei_predux_min(const Packet& a) { return a; } /** \internal \returns the max of the elements of \a a*/ template inline typename ei_unpacket_traits::type ei_predux_max(const Packet& a) { return a; } /** \internal \returns the reversed elements of \a a*/ template inline Packet ei_preverse(const Packet& a) { return a; } /************************** * Special math functions ***************************/ /** \internal \returns the sin of \a a (coeff-wise) */ template inline static Packet ei_psin(Packet a) { return ei_sin(a); } /** \internal \returns the cos of \a a (coeff-wise) */ template inline static Packet ei_pcos(Packet a) { return ei_cos(a); } /** \internal \returns the exp of \a a (coeff-wise) */ template inline static Packet ei_pexp(Packet a) { return ei_exp(a); } /** \internal \returns the log of \a a (coeff-wise) */ template inline static Packet ei_plog(Packet a) { return ei_log(a); } /** \internal \returns the square-root of \a a (coeff-wise) */ template inline static Packet ei_psqrt(Packet a) { return ei_sqrt(a); } /*************************************************************************** * The following functions might not have to be overwritten for vectorized types ***************************************************************************/ /** \internal \returns a * b + c (coeff-wise) */ template inline Packet ei_pmadd(const Packet& a, const Packet& b, const Packet& c) { return ei_padd(ei_pmul(a, b),c); } /** \internal \returns a packet version of \a *from. * \If LoadMode equals Aligned, \a from must be 16 bytes aligned */ template inline typename ei_packet_traits::type ei_ploadt(const Scalar* from) { if(LoadMode == Aligned) return ei_pload(from); else return ei_ploadu(from); } /** \internal copy the packet \a from to \a *to. * If StoreMode equals Aligned, \a to must be 16 bytes aligned */ template inline void ei_pstoret(Scalar* to, const Packet& from) { if(LoadMode == Aligned) ei_pstore(to, from); else ei_pstoreu(to, from); } /** \internal default implementation of ei_palign() allowing partial specialization */ template struct ei_palign_impl { // by default data are aligned, so there is nothing to be done :) inline static void run(PacketType&, const PacketType&) {} }; /** \internal update \a first using the concatenation of the \a Offset last elements * of \a first and packet_size minus \a Offset first elements of \a second */ template inline void ei_palign(PacketType& first, const PacketType& second) { ei_palign_impl::run(first,second); } #endif // EIGEN_GENERIC_PACKET_MATH_H