blob: 7961e255f9a0baa0152a1b47a6ace14b9f228fde [file] [log] [blame]
Brian Silverman4a2409e2018-08-04 23:24:02 -07001[/
2 (C) Copyright 2009-2011 Frederic Bron.
3 Distributed under the Boost Software License, Version 1.0.
4 (See accompanying file LICENSE_1_0.txt or copy at
5 http://www.boost.org/LICENSE_1_0.txt).
6]
7
8[section:has_bit_and has_bit_and]
9 template <class Lhs, class Rhs=Lhs, class Ret=dont_care>
10 struct has_bit_and : public __tof {};
11
12__inherit
13If (i) `lhs` of type `Lhs` and `rhs` of type `Rhs` can be used in expression `lhs&rhs`,
14and (ii) `Ret=dont_care` or the result of expression `lhs&rhs` is convertible to `Ret`
15then inherits from __true_type,
16otherwise inherits from __false_type.
17
18The default behaviour (`Ret=dont_care`) is to not check for the return value of binary `operator&`.
19If `Ret` is different from the default `dont_care` type, the return value is checked to be convertible to `Ret`.
20Convertible to `Ret` means that the return value of the operator can be used as argument to a function expecting `Ret`:
21``
22void f(Ret);
23Lhs lhs;
24Rhs rhs;
25f(lhs&rhs); // is valid if has_bit_and<Lhs, Rhs, Ret>::value==true
26``
27If `Ret=void`, the return type is checked to be exactly `void`.
28
29__header `#include <boost/type_traits/has_bit_and.hpp>` or `#include <boost/type_traits/has_operator.hpp>` or `#include <boost/type_traits.hpp>`
30
31__examples
32
33[:`has_bit_and<Lhs, Rhs, Ret>::value_type` is the type `bool`.]
34[:`has_bit_and<Lhs, Rhs, Ret>::value` is a `bool` integral constant expression.]
35[:`has_bit_and<int>::value` is a `bool` integral constant expression that evaluates to `true`.]
36[:`has_bit_and<long>` inherits from `__true_type`.]
37
38[:`has_bit_and<int, int, int>` inherits from `__true_type`.]
39[:`has_bit_and<const int, int>` inherits from `__true_type`.]
40
41[:`has_bit_and<int, double, bool>` inherits from `__false_type`.]
42[:`has_bit_and<int, int, std::string>` inherits from `__false_type`.]
43
44
45[*See also:] [link boost_typetraits.category.value_traits.operators Operator Type Traits]
46
47[has_binary_operator_compat]
48
49[binary_operator_known_issues has_bit_and..&..A..contains<T>..const ]
50
51[endsect]
52