std::constant_wrapper
Document #: | P2781R5 |
Date: | 2024-11-02 |
Project: | Programming Language C++ |
Audience: |
LEWG LWG |
Reply-to: |
Hana Dusíková <hanicka@hanicka.net> Matthias Kretz <m.kretz@gsi.de> Zach Laine <whatwasthataddress@gmail.com> |
std::integral_constant<int>
are
bad
X
constant_wrapper
more
usefuloperator()
operator->
?std::integral_constant
std::integral_constant
and
std::constexpr_v
, based on LEWG
feedback.std::constexpr_v::operator()
, as
requested by LEWG.std::constexpr_value
, as
suggested by LEWG.constexpr_value
concept.auto
NTTP parameter
for constexpr_v
, and default its
type template parameter.operator->
.std::integral_constant
.and
,
or
and
not
keywords.constexpr-param
concept.constexpr_v
’s
T
template parameter.operator()
and
operator[]
).operator++
and
operator-=
.constexpr_v
(formerly
“T
”) to be exposition-only.constexpr_v
->
constant_wrapper
, and
c_
->
cw
.inline
from constexpr
variable
templates. “Thanks,” Casey.This paper is co-authored in part by the authors of P2725R1
(“std::integral_constant
Literals”) and P2772R0
(“std::integral_constant
literals do not suffice —
constexpr_t
?”). This paper
supersedes both of those previous papers.
std::integral_constant<int>
are
badstd::integral_constant<int>
is
used in lots of places to communicate a constant integral value to a
given interface. The length of its spelling makes it very verbose.
Fortunately, we can do a lot better.
Before
|
After
|
---|---|
|
|
The “after” case above would require that
std::strided_index_range
be
changed; that is not being proposed here. The point of the example is to
show the relative convenience of
std::integral_constant
versus
the proposed
std::constant_wrapper
.
std::integral_constant
is not
enoughParameters passed to a
constexpr
function lose their
constexpr
-ness when used inside
the function. Replacing
std::integral_constant
with
std::constant_wrapper
has the
potential to improve a lot more uses of compile-time constants than just
integrals; what about all the other
constexpr
-friendly C++
types?
Consider:
template<typename T>
struct my_complex
{
T re, im;};
inline constexpr short foo = 2;
template<typename T>
struct S
{
void f(auto c)
{
// c is to be used as a constexpr value here
}
};
We would like to be able to call
S::f()
with a value, and have
that value keep its
constexpr
-ness. Let’s introduce
a template “constant_wrapper
”
that holds a constexpr
value
that it is given as an non-type template parameter.
namespace std {
template</* ... */ X>
struct constant_wrapper
{
using value_type = typename decltype(X)::type;
using type = constant_wrapper;
static constexpr const auto & value = X.data;
constexpr operator decltype(auto)() const noexcept { return value; }
// The rest of the members are discussed below ....
};
}
Now we can write this.
template<typename T>
void g(S<T> s)
{
.f(std::constant_wrapper<1>{});
s.f(std::constant_wrapper<2uz>{});
s.f(std::constant_wrapper<3.0>{});
s.f(std::constant_wrapper<4.f>{});
s.f(std::constant_wrapper<foo>{});
s.f(std::constant_wrapper<my_complex(1.f, 1.f)>{});
s}
Let’s now add a constexpr
variable template with a shorter name, say
cw
.
namespace std {
template</* ... */ X>
constexpr constant_wrapper<X> cw{};
}
And now we can write this.
template<typename T>
void g(S<T> s)
{
.f(std::cw<1>);
s.f(std::cw<2uz>);
s.f(std::cw<3.0>);
s.f(std::cw<4.f>);
s.f(std::cw<foo>);
s.f(std::cw<my_complex(1.f, 1.f)>);
s}
std::constant_wrapper
and
std::cw
If you look at the wording below, you will see that
std::cw
takes a single NTTP,
whereas std::constant_wrapper
takes an NTTP X
, and an
exposition-only parameter
adl-type
which is
defaulted to remove_cvref_t<decltype(X)>
. Why
is this? As the
adl-type
name implies,
ADL! Even though the type of X
is deduced with or without
adl-type
, without it
some natural uses of
constant_wrapper
cease to work.
For instance:
auto f = std::cw<"foo">;
::cout << f << "\n"; std
The stream insertion breaks without the
adl-type
parameter.
adl-type
is
char const [4]
, which pulls the
proper operator<<
into
consideration during ADL. Note that this ADL support is imperfect. An
earlier version of the paper showed using std::cw<strlit("foo)">
in a nstream insertion operation, where
strlit
is a strucutral type that
contains the bytes that comprise
"foo"
:
template<size_t N>
struct strlit
{
constexpr strlit(char const (&str)[N]) { std::copy_n(str, N, value); }
template<size_t M>
constexpr bool operator==(strlit<M> rhs) const
{
return std::ranges::equal(bytes_, rhs.bytes_);
}
friend std::ostream & operator<<(std::ostream & os, strlit l)
{
assert(!l.value[N - 1] && "value must be null-terminated");
return os.write(l.value, N - 1);
}
char value[N];
};
int main()
void print_foo()
{
auto f = std::cw<strlit("foo")>;
::cout << f; // Prints "foo".
std::cout << std::cw<"foo">; // Prints "foo".
std}
This worked because of the way the
operator<<
above is
declared – as a friend
.
If it were instead declared as a
non-friend
:
template<size_t N>
::ostream & operator<<(std::ostream & os, strlit<N> l) { /* ...*/ } std
… ADL’s help doesn’t suffice. The deduction of
N
is not possible from a type
that isn’t a strlit<N>
itself (e.g. base class) even if it is implicitly convertible to
strlit<N>
.
X
The type of X
was elided
above for simplicity; now let’s look at it. This is what is used:
template<typename T>
struct fixed_value {
using type = T;
constexpr fixed_value(type v) noexcept: data(v) { }
T data;};
template<typename T, size_t Extent>
struct fixed_value<T[Extent]> {
using type = T[Extent];
constexpr fixed_value(T (&arr)[Extent]) noexcept: fixed_value(arr, std::make_index_sequence<Extent>()) { }
[Extent];
T data
private:
template<size_t... Idx>
constexpr fixed_value(T (&arr)[Extent], std::index_sequence<Idx...>) noexcept: data{arr[Idx]...} { }
};
template<typename T, size_t Extent>
(T (&)[Extent]) -> fixed_value<T[Extent]>;
fixed_valuetemplate<typename T>
(T) -> fixed_value<T>; fixed_value
By writing constant_wrapper
as constant_wrapper<fixed_value X>
,
we are able to use CTAD in
fixed_value X
to defer writing
the type of the underlying value, and use deduction to cosntruct the
write specialization of
fixed_value
at the point of
specialization of
constant_wrapper
:
constexpr foo = constant_wrapper<"foo">;
static_assert(std::same_as<
decltype(foo),
const constant_wrapper<fixed_value<const char[4]>{"foo"}>>);
constexpr bar = constant_wrapper<42>;
static_assert(std::same_as<
decltype(bar),
const constant_wrapper<fixed_value<int>{42}>>);
This indirection allows the support for arrays that was added in this revision of the paper.
constant_wrapper
more usefulconstant_wrapper
is
essentially a wrapper. It takes a value
X
of some structural type
value_type
, and represents
X
in such a way that we can
continue to use X
as a
compile-time constant, regardless of context. As such,
constant_wrapper
should be
implicitly convertible to
value_type
; this is already
reflected in the design presented above. For the same reason,
constant_wrapper
should provide
all the operations that the underlying type has. Though we cannot
predict what named members the underlying type
value_type
has, we can
guess at all the operator overloads it might have.
So, by adding conditionally-defined overloads for all the
overloadable operators, we can make
constant_wrapper
as natural to
use as many of the types it might wrap.
namespace std {
struct operators {
// unary -
template<constexpr_param T>
friend constexpr auto operator-(T) noexcept -> constant_wrapper<(-T::value)> { return {}; }
// binary + and -
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator+(L, R) noexcept -> constant_wrapper<(L::value + R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator-(L, R) noexcept -> constant_wrapper<(L::value - R::value)> { return {}; }
// etc... (full listing later)
};
template<auto X>
struct constant_wrapper : operators {
using value_type = remove_cvref_t<decltype(X)>;
using type = constant_wrapper;
constexpr operator value_type() const { return X; }
static constexpr value_type value = X;
};
}
These operators are defined in such a way that they behave just like
the operations on underlying the
U
and
V
values would, including
promotions and coercions. For example:
static_assert(std::is_same_v<
decltype(std::cw<42> - std::cw<13u>),
::constant_wrapper<29u>>); std
Each operation is only defined if the underlying operation on
X
is defined. Each operation
additionally requires that the result of the underlying operation have a
structural type.
All the overloadable operations are included, even the index and call
operators. The rationale for this is that a user may want to make some
sort of compile-time domain-specific embedded language using operator
overloading, and having all but a couple of the operators specified
would frustrate that effort. The only exception to this is
operator->
which must
eventually return a pointer type, which is not very useful at compile
time.
The only downside to adding std::constant_wrapper::operator()
is
that it would represent a break from the design of
std::integral_constant
, making
it an imperfect drop-in replacement for that template. Nullary std::constant_wrapper::operator()
with
the same semantics as std::integral_constant::operator()
is
defined when requires (!std::invocable<value_type>)
is true
, so this incompatibility
is truly a corner case.
The operators are designed to interoperate with other types and
templates that have a constexpr static
value
member. This works with
std::constant_wrapper
s of
course, but also
std::integral_constant
s, and
user-provided types as well. For example:
struct my_type { constexpr static int value = 42; };
void foo()
{
constexpr auto zero = my_type{} - std::cw<42>; // Ok.
// ...
}
Note that the addition of these operators is in line with the poll:
“Add a new robust integral constant type with all the numerical
operators, as proposed in P2772R0, and use that for these literals
instead of
std::integral_constant
”?
SF
|
F
|
N
|
A
|
SA
|
---|---|---|---|---|
4 | 7 | 1 | 1 | 1 |
… taken in the 2023-01-17 Library Evolution telecon.
Note that the one SA said he would not be opposed if the word
“integral” was stricken from the poll, and the design of
std::constant_wrapper
is not
limited to integral types.
As mentioned above, in earlier versions of the paper,
std::cw<"foo">
did not work, because language rules prohibit using a reference to an
array as an NTTP. However, the latest implementation uses an
exposition-only structural type
cw-fixed-value
as the
constant_wrapper
NTTP;
cw-fixed-value
can be
constructed from a variety of different types, including arrays. This
allows an array to be given as the template parameter to
std::cw
, including an array of
char
, like a string literal. For
instance:
void print_foo()
{
::cout << std::cw<"foo">; // Prints "foo".
std}
This is not without its problems, however. Consider these two uses.
First, std::cw<"foo"> == std::cw<"foo">
.
This is expression is true, but it only compares pointers.
Second, std::cw<"bar"> < std::cw<"foo">
is not a constant expression. Runtime evaluation compares the pointers
of “foo” and “bar”. That’s a footgun.
In general, strings and other array types are not passed nearly as
ofter as arguments to constexpr
functions. It is questionable whether we should delay the very useful
semantics of std::cw<>
constexpr
function arguments
trying to find a design that supports array types. This is a question
that LEWG should answer.
Option 1: Support array values as NTTP template arguments to
std::constant_wrapper
.
Option 2: Leave all the code in place to support array value as NTTP
template arguments to
std::constant_wrapper
, except
disable the specialization that enables array values to work.
Option 1 is represented in the code that follows by
#define
ing
SUPPORT_ARRAY_VALUES
to a truthy
value. The idea of Option 2 is that it allows us easily to enable this
in future if we decide we want it. Note that under either option, std::cw<std::fixed_string<"foo">>
and std::cw<std::array<int, 2>{42, 13}>
work fine.
operator()
The addition of non-arithmetic operators may seem academic at first.
However, consider this
constexpr
-friendly parser
combinator mini-library.
namespace parse {
template<typename L, typename R>
struct or_parser;
template<size_t N>
struct str_parser
{
template<size_t M>
constexpr bool operator()(strlit<M> lit) const
{
return lit == str_;
}
template<typename P>
constexpr auto operator|(P parser) const
{
return or_parser<str_parser, P>{*this, parser};
}
<N> str_;
strlit};
template<typename L, typename R>
struct or_parser
{
template<size_t M>
constexpr bool operator()(strlit<M> lit) const
{
return l_(lit) || r_(lit);
}
template<typename P>
constexpr auto operator|(P parser) const
{
return or_parser<or_parser, P>{*this, parser};
}
L l_;
R r_;};
}
int foo()
{
constexpr parse::str_parser p1{strlit("neg")};
constexpr parse::str_parser p2{strlit("incr")};
constexpr parse::str_parser p3{strlit("decr")};
constexpr auto p = p1 | p2 | p3;
constexpr bool matches_empty = p(strlit(""));
static_assert(!matches_empty);
constexpr bool matches_pos = p(strlit("pos"));
static_assert(!matches_pos);
constexpr bool matches_decr = p(strlit("decr"));
static_assert(matches_decr);
}
(This relies on the strlit
struct shown just previously.)
Say we wanted to use the templates in namespace
parser
along side other values,
like int
s and
float
s. We would want that not
to break our
std::constant_wrapper
expressions. Having to work around the absence of std::constant_wrapper::operator()
would require us to write a lot more code. Here is the equivalent of the
function foo()
above, but with
all the variables wrapped using
std::cw
.
int bar()
{
constexpr parse::str_parser p1{strlit("neg")};
constexpr parse::str_parser p2{strlit("incr")};
constexpr parse::str_parser p3{strlit("decr")};
constexpr auto p_ = std::cw<p1> | std::cw<p2> | std::cw<p3>;
constexpr bool matches_empty_ = p_(std::cw<strlit("")>);
static_assert(!matches_empty_);
constexpr bool matches_pos_ = p_(std::cw<strlit("pos")>);
static_assert(!matches_pos_);
constexpr bool matches_decr_ = p_(std::cw<strlit("decr")>);
static_assert(matches_decr_);
}
As you can see, everything works as it did before. The presence of
operator()
does not enable any
new functionality, it just keeps code that happens to use it from
breaking.
It may seem at first that these operators are nonsensical, since all
the operations on a
constant_wrapper
must be
nonmutating.
However, some DSLs may wish to use these operations with atypical semantics.
struct weirdo
{
constexpr int operator++() const { return 1; }
};
auto result = ++std::cw<weirdo{}>;
result
is obviously
std::cw<1>
here, and no
mutation occurred. You can imagine a more elaborate use case, say a
library that is used to create expression templates. For example:
auto expr = std::cw<var0> += std::cw<var1>;
In this case, var0
and
var1
would be some terminal
types in the expression template library, and
operator+=
would return a
constexpr
expression tree,
rather than mutating the left side of the
+=
.
These operators are now part of the proposal, based on this LEWG poll from Kona 2023:
“We should add mutating operations
(i.e. #define IF_LEWG_SAYS_SO 1
and ++
and
--
) to P2781R3”
SF
|
F
|
N
|
A
|
SA
|
---|---|---|---|---|
2 | 6 | 5 | 2 | 0 |
operator->
?We’re not proposing it, because of its very specific semantics – it must yield a pointer, or something that eventually does. That’s not a very useful operation during constant evaluation.
std::integral_constant
During the LEWG reviews, some attendees suggested that
inter-conversions between
std::integral_constant
and
std::constant_wrapper
would be
useful. The important thing to remember is that we want deduction to
occur when calling functions that take a
std::constant_wrapper
, including
the std::constant_wrapper
operator overloads. Conversions and deductions are at odds with one
another, because deducing parameter types disables the conversion
rules.
If you look at the operator overloads proposed here, you will see
that they are deduction operations at their most essential. The types of
the parameters do not matter, except that each conveys a value that is a
core constant expression because it is embedded in the type system. The
fact that a
std::constant_wrapper
conveys
that value instead of a
std::integral_constant
is
immaterial, and in fact the operators are written in such a way that
they operate on either template (as long as at least one parameter is a
specialization of
std::constant_wrapper
). Users
can and should write their code using these kinds of values-as-types in
a similar way. Relying on conversions is a less-useful way to get
interoperability.
constant_wrapper
namespace std {
template<typename T>
struct cw-fixed-value; // exposition only
template<cw-fixed-value X,
typename adl-type = typename decltype(cw-fixed-value(X))::type> // exposition only
struct constant_wrapper;
template<class T>
concept constexpr_param = requires { typename constant_wrapper<T::value>; }; // exposition only
template<typename T>
struct cw-fixed-value { // exposition only
using type = T;
constexpr cw-fixed-value(type v) noexcept: data(v) { }
T data;};
#if SUPPORT_ARRAY_VALUES
template<typename T, size_t Extent>
struct cw-fixed-value<T[Extent]> { // exposition only
using type = T[Extent];
constexpr cw-fixed-value(T (&arr)[Extent]) noexcept: cw-fixed-value(arr, std::make_index_sequence<Extent>()) { }
[Extent];
T data
private:
template<size_t... Idx>
constexpr cw-fixed-value(T (&arr)[Extent], std::index_sequence<Idx...>) noexcept: data{arr[Idx]...} { }
};
#else
template<typename T, size_t Extent>
struct cw-fixed-value<T[Extent]> { // exposition only
constexpr cw-fixed-value(T (&)[Extent]) noexcept = delete;
};
#endif
template<typename T, size_t Extent>
(T (&)[Extent]) -> cw-fixed-value<T[Extent]>; // exposition only
cw-fixed-valuetemplate<typename T>
(T) -> cw-fixed-value<T>; // exposition only
cw-fixed-value
struct cw-operators { // exposition only
// unary operators
template<constexpr_param T>
friend constexpr auto operator+(T) noexcept -> constant_wrapper<(+T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator-(T) noexcept -> constant_wrapper<(-T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator~(T) noexcept -> constant_wrapper<(~T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator!(T) noexcept -> constant_wrapper<(!T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator&(T) noexcept -> constant_wrapper<(&T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator*(T) noexcept -> constant_wrapper<(*T::value)> { return {}; }
// binary operators
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator+(L, R) noexcept -> constant_wrapper<(L::value + R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator-(L, R) noexcept -> constant_wrapper<(L::value - R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator*(L, R) noexcept -> constant_wrapper<(L::value * R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator/(L, R) noexcept -> constant_wrapper<(L::value / R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator%(L, R) noexcept -> constant_wrapper<(L::value % R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator<<(L, R) noexcept -> constant_wrapper<(L::value << R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator>>(L, R) noexcept -> constant_wrapper<(L::value >> R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator&(L, R) noexcept -> constant_wrapper<(L::value & R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator|(L, R) noexcept -> constant_wrapper<(L::value | R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator^(L, R) noexcept -> constant_wrapper<(L::value ^ R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator&&(L, R) noexcept -> constant_wrapper<(L::value && R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator||(L, R) noexcept -> constant_wrapper<(L::value || R::value)> { return {}; }
// comparisons
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator<=>(L, R) noexcept -> constant_wrapper<(L::value <=> R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator<(L, R) noexcept -> constant_wrapper<(L::value < R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator<=(L, R) noexcept -> constant_wrapper<(L::value <= R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator==(L, R) noexcept -> constant_wrapper<(L::value == R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator!=(L, R) noexcept -> constant_wrapper<(L::value != R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator>(L, R) noexcept -> constant_wrapper<(L::value > R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator>=(L, R) noexcept -> constant_wrapper<(L::value >= R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator,(L, R) noexcept -> constant_wrapper<operator,(L::value, R::value)>
{ return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator->*(L, R) noexcept -> constant_wrapper<operator->*(L::value, R::value)>
{ return {}; }
// call and index
template<constexpr_param T, constexpr_param... Args>
constexpr auto operator()(this T, Args...) noexcept
requires requires(T::value_type x, Args...) { x(Args::value...); }
{ return constant_wrapper<(T::value(Args::value...))>{}; }
template<constexpr_param T, constexpr_param... Args>
constexpr auto operator[](this T, Args...) noexcept -> constant_wrapper<(T::value[Args::value...])>
{ return {}; }
// pseudo-mutators
template<constexpr_param T>
constexpr auto operator++(this T) noexcept requires requires(T::value_type x) { ++x; }
{ return constant_wrapper<[] { auto c = T::value; return ++c; }()>{}; }
template<constexpr_param T>
constexpr auto operator++(this T, int) noexcept requires requires(T::value_type x) { x++; }
{ return constant_wrapper<[] { auto c = T::value; return ++c; }()>{}; }
template<constexpr_param T>
constexpr auto operator--(this T) noexcept requires requires(T::value_type x) { --x; }
{ return constant_wrapper<[] { auto c = T::value; return --c; }()>{}; }
template<constexpr_param T>
constexpr auto operator--(this T, int) noexcept requires requires(T::value_type x) { x--; }
{ return constant_wrapper<[] { auto c = T::value; return c--; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator+=(this T, R) noexcept requires requires(T::value_type x) { x += R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v += R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator-=(this T, R) noexcept requires requires(T::value_type x) { x -= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v -= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator*=(this T, R) noexcept requires requires(T::value_type x) { x *= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v *= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator/=(this T, R) noexcept requires requires(T::value_type x) { x /= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v /= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator%=(this T, R) noexcept requires requires(T::value_type x) { x %= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v %= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator&=(this T, R) noexcept requires requires(T::value_type x) { x &= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v &= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator|=(this T, R) noexcept requires requires(T::value_type x) { x |= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v |= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator^=(this T, R) noexcept requires requires(T::value_type x) { x ^= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v ^= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator<<=(this T, R) noexcept requires requires(T::value_type x) { x <<= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v <<= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator>>=(this T, R) noexcept requires requires(T::value_type x) { x >>= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v >>= R::value; }()>{}; }
};
template<cw-fixed-value X, typename adl-type>
struct constant_wrapper: cw-operators {
static constexpr const auto & value = X.data;
using type = constant_wrapper;
using value_type = typename decltype(X)::type;
template<constexpr_param R>
constexpr auto operator=(R) const noexcept requires requires(value_type x) { x = R::value; }
{ return constant_wrapper<[] { auto v = value; return v = R::value; }()>{}; }
constexpr operator decltype(auto)() const noexcept { return value; }
constexpr decltype(auto) operator()() const noexcept requires (!std::invocable<value_type>) { return value; }
using cw-operators::operator();
};
template<cw-fixed-value X>
constexpr auto cw = constant_wrapper<X>{};
}
Add a new feature macro,
__cpp_lib_constant_wrapper
.
Additionally, an
integral_constant
with most of
the operator overloads has been a part of Boost.Hana
since its initial release in May of 2016. Its operations have been used
by many, many users.
Add the following to [meta.type.synop], after
false_type
:
template<typename T>
struct cw-fixed-value; // exposition only
template<cw-fixed-value X,
typename adl-type = typename decltype(cw-fixed-value(X))::type> // exposition only
struct constant_wrapper;
template<class T>
concept constexpr_param = requires { typename constant_wrapper<T::value>; }; // exposition only
struct cw-operators; // exposition only
template<cw-fixed-value X> constexpr auto cw = constant_wrapper<X>{};
Add the following to [meta.help], after
integral_constant
:
template<typename T>
struct cw-fixed-value { // exposition only
using type = T;
constexpr cw-fixed-value(type v) noexcept: data(v) { }
T data;
};
#if SUPPORT_ARRAY_VALUES
template<typename T, size_t Extent>
struct cw-fixed-value<T[Extent]> { // exposition only
using type = T[Extent];
constexpr cw-fixed-value(T (&arr)[Extent]) noexcept: cw-fixed-value(arr, std::make_index_sequence<Extent>()) { }
T data[Extent];
private:
template<size_t... Idx>
constexpr cw-fixed-value(T (&arr)[Extent], std::index_sequence<Idx...>) noexcept: data{arr[Idx]...} { }
};
#else
template<typename T, size_t Extent>
struct cw-fixed-value<T[Extent]> { // exposition only
constexpr cw-fixed-value(T (&)[Extent]) noexcept = delete;
};
#endif
template<typename T, size_t Extent>
cw-fixed-value(T (&)[Extent]) -> cw-fixed-value<T[Extent]>; // exposition only
template<typename T>
cw-fixed-value(T) -> cw-fixed-value<T>; // exposition only
struct cw-operators { // exposition only
// unary operators
template<constexpr_param T>
friend constexpr auto operator+(T) noexcept -> constant_wrapper<(+T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator-(T) noexcept -> constant_wrapper<(-T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator~(T) noexcept -> constant_wrapper<(~T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator!(T) noexcept -> constant_wrapper<(!T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator&(T) noexcept -> constant_wrapper<(&T::value)> { return {}; }
template<constexpr_param T>
friend constexpr auto operator*(T) noexcept -> constant_wrapper<(*T::value)> { return {}; }
// binary operators
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator+(L, R) noexcept -> constant_wrapper<(L::value + R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator-(L, R) noexcept -> constant_wrapper<(L::value - R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator*(L, R) noexcept -> constant_wrapper<(L::value * R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator/(L, R) noexcept -> constant_wrapper<(L::value / R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator%(L, R) noexcept -> constant_wrapper<(L::value % R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator<<(L, R) noexcept -> constant_wrapper<(L::value << R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator>>(L, R) noexcept -> constant_wrapper<(L::value >> R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator&(L, R) noexcept -> constant_wrapper<(L::value & R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator|(L, R) noexcept -> constant_wrapper<(L::value | R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator^(L, R) noexcept -> constant_wrapper<(L::value ^ R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator&&(L, R) noexcept -> constant_wrapper<(L::value && R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator||(L, R) noexcept -> constant_wrapper<(L::value || R::value)> { return {}; }
// comparisons
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator<=>(L, R) noexcept -> constant_wrapper<(L::value <=> R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator<(L, R) noexcept -> constant_wrapper<(L::value < R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator<=(L, R) noexcept -> constant_wrapper<(L::value <= R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator==(L, R) noexcept -> constant_wrapper<(L::value == R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator!=(L, R) noexcept -> constant_wrapper<(L::value != R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator>(L, R) noexcept -> constant_wrapper<(L::value > R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator>=(L, R) noexcept -> constant_wrapper<(L::value >= R::value)> { return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator,(L, R) noexcept -> constant_wrapper<operator,(L::value, R::value)>
{ return {}; }
template<constexpr_param L, constexpr_param R>
friend constexpr auto operator->*(L, R) noexcept -> constant_wrapper<operator->*(L::value, R::value)>
{ return {}; }
// call and index
template<constexpr_param T, constexpr_param... Args>
constexpr auto operator()(this T, Args...) noexcept
requires requires(T::value_type x, Args...) { x(Args::value...); }
{ return constant_wrapper<(T::value(Args::value...))>{}; }
template<constexpr_param T, constexpr_param... Args>
constexpr auto operator[](this T, Args...) noexcept -> constant_wrapper<(T::value[Args::value...])>
{ return {}; }
// pseudo-mutators
template<constexpr_param T>
constexpr auto operator++(this T) noexcept requires requires(T::value_type x) { ++x; }
{ return constant_wrapper<[] { auto c = T::value; return ++c; }()>{}; }
template<constexpr_param T>
constexpr auto operator++(this T, int) noexcept requires requires(T::value_type x) { x++; }
{ return constant_wrapper<[] { auto c = T::value; return ++c; }()>{}; }
template<constexpr_param T>
constexpr auto operator--(this T) noexcept requires requires(T::value_type x) { --x; }
{ return constant_wrapper<[] { auto c = T::value; return --c; }()>{}; }
template<constexpr_param T>
constexpr auto operator--(this T, int) noexcept requires requires(T::value_type x) { x--; }
{ return constant_wrapper<[] { auto c = T::value; return c--; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator+=(this T, R) noexcept requires requires(T::value_type x) { x += R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v += R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator-=(this T, R) noexcept requires requires(T::value_type x) { x -= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v -= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator*=(this T, R) noexcept requires requires(T::value_type x) { x *= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v *= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator/=(this T, R) noexcept requires requires(T::value_type x) { x /= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v /= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator%=(this T, R) noexcept requires requires(T::value_type x) { x %= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v %= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator&=(this T, R) noexcept requires requires(T::value_type x) { x &= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v &= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator|=(this T, R) noexcept requires requires(T::value_type x) { x |= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v |= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator^=(this T, R) noexcept requires requires(T::value_type x) { x ^= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v ^= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator<<=(this T, R) noexcept requires requires(T::value_type x) { x <<= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v <<= R::value; }()>{}; }
template<constexpr_param T, constexpr_param R>
constexpr auto operator>>=(this T, R) noexcept requires requires(T::value_type x) { x >>= R::value; }
{ return constant_wrapper<[] { auto v = T::value; return v >>= R::value; }()>{}; }
};
template<cw-fixed-value X, typename adl-type>
struct constant_wrapper: cw-operators {
static constexpr const auto & value = X.data;
using type = constant_wrapper;
using value_type = typename decltype(X)::type;
template<constexpr_param R>
constexpr auto operator=(R) const noexcept requires requires(value_type x) { x = R::value; }
{ return constant_wrapper<[] { auto v = value; return v = R::value; }()>{}; }
constexpr operator decltype(auto)() const noexcept { return value; }
constexpr decltype(auto) operator()() const noexcept requires (!std::invocable<value_type>) { return value; }
using cw-operators::operator();
};
template<cw-fixed-value X> constexpr auto cw = constant_wrapper<X>{};
2
The class template
constant_wrapper
aids in
metaprogramming by ensuring that the evaluation of expressions comprised
entirely of constant_wrapper
s
are core constant expressions ([expr.const]), regardless of the context
in which they appear. In particular, this enables use of
constant_wrapper
values that are
passed as arguments to constexpr
functions to be used as template parameters.
3
The variable template cw
is
provided as a convenient way to nominate
constant_wrapper
values.
Add to [version.syn]:
#define __cpp_lib_constant_wrapper XXXXXXL // also in <type_traits>