2
0
mirror of https://github.com/boostorg/hof.git synced 2026-01-22 05:12:39 +00:00
Files
hof/include/fit/eval.hpp
2017-02-08 19:31:27 -06:00

87 lines
2.2 KiB
C++

/*=============================================================================
Copyright (c) 2015 Paul Fultz II
eval.h
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
==============================================================================*/
#ifndef FIT_GUARD_EVAL_H
#define FIT_GUARD_EVAL_H
/// eval
/// ====
///
/// Description
/// -----------
///
/// The `eval` function will evaluate a "thunk". This can be either a nullary
/// function or it can be a unary function that takes the identity function as
/// the first parameter(which is helpful to delay compile-time checking).
/// Also, additional parameters can be passed to `eval` to delay
/// compiliation(so that result can depend on template parameters).
///
/// Synopsis
/// --------
///
/// template<class F, class... Ts>
/// constexpr auto eval(F&& f, Ts&&...);
///
/// Requirements
/// ------------
///
/// F must be:
///
/// * [EvaluatableFunctionObject](EvaluatableFunctionObject)
///
/// Example
/// -------
///
/// #include <fit.hpp>
/// #include <cassert>
///
/// int main() {
/// assert(fit::eval([]{ return 3; }) == 3);
/// }
///
/// References
/// ----------
///
/// * [POO51](http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0051r2.pdf) - Proposal for C++
/// Proposal for C++ generic overload function
/// * [static_if](static_if)
/// * [Ordering evaluation of arguments](<Ordering evaluation of arguments>)
///
#include <fit/always.hpp>
#include <fit/identity.hpp>
#include <fit/conditional.hpp>
#include <fit/detail/result_of.hpp>
namespace fit {
namespace detail {
struct simple_eval
{
template<class F, class... Ts>
constexpr FIT_SFINAE_RESULT(F)
operator()(F&& f, Ts&&...xs) const FIT_SFINAE_RETURNS
(fit::always_ref(f)(xs...)());
};
struct id_eval
{
template<class F, class... Ts>
constexpr FIT_SFINAE_RESULT(F, id_<decltype(fit::identity)>)
operator()(F&& f, Ts&&...xs) const FIT_SFINAE_RETURNS
(fit::always_ref(f)(xs...)(fit::identity));
};
}
FIT_DECLARE_STATIC_VAR(eval, fit::conditional_adaptor<detail::simple_eval, detail::id_eval>);
} // namespace fit
#endif