typestuff.h

Go to the documentation of this file.

/*
  This file is part of MADNESS.

  Copyright (C) 2007,2010 Oak Ridge National Laboratory

  This program is free software; 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.

  This program 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

  For more information please contact:

  Robert J. Harrison
  Oak Ridge National Laboratory
  One Bethel Valley Road
  P.O. Box 2008, MS-6367

  email: harrisonrj@ornl.gov
  tel:   865-241-3937
  fax:   865-572-0680


  $Id$
*/


#ifndef MADNESS_WORLD_TYPESTUFF_H__INCLUDED
#define MADNESS_WORLD_TYPESTUFF_H__INCLUDED


#include <cstddef>
#include <stdint.h>
#include <madness/madness_config.h>

// Next 3 use TR1 or BOOST if available, otherwise a minimal
// version we support ... in the std:: namespace
#include <madness/world/type_traits.h>

// Boost-like enable if stuff in the madness:: namespace
#include <madness/world/enable_if.h>

// Boost-like stuff in the madnes::tr1::details namespace
#include <madness/world/function_traits_bits.h>

namespace madness {

    template <class A, class B>
    struct is_derived_from {
        typedef char yes;
        typedef int no;
        static no f(...);
        static yes f(B*);
        static const bool value = (sizeof(f((A*)0)) == sizeof(yes));
    };

    template <class A>
    struct is_derived_from<A,A> : public std::false_type {};

    template <typename> class Future;
    template <typename> struct remove_future;

    // Remove Future, const, volatile, and reference qualifiers from the type
    template <typename T>
    struct remove_fcvr {
        typedef typename remove_future<typename std::remove_cv<
                                           typename std::remove_reference<T>::type>::type>::type type;
    };

    template <typename T>
    struct is_serializable {
        static const bool value = std::is_fundamental<T>::value || std::is_member_function_pointer<T>::value || std::is_function<T>::value  || std::is_function<typename std::remove_pointer<T>::type>::value;
    };

    template <class T, typename resultT>
    class BindNullaryMemFun {
    private:
        T* t_;
        resultT(T::*op_)();
    public:
        BindNullaryMemFun(T* t, resultT(T::*op)()) : t_(t), op_(op) {}
        resultT operator()() {
            return (t_->*op_)();
        }
    };

    template <class T>
    class BindNullaryMemFun<T,void> {
    private:
        T* t_;
        void (T::*op_)();
    public:
        BindNullaryMemFun(T* t, void (T::*op)()) : t_(t), op_(op) {}
        void operator()() {
            (t_->*op_)();
        }
    };


    template <class T, typename resultT>
    class BindNullaryConstMemFun {
    private:
        const T* t_;
        resultT(T::*op_)() const;
    public:
        BindNullaryConstMemFun(const T* t, resultT(T::*op)() const) : t_(t), op_(op) {}
        resultT operator()() const {
            return (t_->*op_)();
        }
    };

    template <class T>
    class BindNullaryConstMemFun<T,void> {
    private:
        const T* t_;
        void (T::*op_)() const;
    public:
        BindNullaryConstMemFun(const T* t, void (T::*op)() const) : t_(t), op_(op) {}
        void operator()() const {
            (t_->*op_)();
        }
    };

    template <class T, typename resultT>
    inline BindNullaryMemFun<T,resultT> bind_nullary_mem_fun(T* t, resultT(T::*op)()) {
        return BindNullaryMemFun<T,resultT>(t,op);
    }

    template <class T, typename resultT>
    inline BindNullaryConstMemFun<T,resultT> bind_nullary_mem_fun(const T* t, resultT(T::*op)() const) {
        return BindNullaryConstMemFun<T,resultT>(t,op);
    }

    struct Void {};

    static const Void None = Void();

    template <typename T>
    struct ReturnWrapper {
        typedef T type;
    };

    template <>
    struct ReturnWrapper<void> {
        typedef Void type;
    };


    template <typename T> class Reference {
        T* p;
    public:
        Reference(T* x) : p(x) {}
        T& operator*() const {return *p;}
        T* operator->() const {return p;}
    };

    template <typename T>
    struct has_result_type {
        // yes and no are guaranteed to have different sizes,
        // specifically sizeof(yes) == 1 and sizeof(no) == 2
        typedef char yes[1];
        typedef char no[2];

        template <typename C>
        static yes& test(typename C::result_type*);

        template <typename>
        static no& test(...);

        // if the sizeof the result of calling test<T>(0) is equal to the sizeof(yes),
        // the first overload worked and T has a nested type named type.
        static const bool value = sizeof(test<T>(0)) == sizeof(yes);
    };


    /* Macros to make some of this stuff more readable */

#define REMREF(TYPE)    typename std::remove_reference< TYPE >::type
#define REMCONST(TYPE)  typename std::remove_const< TYPE >::type
#define REMCONSTX(TYPE) std::remove_const< TYPE >::type
#define RETURN_WRAPPERT(TYPE) typename madness::ReturnWrapper< TYPE >::type

#define MEMFUN_RETURNT(MEMFUN) typename madness::detail::memfunc_traits< MEMFUN >::result_type
#define MEMFUN_CONSTNESS(MEMFUN) madness::detail::memfunc_traits< MEMFUN >::constness
#define MEMFUN_OBJT(MEMFUN)    typename madness::detail::memfunc_traits< MEMFUN >::obj_type
#define MEMFUN_ARITY(MEMFUN)   madness::detail::memfunc_traits< MEMFUN >::arity
#define MEMFUN_ARG1T(MEMFUN)   typename madness::detail::memfunc_traits< MEMFUN >::arg1_type
#define MEMFUN_ARG2T(MEMFUN)   typename madness::detail::memfunc_traits< MEMFUN >::arg2_type
#define MEMFUN_ARG3T(MEMFUN)   typename madness::detail::memfunc_traits< MEMFUN >::arg3_type
#define MEMFUN_ARG4T(MEMFUN)   typename madness::detail::memfunc_traits< MEMFUN >::arg4_type

#define FUNCTION_RETURNT(FUNCTION) typename madness::detail::function_traits< FUNCTION >::result_type
#define FUNCTION_ARITY(FUNCTION)   madness::detail::function_traits< FUNCTION >::arity
#define FUNCTION_ARG1T(FUNCTION)   typename madness::detail::function_traits< FUNCTION >::arg1_type
#define FUNCTION_ARG2T(FUNCTION)   typename madness::detail::function_traits< FUNCTION >::arg2_type
#define FUNCTION_ARG3T(FUNCTION)   typename madness::detail::function_traits< FUNCTION >::arg3_type
#define FUNCTION_ARG4T(FUNCTION)   typename madness::detail::function_traits< FUNCTION >::arg4_type

#define RESULT_OF(FUNCTION) typename madness::detail::result_of< FUNCTION >::type

#define IS_SAME(A, B) std::is_same< A, B >
#define IS_EQ(A, B) std::is_eq< A, B >

} // end of namespace madness
#endif // MADNESS_WORLD_TYPESTUFF_H__INCLUDED