...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
template <class Lhs, class Rhs=Lhs, class Ret=dont_care>
struct has_multiplies_assign : public true_type-or-false_type
{};
Inherits: If (i) lhs
of type Lhs
and rhs
of type Rhs
can be used in expression lhs*=rhs
,
and (ii) Ret=dont_care
or the result of expression
lhs*=rhs
is convertible to Ret
then inherits from true_type,
otherwise inherits from false_type.
The default behaviour (Ret=dont_care
)
is to not check for the return value of binary operator*=
. If Ret
is different from the default dont_care
type, the return value is checked to be convertible to Ret
.
Convertible to Ret
means
that the return value of the operator can be used as argument to a function
expecting Ret
:
void f(Ret); Lhs lhs; Rhs rhs; f(lhs*=rhs); // is valid if has_multiplies_assign<Lhs, Rhs, Ret>::value==true
If Ret=void
, the return type is checked to be exactly
void
.
Header: #include
<boost/type_traits/has_multiplies_assign.hpp>
or #include <boost/type_traits/has_operator.hpp>
or #include <boost/type_traits.hpp>
Examples:
has_multiplies_assign<Lhs, Rhs, Ret>::value_type
is the typebool
.
has_multiplies_assign<Lhs, Rhs, Ret>::value
is abool
integral constant expression.
has_multiplies_assign<int>::value
is abool
integral constant expression that evaluates totrue
.
has_multiplies_assign<long>
inherits fromtrue_type
.
has_multiplies_assign<int, int, int>
inherits fromtrue_type
.
has_multiplies_assign<int, int, long>
inherits fromtrue_type
.
has_multiplies_assign<int, double, double>
inherits fromtrue_type
.
has_multiplies_assign<int, double, int>
inherits fromtrue_type
.
has_multiplies_assign<const int, int>::value
inherits fromfalse_type
.
has_multiplies_assign<int, int, std::string>
inherits fromfalse_type
.
See also: Operator Type Traits
Limitation:
Known issues:
operator*=
is public or not: if operator*=
is defined as a private member of Lhs
then instantiating has_multiplies_assign<Lhs>
will produce a compiler error. For
this reason has_multiplies_assign
cannot be used to determine whether a type has a public operator*=
or not.
struct A { private: void operator*=(const A&); }; boost::has_multiplies_assign<A>::value; // error: A::operator*=(const A&) is private
A
and B
is convertible to A
.
In this case, the compiler will report an ambiguous overload.
struct A { }; void operator*=(const A&, const A&); struct B { operator A(); }; boost::has_multiplies_assign<A>::value; // this is fine boost::has_multiplies_assign<B>::value; // error: ambiguous overload
operator*=
is defined but does not bind for a given template type, it is still detected
by the trait which returns true
instead of false
. Example:
#include <boost/type_traits/has_multiplies_assign.hpp> #include <iostream> template <class T> struct contains { T data; }; template <class T> bool operator*=(const contains<T> &lhs, const contains<T> &rhs) { return f(lhs.data, rhs.data); } class bad { }; class good { }; bool f(const good&, const good&) { } int main() { std::cout<<std::boolalpha; // works fine for contains<good> std::cout<<boost::has_multiplies_assign< contains< good > >::value<<'\n'; // true contains<good> g; g*=g; // ok // does not work for contains<bad> std::cout<<boost::has_multiplies_assign< contains< bad > >::value<<'\n'; // true, should be false contains<bad> b; b*=b; // compile time error return 0; }
volatile
qualifier is not
properly handled and would lead to undefined behavior