1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
/*!
@file
Forward declares `boost::hana::mod`.
@copyright Louis Dionne 2013-2017
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
*/
#ifndef BOOST_HANA_FWD_MOD_HPP
#define BOOST_HANA_FWD_MOD_HPP
#include <boost/hana/config.hpp>
#include <boost/hana/core/when.hpp>
BOOST_HANA_NAMESPACE_BEGIN
//! Generalized integer modulus.
//! @ingroup group-EuclideanRing
//!
//! Given two elements of an EuclideanRing `x` and `y`, with `y`
//! nonzero, `mod` returns the modulus of the division of `x` by `y`.
//! In other words, `mod` can be seen as an equivalent to `%`.
//!
//! Cross-type version of the method
//! --------------------------------
//! The `mod` method is "overloaded" to handle distinct data types
//! with certain properties. Specifically, `mod` is defined for
//! _distinct_ data types `A` and `B` such that
//! 1. `A` and `B` share a common data type `C`, as determined by the
//! `common` metafunction
//! 2. `A`, `B` and `C` are all `EuclideanRing`s when taken individually
//! 3. `to<C> : A -> B` and `to<C> : B -> C` are `Ring`-embeddings, as
//! determined by the `is_embedding` metafunction.
//!
//! In that case, `mod` is defined as
//! @code
//! mod(x, y) = mod(to<C>(x), to<C>(y))
//! @endcode
//!
//!
//! Example
//! -------
//! @include example/mod.cpp
#ifdef BOOST_HANA_DOXYGEN_INVOKED
constexpr auto mod = [](auto&& x, auto&& y) -> decltype(auto) {
return tag-dispatched;
};
#else
template <typename T, typename U, typename = void>
struct mod_impl : mod_impl<T, U, when<true>> { };
struct mod_t {
template <typename X, typename Y>
constexpr decltype(auto) operator()(X&& x, Y&& y) const;
};
constexpr mod_t mod{};
#endif
BOOST_HANA_NAMESPACE_END
#endif // !BOOST_HANA_FWD_MOD_HPP
|
