Chris@16: /*-----------------------------------------------------------------------------+
Chris@16: Copyright (c) 2007-2009: Joachim Faulhaber
Chris@16: +------------------------------------------------------------------------------+
Chris@16:    Distributed under the Boost Software License, Version 1.0.
Chris@16:       (See accompanying file LICENCE.txt or copy at
Chris@16:            http://www.boost.org/LICENSE_1_0.txt)
Chris@16: +-----------------------------------------------------------------------------*/
Chris@16: #ifndef BOOST_ICL_FUNCTORS_HPP_JOFA_080315
Chris@16: #define BOOST_ICL_FUNCTORS_HPP_JOFA_080315
Chris@16: 
Chris@16: #include <functional>
Chris@16: #include <boost/type_traits.hpp>
Chris@16: #include <boost/mpl/if.hpp>
Chris@16: #include <boost/icl/type_traits/identity_element.hpp>
Chris@16: #include <boost/icl/type_traits/unit_element.hpp>
Chris@16: #include <boost/icl/type_traits/is_set.hpp>
Chris@16: #include <boost/icl/type_traits/has_set_semantics.hpp>
Chris@16: 
Chris@16: namespace boost{namespace icl
Chris@16: {
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct identity_based_inplace_combine 
Chris@16:         : public std::binary_function<Type&, const Type&, void>
Chris@16:     {
Chris@16:         inline static Type identity_element() { return boost::icl::identity_element<Type>::value(); }
Chris@16:     };
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct unit_element_based_inplace_combine 
Chris@16:         : public std::binary_function<Type&, const Type&, void>
Chris@16:     {
Chris@16:         inline static Type identity_element() { return boost::icl::unit_element<Type>::value(); }
Chris@16:     };
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_identity 
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_identity<Type> type;
Chris@16:         void operator()(Type&, const Type&)const{}
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_identity>::apply() 
Chris@16:     { return "i="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_erasure 
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_erasure<Type> type;
Chris@16:         typedef identity_based_inplace_combine<Type> base_type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { 
Chris@16:             if(object == operand)
Chris@16:                 //identity_element(); //JODO Old gcc-3.4.4 does not compile this
Chris@16:                 object = base_type::identity_element(); //<-- but this.
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_erasure>::apply() 
Chris@16:     { return "0="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_plus 
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_plus<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object += operand; }
Chris@16: 
Chris@16:         static void version(Type&){}
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_plus>::apply() { return "+="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_minus 
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_minus<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object -= operand; }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_minus>::apply() { return "-="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_bit_add
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_bit_add<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object |= operand; }
Chris@16: 
Chris@16:         static void version(Type&){}
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_bit_add>::apply() { return "b|="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_bit_subtract
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_bit_subtract<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object &= ~operand; }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_bit_subtract>::apply() { return "b-="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_bit_and
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_bit_and<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object &= operand; }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_bit_and>::apply() { return "b&="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_bit_xor
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_bit_xor<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object ^= operand; }
Chris@16:     };
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_et
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_et<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object &= operand; }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_et>::apply() { return "&="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_caret
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_caret<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object ^= operand; }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_caret>::apply() { return "^="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_insert
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_insert<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { insert(object,operand); }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_insert>::apply() { return "ins="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_erase
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_erase<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { erase(object,operand); }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_erase>::apply() { return "ers="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_star
Chris@16:         : public identity_based_inplace_combine<Type> //JODO unit_element_
Chris@16:     {
Chris@16:         typedef inplace_star<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object *= operand; }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_star>::apply() { return "*="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_slash
Chris@16:         : public identity_based_inplace_combine<Type> //JODO unit_element_
Chris@16:     {
Chris@16:         typedef inplace_slash<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { object /= operand; }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_slash>::apply() { return "/="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_max
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_max<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         {
Chris@16:             if(object < operand)
Chris@16:                 object = operand;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_max>::apply() { return "max="; }
Chris@16: 
Chris@16:     // ------------------------------------------------------------------------
Chris@16:     template <typename Type> struct inplace_min
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef inplace_min<Type> type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         {
Chris@16:             if(object > operand)
Chris@16:                 object = operand;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template<>
Chris@16:     inline std::string unary_template_to_string<inplace_min>::apply() { return "min="; }
Chris@16: 
Chris@16:     //--------------------------------------------------------------------------
Chris@16:     // Inter_section functor
Chris@16:     //--------------------------------------------------------------------------
Chris@16:     template<class Type> struct inter_section
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef typename boost::mpl::
Chris@16:             if_<has_set_semantics<Type>,
Chris@16:                 icl::inplace_et<Type>, 
Chris@16:                 icl::inplace_plus<Type> 
Chris@16:                >::type
Chris@16:             type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { 
Chris@16:             type()(object, operand);
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     //--------------------------------------------------------------------------
Chris@16:     // Inverse functor
Chris@16:     //--------------------------------------------------------------------------
Chris@16:     template<class Functor> struct inverse;
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_plus<Type> >
Chris@16:     { typedef icl::inplace_minus<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_minus<Type> >
Chris@16:     { typedef icl::inplace_plus<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_bit_add<Type> >
Chris@16:     { typedef icl::inplace_bit_subtract<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_bit_subtract<Type> >
Chris@16:     { typedef icl::inplace_bit_add<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_et<Type> >
Chris@16:     { typedef icl::inplace_caret<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_caret<Type> >
Chris@16:     { typedef icl::inplace_et<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_bit_and<Type> >
Chris@16:     { typedef icl::inplace_bit_xor<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_bit_xor<Type> >
Chris@16:     { typedef icl::inplace_bit_and<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_star<Type> >
Chris@16:     { typedef icl::inplace_slash<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_slash<Type> >
Chris@16:     { typedef icl::inplace_star<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_max<Type> >
Chris@16:     { typedef icl::inplace_min<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_min<Type> >
Chris@16:     { typedef icl::inplace_max<Type> type; };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inplace_identity<Type> >
Chris@16:     { typedef icl::inplace_erasure<Type> type; };
Chris@16: 
Chris@16:     // If a Functor 
Chris@16:     template<class Functor> 
Chris@16:     struct inverse
Chris@16:     {
Chris@16:         typedef typename 
Chris@16:             remove_reference<typename Functor::first_argument_type>::type argument_type;
Chris@16:         typedef icl::inplace_erasure<argument_type> type; 
Chris@16:     };
Chris@16: 
Chris@16: 
Chris@16:     //--------------------------------------------------------------------------
Chris@16:     // Inverse inter_section functor
Chris@16:     //--------------------------------------------------------------------------
Chris@16:     template<class Type> 
Chris@16:     struct inverse<icl::inter_section<Type> >
Chris@16:         : public identity_based_inplace_combine<Type>
Chris@16:     {
Chris@16:         typedef typename boost::mpl::
Chris@16:             if_<has_set_semantics<Type>,
Chris@16:                 icl::inplace_caret<Type>, 
Chris@16:                 icl::inplace_minus<Type> 
Chris@16:                >::type
Chris@16:             type;
Chris@16: 
Chris@16:         void operator()(Type& object, const Type& operand)const
Chris@16:         { 
Chris@16:             type()(object, operand);
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16: 
Chris@16:     //--------------------------------------------------------------------------
Chris@16:     // Positive or negative functor trait
Chris@16:     //--------------------------------------------------------------------------
Chris@16: 
Chris@16:     // A binary operation - is negative (or inverting) with respect to the
Chris@16:     // neutral element iff it yields the inverse element if it is applied to the 
Chris@16:     // identity element:
Chris@16:     // 0 - x = -x
Chris@16:     // For a functor that wraps the inplace of op-assign version this is 
Chris@16:     // equivalent to
Chris@16:     //
Chris@16:     // T x = ..., y;
Chris@16:     // y = Functor::identity_element();
Chris@16:     // Functor()(y, x); // y == inverse_of(x) 
Chris@16: 
Chris@16:     template<class Functor> struct is_negative;
Chris@16: 
Chris@16:     template<class Functor> 
Chris@16:     struct is_negative
Chris@16:     {
Chris@16:         typedef is_negative<Functor> type;
Chris@16:         BOOST_STATIC_CONSTANT(bool, value = false);
Chris@16:     };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct is_negative<icl::inplace_minus<Type> >
Chris@16:     {
Chris@16:         typedef is_negative type;
Chris@16:         BOOST_STATIC_CONSTANT(bool, value = true);
Chris@16:     };
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct is_negative<icl::inplace_bit_subtract<Type> >
Chris@16:     {
Chris@16:         typedef is_negative type;
Chris@16:         BOOST_STATIC_CONSTANT(bool, value = true);
Chris@16:     };
Chris@16: 
Chris@16:     //--------------------------------------------------------------------------
Chris@16:     // Pro- or in-version functor
Chris@16:     //--------------------------------------------------------------------------
Chris@16:     template<class Combiner> struct conversion;
Chris@16: 
Chris@16:     template<class Combiner> 
Chris@16:     struct conversion
Chris@16:     { 
Chris@16:         typedef conversion<Combiner> type;
Chris@16:         typedef typename
Chris@16:             remove_const<
Chris@16:                 typename remove_reference<typename Combiner::first_argument_type
Chris@16:                 >::type
Chris@16:             >::type
Chris@16:             argument_type;
Chris@16:         // The proversion of an op-assign functor o= lets the value unchanged
Chris@16:         // (0 o= x) == x;
Chris@16:         // Example += :  (0 += x) == x
Chris@16:         static argument_type proversion(const argument_type& value)
Chris@16:         { 
Chris@16:             return value; 
Chris@16:         } 
Chris@16: 
Chris@16:         // The inversion of an op-assign functor o= inverts the value x
Chris@16:         // to it's inverse element -x
Chris@16:         // (0 o= x) == -x;
Chris@16:         // Example -= :  (0 -= x) == -x
Chris@16:         static argument_type inversion(const argument_type& value)
Chris@16:         {
Chris@16:             argument_type inverse = Combiner::identity_element();
Chris@16:             Combiner()(inverse, value);
Chris@16:             return inverse;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template<class Combiner> struct version : public conversion<Combiner>
Chris@16:     {
Chris@16:         typedef    version<Combiner> type;
Chris@16:         typedef conversion<Combiner> base_type;
Chris@16:         typedef typename base_type::argument_type argument_type;
Chris@16: 
Chris@16:         argument_type operator()(const argument_type& value)
Chris@16:         { return base_type::proversion(value); } 
Chris@16:     };
Chris@16: 
Chris@16:     template<>struct version<icl::inplace_minus<short      > >{short       operator()(short       val){return -val;}};
Chris@16:     template<>struct version<icl::inplace_minus<int        > >{int         operator()(int         val){return -val;}};
Chris@16:     template<>struct version<icl::inplace_minus<long       > >{long        operator()(long        val){return -val;}};
Chris@16:     template<>struct version<icl::inplace_minus<long long  > >{long long   operator()(long long   val){return -val;}};
Chris@16:     template<>struct version<icl::inplace_minus<float      > >{float       operator()(float       val){return -val;}};
Chris@16:     template<>struct version<icl::inplace_minus<double     > >{double      operator()(double      val){return -val;}};
Chris@16:     template<>struct version<icl::inplace_minus<long double> >{long double operator()(long double val){return -val;}};
Chris@16: 
Chris@16:     template<class Type> 
Chris@16:     struct version<icl::inplace_minus<Type> > : public conversion<icl::inplace_minus<Type> >
Chris@16:     { 
Chris@16:         typedef    version<icl::inplace_minus<Type> > type;
Chris@16:         typedef conversion<icl::inplace_minus<Type> > base_type;
Chris@16:         typedef typename base_type::argument_type argument_type;
Chris@16: 
Chris@16:         Type operator()(const Type& value)
Chris@16:         {
Chris@16:             return base_type::inversion(value);
Chris@16:         } 
Chris@16:     };
Chris@16: 
Chris@16: }} // namespace icl boost
Chris@16: 
Chris@16: #endif
Chris@16: 
Chris@16: