2
0
mirror of https://github.com/boostorg/hof.git synced 2026-01-22 05:12:39 +00:00
Files
hof/include/fit/static.hpp
2016-12-17 19:56:52 -05:00

98 lines
2.2 KiB
C++

/*=============================================================================
Copyright (c) 2014 Paul Fultz II
static.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_FUNCTION_STATIC_H
#define FIT_GUARD_FUNCTION_STATIC_H
/// static
/// ======
///
/// Description
/// -----------
///
/// The `static_` adaptor is a static function adaptor that allows any
/// default-constructible function object to be static-initialized. Functions
/// initialized by `static_` cannot be used in `constexpr` functions. If the
/// function needs to be statically initialized and called in a `constexpr`
/// context, then a `constexpr` constructor needs to be used rather than
/// `static_`.
///
/// Synopsis
/// --------
///
/// template<class F>
/// class static_;
///
/// Requirements
/// ------------
///
/// F must be:
///
/// * [ConstFunctionObject](ConstFunctionObject)
/// * DefaultConstructible
///
/// Example
/// -------
///
/// #include <fit.hpp>
/// #include <cassert>
/// using namespace fit;
///
/// // In C++ this class can't be static-initialized, because of the non-
/// // trivial default constructor.
/// struct times_function
/// {
/// double factor;
/// times_function() : factor(2)
/// {}
/// template<class T>
/// T operator()(T x) const
/// {
/// return x*factor;
/// }
/// };
///
/// static constexpr static_<times_function> times2 = {};
///
/// int main() {
/// assert(6 == times2(3));
/// }
///
#include <fit/detail/result_of.hpp>
#include <fit/reveal.hpp>
namespace fit {
template<class F>
struct static_
{
struct failure
: failure_for<F>
{};
const F& base_function() const
FIT_NOEXCEPT_CONSTRUCTIBLE(F)
{
static F f;
return f;
}
FIT_RETURNS_CLASS(static_);
template<class... Ts>
FIT_SFINAE_RESULT(F, id_<Ts>...)
operator()(Ts && ... xs) const
FIT_SFINAE_RETURNS(FIT_CONST_THIS->base_function()(FIT_FORWARD(Ts)(xs)...));
};
} // namespace fit
#endif