sl@0: // ------------------------------------------------------------------------------
sl@0: // Copyright (c) 2000 Cadenza New Zealand Ltd
sl@0: // Distributed under the Boost Software License, Version 1.0. (See accompany-
sl@0: // ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
sl@0: // ------------------------------------------------------------------------------
sl@0: // Boost functional.hpp header file
sl@0: // See http://www.boost.org/libs/functional for documentation.
sl@0: // ------------------------------------------------------------------------------
sl@0: // $Id: functional.hpp,v 1.4.20.1 2006/12/02 14:17:26 andreas_huber69 Exp $
sl@0: // ------------------------------------------------------------------------------
sl@0: 
sl@0: #ifndef BOOST_FUNCTIONAL_HPP
sl@0: #define BOOST_FUNCTIONAL_HPP
sl@0: 
sl@0: #include <boost/config.hpp>
sl@0: #include <boost/call_traits.hpp>
sl@0: #include <functional>
sl@0: 
sl@0: namespace boost
sl@0: {
sl@0: #ifndef BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
sl@0:     // --------------------------------------------------------------------------
sl@0:     // The following traits classes allow us to avoid the need for ptr_fun
sl@0:     // because the types of arguments and the result of a function can be 
sl@0:     // deduced.
sl@0:     //
sl@0:     // In addition to the standard types defined in unary_function and 
sl@0:     // binary_function, we add
sl@0:     //
sl@0:     // - function_type, the type of the function or function object itself.
sl@0:     //
sl@0:     // - param_type, the type that should be used for passing the function or
sl@0:     //   function object as an argument.
sl@0:     // --------------------------------------------------------------------------
sl@0:     namespace detail
sl@0:     {
sl@0:         template <class Operation>
sl@0:         struct unary_traits_imp;
sl@0:         
sl@0:         template <class Operation>
sl@0:         struct unary_traits_imp<Operation*>
sl@0:         {
sl@0:             typedef Operation                         function_type;
sl@0:             typedef const function_type &             param_type;
sl@0:             typedef typename Operation::result_type   result_type;
sl@0:             typedef typename Operation::argument_type argument_type;
sl@0:         };
sl@0: 
sl@0:         template <class R, class A>
sl@0:         struct unary_traits_imp<R(*)(A)>
sl@0:         {
sl@0:             typedef R (*function_type)(A);
sl@0:             typedef R (*param_type)(A);
sl@0:             typedef R result_type;
sl@0:             typedef A argument_type;
sl@0:         };
sl@0: 
sl@0:         template <class Operation>
sl@0:         struct binary_traits_imp;
sl@0: 
sl@0:         template <class Operation>
sl@0:         struct binary_traits_imp<Operation*>
sl@0:         {
sl@0:             typedef Operation                                function_type;
sl@0:             typedef const function_type &                    param_type;
sl@0:             typedef typename Operation::result_type          result_type;
sl@0:             typedef typename Operation::first_argument_type  first_argument_type;
sl@0:             typedef typename Operation::second_argument_type second_argument_type;
sl@0:         };
sl@0:         
sl@0:         template <class R, class A1, class A2>
sl@0:         struct binary_traits_imp<R(*)(A1,A2)>
sl@0:         {
sl@0:             typedef R (*function_type)(A1,A2);
sl@0:             typedef R (*param_type)(A1,A2);
sl@0:             typedef R result_type;
sl@0:             typedef A1 first_argument_type;
sl@0:             typedef A2 second_argument_type;
sl@0:         };
sl@0:     } // namespace detail
sl@0:     
sl@0:     template <class Operation>
sl@0:     struct unary_traits
sl@0:     {
sl@0:         typedef typename detail::unary_traits_imp<Operation*>::function_type function_type;
sl@0:         typedef typename detail::unary_traits_imp<Operation*>::param_type    param_type;
sl@0:         typedef typename detail::unary_traits_imp<Operation*>::result_type   result_type;
sl@0:         typedef typename detail::unary_traits_imp<Operation*>::argument_type argument_type;
sl@0:     }; 
sl@0: 
sl@0:     template <class R, class A>
sl@0:     struct unary_traits<R(*)(A)>
sl@0:     {
sl@0:         typedef R (*function_type)(A);
sl@0:         typedef R (*param_type)(A);
sl@0:         typedef R result_type;
sl@0:         typedef A argument_type;
sl@0:     };
sl@0: 
sl@0:     template <class Operation>
sl@0:     struct binary_traits
sl@0:     {
sl@0:         typedef typename detail::binary_traits_imp<Operation*>::function_type        function_type;
sl@0:         typedef typename detail::binary_traits_imp<Operation*>::param_type           param_type;
sl@0:         typedef typename detail::binary_traits_imp<Operation*>::result_type          result_type;
sl@0:         typedef typename detail::binary_traits_imp<Operation*>::first_argument_type  first_argument_type;
sl@0:         typedef typename detail::binary_traits_imp<Operation*>::second_argument_type second_argument_type;
sl@0:     };
sl@0:     
sl@0:     template <class R, class A1, class A2>
sl@0:     struct binary_traits<R(*)(A1,A2)>
sl@0:     {
sl@0:         typedef R (*function_type)(A1,A2);
sl@0:         typedef R (*param_type)(A1,A2);
sl@0:         typedef R result_type;
sl@0:         typedef A1 first_argument_type;
sl@0:         typedef A2 second_argument_type;
sl@0:     };
sl@0: #else // BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
sl@0:     // --------------------------------------------------------------------------
sl@0:     // If we have no partial specialisation available, decay to a situation
sl@0:     // that is no worse than in the Standard, i.e., ptr_fun will be required.
sl@0:     // --------------------------------------------------------------------------
sl@0: 
sl@0:     template <class Operation>
sl@0:     struct unary_traits
sl@0:     {
sl@0:         typedef Operation                         function_type;
sl@0:         typedef const Operation&                  param_type;
sl@0:         typedef typename Operation::result_type   result_type;
sl@0:         typedef typename Operation::argument_type argument_type;
sl@0:     }; 
sl@0:     
sl@0:     template <class Operation>
sl@0:     struct binary_traits
sl@0:     {
sl@0:         typedef Operation                                function_type;
sl@0:         typedef const Operation &                        param_type;
sl@0:         typedef typename Operation::result_type          result_type;
sl@0:         typedef typename Operation::first_argument_type  first_argument_type;
sl@0:         typedef typename Operation::second_argument_type second_argument_type;
sl@0:     };    
sl@0: #endif // BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
sl@0:     
sl@0:     // --------------------------------------------------------------------------
sl@0:     // unary_negate, not1
sl@0:     // --------------------------------------------------------------------------
sl@0:     template <class Predicate>
sl@0:     class unary_negate
sl@0:         : public std::unary_function<typename unary_traits<Predicate>::argument_type,bool>
sl@0:     {
sl@0:       public:
sl@0:         explicit unary_negate(typename unary_traits<Predicate>::param_type x)
sl@0:             :
sl@0:             pred(x)
sl@0:         {}
sl@0:         bool operator()(typename call_traits<typename unary_traits<Predicate>::argument_type>::param_type x) const
sl@0:         {
sl@0:             return !pred(x);
sl@0:         }
sl@0:       private:
sl@0:         typename unary_traits<Predicate>::function_type pred;
sl@0:     };
sl@0: 
sl@0:     template <class Predicate>
sl@0:     unary_negate<Predicate> not1(const Predicate &pred)
sl@0:     {
sl@0:         // The cast is to placate Borland C++Builder in certain circumstances.
sl@0:         // I don't think it should be necessary.
sl@0:         return unary_negate<Predicate>((typename unary_traits<Predicate>::param_type)pred);
sl@0:     }
sl@0: 
sl@0:     template <class Predicate>
sl@0:     unary_negate<Predicate> not1(Predicate &pred)
sl@0:     {
sl@0:         return unary_negate<Predicate>(pred);
sl@0:     }
sl@0: 
sl@0:     // --------------------------------------------------------------------------
sl@0:     // binary_negate, not2
sl@0:     // --------------------------------------------------------------------------
sl@0:     template <class Predicate>
sl@0:     class binary_negate
sl@0:         : public std::binary_function<typename binary_traits<Predicate>::first_argument_type,
sl@0:                                       typename binary_traits<Predicate>::second_argument_type,
sl@0:                                       bool>
sl@0:     {
sl@0:       public:
sl@0:         explicit binary_negate(typename binary_traits<Predicate>::param_type x)
sl@0:             :
sl@0:             pred(x)
sl@0:         {}
sl@0:         bool operator()(typename call_traits<typename binary_traits<Predicate>::first_argument_type>::param_type x,
sl@0:                         typename call_traits<typename binary_traits<Predicate>::second_argument_type>::param_type y) const
sl@0:         {
sl@0:             return !pred(x,y);
sl@0:         }
sl@0:       private:
sl@0:         typename binary_traits<Predicate>::function_type pred;
sl@0:     };
sl@0: 
sl@0:     template <class Predicate>
sl@0:     binary_negate<Predicate> not2(const Predicate &pred)
sl@0:     {
sl@0:         // The cast is to placate Borland C++Builder in certain circumstances.
sl@0:         // I don't think it should be necessary.
sl@0:         return binary_negate<Predicate>((typename binary_traits<Predicate>::param_type)pred);
sl@0:     }
sl@0: 
sl@0:     template <class Predicate>
sl@0:     binary_negate<Predicate> not2(Predicate &pred)
sl@0:     {
sl@0:         return binary_negate<Predicate>(pred);
sl@0:     }
sl@0:         
sl@0:     // --------------------------------------------------------------------------
sl@0:     // binder1st, bind1st
sl@0:     // --------------------------------------------------------------------------
sl@0:     template <class Operation>
sl@0:     class binder1st
sl@0:         : public std::unary_function<typename binary_traits<Operation>::second_argument_type,
sl@0:                                      typename binary_traits<Operation>::result_type>
sl@0:     {       
sl@0:       public:
sl@0:         binder1st(typename binary_traits<Operation>::param_type x,
sl@0:                   typename call_traits<typename binary_traits<Operation>::first_argument_type>::param_type y)
sl@0:             :
sl@0:             op(x), value(y)
sl@0:         {}
sl@0:         
sl@0:         typename binary_traits<Operation>::result_type
sl@0:         operator()(typename call_traits<typename binary_traits<Operation>::second_argument_type>::param_type x) const
sl@0:         {
sl@0:             return op(value, x);
sl@0:         }
sl@0:         
sl@0:       protected:
sl@0:         typename binary_traits<Operation>::function_type op;
sl@0:         typename binary_traits<Operation>::first_argument_type value;
sl@0:     };
sl@0: 
sl@0:     template <class Operation>
sl@0:     inline binder1st<Operation> bind1st(const Operation &op,
sl@0:                                         typename call_traits<
sl@0:                                                     typename binary_traits<Operation>::first_argument_type
sl@0:                                         >::param_type x)
sl@0:     {
sl@0:         // The cast is to placate Borland C++Builder in certain circumstances.
sl@0:         // I don't think it should be necessary.
sl@0:         return binder1st<Operation>((typename binary_traits<Operation>::param_type)op, x);
sl@0:     }
sl@0: 
sl@0:     template <class Operation>
sl@0:     inline binder1st<Operation> bind1st(Operation &op,
sl@0:                                         typename call_traits<
sl@0:                                                     typename binary_traits<Operation>::first_argument_type
sl@0:                                         >::param_type x)
sl@0:     {
sl@0:         return binder1st<Operation>(op, x);
sl@0:     }
sl@0: 
sl@0:     // --------------------------------------------------------------------------
sl@0:     // binder2nd, bind2nd
sl@0:     // --------------------------------------------------------------------------
sl@0:     template <class Operation>
sl@0:     class binder2nd
sl@0:         : public std::unary_function<typename binary_traits<Operation>::first_argument_type,
sl@0:                                      typename binary_traits<Operation>::result_type>
sl@0:     {
sl@0:       public:
sl@0:         binder2nd(typename binary_traits<Operation>::param_type x,
sl@0:                   typename call_traits<typename binary_traits<Operation>::second_argument_type>::param_type y)
sl@0:             :
sl@0:             op(x), value(y)
sl@0:         {}
sl@0:         
sl@0:         typename binary_traits<Operation>::result_type
sl@0:         operator()(typename call_traits<typename binary_traits<Operation>::first_argument_type>::param_type x) const
sl@0:         {
sl@0:             return op(x, value);
sl@0:         }               
sl@0:         
sl@0:       protected:
sl@0:         typename binary_traits<Operation>::function_type op;
sl@0:         typename binary_traits<Operation>::second_argument_type value;
sl@0:     };
sl@0: 
sl@0:     template <class Operation>
sl@0:     inline binder2nd<Operation> bind2nd(const Operation &op,
sl@0:                                         typename call_traits<
sl@0:                                                     typename binary_traits<Operation>::second_argument_type
sl@0:                                         >::param_type x)
sl@0:     {
sl@0:         // The cast is to placate Borland C++Builder in certain circumstances.
sl@0:         // I don't think it should be necessary.
sl@0:         return binder2nd<Operation>((typename binary_traits<Operation>::param_type)op, x);
sl@0:     }
sl@0: 
sl@0:     template <class Operation>
sl@0:     inline binder2nd<Operation> bind2nd(Operation &op,
sl@0:                                         typename call_traits<
sl@0:                                                     typename binary_traits<Operation>::second_argument_type
sl@0:                                         >::param_type x)
sl@0:     {
sl@0:         return binder2nd<Operation>(op, x);
sl@0:     }
sl@0: 
sl@0:     // --------------------------------------------------------------------------
sl@0:     // mem_fun, etc
sl@0:     // --------------------------------------------------------------------------
sl@0:     template <class S, class T>
sl@0:     class mem_fun_t : public std::unary_function<T*, S>
sl@0:     {
sl@0:       public:
sl@0:         explicit mem_fun_t(S (T::*p)())
sl@0:             :
sl@0:             ptr(p)
sl@0:         {}
sl@0:         S operator()(T* p) const
sl@0:         {
sl@0:             return (p->*ptr)();
sl@0:         }
sl@0:       private:
sl@0:         S (T::*ptr)();
sl@0:     };
sl@0: 
sl@0:     template <class S, class T, class A>
sl@0:     class mem_fun1_t : public std::binary_function<T*, A, S>
sl@0:     {
sl@0:       public:   
sl@0:         explicit mem_fun1_t(S (T::*p)(A))
sl@0:             :
sl@0:             ptr(p)
sl@0:         {}
sl@0:         S operator()(T* p, typename call_traits<A>::param_type x) const
sl@0:         {
sl@0:             return (p->*ptr)(x);
sl@0:         }
sl@0:       private:
sl@0:         S (T::*ptr)(A);
sl@0:     };
sl@0: 
sl@0:     template <class S, class T>
sl@0:     class const_mem_fun_t : public std::unary_function<const T*, S>
sl@0:     {
sl@0:       public:
sl@0:         explicit const_mem_fun_t(S (T::*p)() const)
sl@0:             :
sl@0:             ptr(p)
sl@0:         {}
sl@0:         S operator()(const T* p) const
sl@0:         {
sl@0:             return (p->*ptr)();
sl@0:         }
sl@0:       private:
sl@0:         S (T::*ptr)() const;        
sl@0:     };
sl@0: 
sl@0:     template <class S, class T, class A>
sl@0:     class const_mem_fun1_t : public std::binary_function<const T*, A, S>
sl@0:     {
sl@0:       public:
sl@0:         explicit const_mem_fun1_t(S (T::*p)(A) const)
sl@0:             :
sl@0:             ptr(p)
sl@0:         {}
sl@0:         S operator()(const T* p, typename call_traits<A>::param_type x) const
sl@0:         {
sl@0:             return (p->*ptr)(x);
sl@0:         }
sl@0:       private:
sl@0:         S (T::*ptr)(A) const;
sl@0:     };
sl@0:     
sl@0:     template<class S, class T>
sl@0:     inline mem_fun_t<S,T> mem_fun(S (T::*f)())
sl@0:     {
sl@0:         return mem_fun_t<S,T>(f);
sl@0:     }
sl@0:     
sl@0:     template<class S, class T, class A>
sl@0:     inline mem_fun1_t<S,T,A> mem_fun(S (T::*f)(A))
sl@0:     {
sl@0:         return mem_fun1_t<S,T,A>(f);
sl@0:     }
sl@0: 
sl@0: #ifndef BOOST_NO_POINTER_TO_MEMBER_CONST
sl@0:     template<class S, class T>
sl@0:     inline const_mem_fun_t<S,T> mem_fun(S (T::*f)() const)
sl@0:     {
sl@0:         return const_mem_fun_t<S,T>(f);
sl@0:     }
sl@0:     
sl@0:     template<class S, class T, class A>
sl@0:     inline const_mem_fun1_t<S,T,A> mem_fun(S (T::*f)(A) const)
sl@0:     {
sl@0:         return const_mem_fun1_t<S,T,A>(f);
sl@0:     }
sl@0: #endif // BOOST_NO_POINTER_TO_MEMBER_CONST
sl@0: 
sl@0:     // --------------------------------------------------------------------------
sl@0:     // mem_fun_ref, etc
sl@0:     // --------------------------------------------------------------------------
sl@0:     template <class S, class T>
sl@0:     class mem_fun_ref_t : public std::unary_function<T&, S>
sl@0:     {
sl@0:       public:
sl@0:         explicit mem_fun_ref_t(S (T::*p)())
sl@0:             :
sl@0:             ptr(p)
sl@0:         {}
sl@0:         S operator()(T& p) const
sl@0:         {
sl@0:             return (p.*ptr)();
sl@0:         }
sl@0:       private:
sl@0:         S (T::*ptr)();
sl@0:     };
sl@0: 
sl@0:     template <class S, class T, class A>
sl@0:     class mem_fun1_ref_t : public std::binary_function<T&, A, S>
sl@0:     {
sl@0:       public:
sl@0:         explicit mem_fun1_ref_t(S (T::*p)(A))
sl@0:             :
sl@0:             ptr(p)
sl@0:         {}
sl@0:         S operator()(T& p, typename call_traits<A>::param_type x) const
sl@0:         {
sl@0:             return (p.*ptr)(x);
sl@0:         }
sl@0:       private:
sl@0:         S (T::*ptr)(A);
sl@0:     };
sl@0:     
sl@0:     template <class S, class T>
sl@0:     class const_mem_fun_ref_t : public std::unary_function<const T&, S>
sl@0:     {
sl@0:       public:
sl@0:         explicit const_mem_fun_ref_t(S (T::*p)() const)
sl@0:             :
sl@0:             ptr(p)
sl@0:         {}
sl@0:         
sl@0:         S operator()(const T &p) const
sl@0:         {
sl@0:             return (p.*ptr)();
sl@0:         }
sl@0:       private:
sl@0:         S (T::*ptr)() const;
sl@0:     };
sl@0: 
sl@0:     template <class S, class T, class A>
sl@0:     class const_mem_fun1_ref_t : public std::binary_function<const T&, A, S>
sl@0:     {
sl@0:       public:
sl@0:         explicit const_mem_fun1_ref_t(S (T::*p)(A) const)
sl@0:             :
sl@0:             ptr(p)
sl@0:         {}
sl@0: 
sl@0:         S operator()(const T& p, typename call_traits<A>::param_type x) const
sl@0:         {
sl@0:             return (p.*ptr)(x);
sl@0:         }
sl@0:       private:
sl@0:         S (T::*ptr)(A) const;
sl@0:     };
sl@0:     
sl@0:     template<class S, class T>
sl@0:     inline mem_fun_ref_t<S,T> mem_fun_ref(S (T::*f)())
sl@0:     {
sl@0:         return mem_fun_ref_t<S,T>(f);
sl@0:     }
sl@0: 
sl@0:     template<class S, class T, class A>
sl@0:     inline mem_fun1_ref_t<S,T,A> mem_fun_ref(S (T::*f)(A))
sl@0:     {
sl@0:         return mem_fun1_ref_t<S,T,A>(f);
sl@0:     }
sl@0: 
sl@0: #ifndef BOOST_NO_POINTER_TO_MEMBER_CONST
sl@0:     template<class S, class T>
sl@0:     inline const_mem_fun_ref_t<S,T> mem_fun_ref(S (T::*f)() const)
sl@0:     {
sl@0:         return const_mem_fun_ref_t<S,T>(f);
sl@0:     }
sl@0: 
sl@0:     template<class S, class T, class A>
sl@0:     inline const_mem_fun1_ref_t<S,T,A> mem_fun_ref(S (T::*f)(A) const)
sl@0:     {
sl@0:         return const_mem_fun1_ref_t<S,T,A>(f);
sl@0:     }   
sl@0: #endif // BOOST_NO_POINTER_TO_MEMBER_CONST
sl@0: 
sl@0:     // --------------------------------------------------------------------------
sl@0:     // ptr_fun
sl@0:     // --------------------------------------------------------------------------
sl@0:     template <class Arg, class Result>
sl@0:     class pointer_to_unary_function : public std::unary_function<Arg,Result>
sl@0:     {
sl@0:       public:
sl@0:         explicit pointer_to_unary_function(Result (*f)(Arg))
sl@0:             :
sl@0:             func(f)
sl@0:         {}
sl@0: 
sl@0:         Result operator()(typename call_traits<Arg>::param_type x) const
sl@0:         {
sl@0:             return func(x);
sl@0:         }
sl@0:         
sl@0:       private:
sl@0:         Result (*func)(Arg);
sl@0:     };
sl@0: 
sl@0:     template <class Arg, class Result>
sl@0:     inline pointer_to_unary_function<Arg,Result> ptr_fun(Result (*f)(Arg))
sl@0:     {
sl@0:         return pointer_to_unary_function<Arg,Result>(f);
sl@0:     }
sl@0: 
sl@0:     template <class Arg1, class Arg2, class Result>
sl@0:     class pointer_to_binary_function : public std::binary_function<Arg1,Arg2,Result>
sl@0:     {
sl@0:       public:
sl@0:         explicit pointer_to_binary_function(Result (*f)(Arg1, Arg2))
sl@0:             :
sl@0:             func(f)
sl@0:         {}
sl@0:         
sl@0:         Result operator()(typename call_traits<Arg1>::param_type x, typename call_traits<Arg2>::param_type y) const
sl@0:         {
sl@0:             return func(x,y);
sl@0:         }
sl@0:         
sl@0:       private:
sl@0:         Result (*func)(Arg1, Arg2);
sl@0:     };
sl@0: 
sl@0:     template <class Arg1, class Arg2, class Result>
sl@0:     inline pointer_to_binary_function<Arg1,Arg2,Result> ptr_fun(Result (*f)(Arg1, Arg2))
sl@0:     {
sl@0:         return pointer_to_binary_function<Arg1,Arg2,Result>(f);
sl@0:     }
sl@0: } // namespace boost
sl@0: 
sl@0: #endif