Solving partial ordering issues introduced by P0522R0

Document #: P3310R2
Date: 2024-05-21
Project: Programming Language C++
Audience: Core Working Group
Reply-to: Matheus Izvekov
<>

1 Introduction

This paper aims to address some lingering issues introduced with the adoption of P0522R0 into C++17, later made a defect report, which relaxed the rules on how templates are matched to template template parameters, but didn’t concern itself with how partial ordering would be affected.

As a result, it invalidated several perfectly legitimate prior uses, creating compatibility issues with old code, forcing implementors to amend the rules, and overall slowing adoption.

We will point out two separate issues and their proposed solutions, which can be picked and voted independently, with the intention that they be adopted as resolutions to [CWG2398], which is the core issue tracking this problem.

The intent is to keep old code working, not to change best practices. With that said, these proposed rules should keep things more consistent and explainable.

If any of the solutions is adopted, it is suggested to bump the version for the feature testing macro.

2 Changelog

2.1 Problem #1

2.1.1 Since R1

2.1.2 Since R0

2.2 Problem #2

2.2.1 Since R0

3 Problem #1 - Default Arguments

Consider the following example:

template<class T1> struct A;

template<template<class T2> class TT1, class T3>
struct A<TT1<T3>>; // #1

template<template<class T4, class T5> class TT2, class T6, class T7>
struct A<TT2<T6, T7>> {}; // #2

template<class T8, class T9 = float> struct B;
template struct A<B<int>>;

Prior to [P0522R0], with the more strict rules, only the partial specialization candidate #2 would be considered, since B has two template parameters, T8 and T9, and the template template parameter in #1 has only T2 as a template parameter, so #1 doesn’t match.

After P0522R0, #1 starts being accepted as a candidate, since B can be used just fine in place of TT1 in the specialization A<TT1<T3>>: The default argument float for T9 allows B to be specialized with just a single argument.

However, the rules for partial ordering operate considering only the candidates themselves, without access to B, which has the default template argument. When looking at only those candidates, it’s not obvious the specialization of TT1 would work, if that were to be replaced with a template with two parameters.

The only clue is the fact that these two candidates are being considered together: this must mean that default arguments are somehow involved.

But nonetheless, as things stand, these candidates cannot be ordered, resulting in ambiguity.

Maintaining the pre-P0522 semantics of picking #2 would be ideal: Besides that it would be a compatible change, it is logical that this is the most specialized candidate.

3.1 Solution to #1

When performing template argument deduction such that P and A are specializations of either class templates or template template parameters:

template <class T1, ... class Tn> TT1
P = TT1<X1, ..., Xn>
A = TT2<Y1, ..., Ym>

Under the current rules, TT1 will be deduced as TT2.

This paper proposes that in this case, TT1 will be deduced as a new template, synthesized from and almost identical to TT2, except that the specialization arguments (Yn, ..., Ym) will be used as default arguments in this new invented TT2, replacing any existing ones, effectively as if it had been written as:

template<class T1, ..., class Tn, class Tn+1 = Yn+1, ..., class Tm = Ym>
using TT1 = TT2<T1, ..., Tn, Tn+1, ..., Tm> class TT2

That is, all template arguments used in the specialization of TT2, which would not have been consumed had them been used in TT1, will be used to deduce the default arguments for TT2.

In particular, this means that had Tn been a parameter pack, no default arguments will be deduced for TT2, as that consumes all arguments.

When binding TT2 to TT1, the extra parameters are not accessible, since the specialization to TT1 is checked at template parse time, so the usage must match it’s declaration.

So it’s possible to conceptually simplify this, and think of this alias template as:

template<class T1, ..., class Tn> using TT1 = TT2<T1, ..., Tn, Yn+1, ..., Ym>

It’s useful to think of these invented templates in terms of the equivalences proposed in [CWG1286], but the last proposed resolution for that core issue only recognizes the first form.

3.1.1 Class templates

Conversely, a template template parameter can also be deduced as a class template:

template <class T1, class T2 = float> struct A;

template <class T3> struct B;
template <template <class T4> class TT1, class T5> struct B<TT1<T5>>;      // #1
template <class T6, class T7>                      struct B<A<T6, T7>> {}; // #2

template struct B<A<int>>;

When partially ordering #1 versus #2, TT1 will be deduced as a synthesized template based on A, with T7 as default argument for T2.

When these proposed rules are applied to class template deduction, this example, which is unrelated to partial ordering, also becomes valid:

template<class T, class U> struct A {};
A<int, float> v;
template<template<class> class TT> void f(TT<int>);
void g() { f(v); }

Here, ‘TT’ picks a deduced alias of ‘A’ which has ‘float’ as the default argument for the second template parameter U.

This deduced alias template must be different from the underlying template A, in case any deduced default arguments actually differ from what is declared in A.

So f deduced from A<int, float> will be a different specialization than one deduced from A<int, double>.

This has some overlap with [CWG1286], and it’s expected the same consequences should apply regarding name mangling.

This paper is not proposing to standardize a syntax to create this implicit alias as written, outside of deduction, but for explanatory purposes, the following syntax will be used: A:1<float>. Where this means, take the template name A, and create an alias from it by applying the following template arguments as defaults, starting from the second argument. Roughly equivalent to:

template<class T, class U> struct A {};
template <class T, class U = float> using invented_alias_A_1_float = A<T, U>;

This syntax will be used in the rest of this chapter to convey this adjustment.

This adjustment has one additional consequence:

template<class T, class Alloc = std::allocator<T>> class vector {};

template<template<class> class Container>
  auto f(Container<int>) -> Container<float>;

vector<int> v;
vector<float> x  = f(v);

Where as before this would work as intended, this deduction would produce a vector<float, std::allocator<int>>, which is likely to be not desirable in this case.

This example was created for exposition, and not extracted from any real world use case. It’s not clear this is a ‘good idea’ that we would like to preserve.

But in any case, it’s possible to create an adjustment that would keep this working, if there is inclination towards it, so this is left for future work.

3.1.2 Consistency

When a parameter is deduced against multiple arguments, there are issues related to consistency, both in deduced and non-deduced contexts.

Related to the former, given this example:

template<class T1, class T2> struct A;

template<template<class, class> class TT1, class T1, class T2, class T3>
struct A<TT1<T1, T2>, TT1<T1, T3>> {}; // #1

template<template<class> class UU1, class U1, class U2>
struct A<UU1<U1>, UU1<U2>>; // #2

template struct A<B<int>, B<int>>;

Prior to P0522, #1 would be picked. This becomes ambiguous after P0522, and the rules proposed in this paper don’t help.

The problem is that UU1 will be deduced as both TT1:1<T2> and TT1:1<T3>, and these should in general be treated as different templates, so this would be taken as an inconsistent deduction under current rules.

It should be possible to make this work and keep the pre P0522 behavior, but the present paper doesn’t go as far yet, and this is left for future work.

This would involve recognizing that we are deducing two templates against each other. T2 and T3 are both template parameters of it, and it’s consistent that they could be deduced to refer to the same type.

Regarding consistency in non-deduced contexts, given this example:

template<class T> struct N { using type = T; };

template<class T1, class T2, class T3> struct A;

template<template<class, class> class TT1,
         class T1, class T2, class T3, class T4>
struct A<TT1<T1, T2>, TT1<T3, T4>,
         typename N<TT1<T1, T2>>::type> {};

template<template<class> class UU1,
         template<class> class UU2,
         class U1, class U2>
struct A<UU1<U1>, UU2<U2>, typename N<UU1<U1>>::type>;

template<class T8, class T9 = float> struct B;
template struct A<B<int>, B<int>, B<int>>;

This was accepted prior to P0522R0, but picking T2 for the default argument of TT1 will result in this example being accepted, but result in rejection of the symmetric example where N<TT1<T1, T2>> is replaced with N<TT1<T1, T4>>, which is also accepted pre-P0522.

This is a similar problem, and this paper does not propose a mechanism to either keep both working, neither to reject both as ambiguous. This is left for future work.

3.1.3 Packs

As a particular consequence of this proposal, default arguments can be deduced for pack parameters, something which is not ordinarily possible to obtain.

The following example should become valid:

template <class T1, class ...T2s> struct A {
  static constexpr auto val = sizeof...(T2s);
};

template <template <class T3> class TT> void f(TT<int> v) {
  static_assert(v.val == 3);
};
void test() {
  f(A<int, void, void, void>());
}

This affects the partial ordering of the following example:

template<class T1, class T2 = float> struct A;
template<class T3> struct B;

template<template<class T4> class TT1, class T5>
struct B<TT1<T5>>; // #1

template<template<class T6, class ...T7s> class TT2, class T8, class ...T9s>
struct B<TT2<T8, T9s...>> {}; // #2

template struct B<A<int>>;

Before P0522, #2 was picked. After P0522, this changed entirely, now #1 is picked.

The proposed rules will restore the pre-P0522 behavior, picking #2 again.

3.2 Wording for #1

Modify §13.10.3.6 13.10.3.6 [temp.deduct.type]/8:

8 A template type argument T, a template template argument TT, or a template non-type argument i can be deduced if P and A have one of the following forms:

cvopt T
T*
T&
T&&
Topt [iopt]
Topt (Topt) noexcept(iopt)
Topt Topt::*
TTopt<T>
TTopt<i>
TTopt<TTopt>
TTopt<>
TTopt

(8.1) - Topt represents a type or parameter-type-list that either satisfies these rules recursively, is a non-deduced context in P or A, or is the same non-dependent type in P and A,

(8.2) - TTopt represents either a class template or a template template parameter,

[Example:

template<class T, class U> struct A {};
template<template<class> class TT> void f(TT<int>);
void g() {
  A<int, float> v;
  // OK, TT = A, 'float' is used as default argument the second parameter
  f(v);
}
  • end example]

(8.3) - When matching TTopt specializations, TTopt will be deduced as if its template argument list in A were used as the default arguments for its template parameters, starting from the first parameter which has a correspondence in P, up to the last parameter which has a corresponding argument.

Append examples to §13.4.4 13.4.4 [temp.arg.template]/4:

[Example:

template <class, class = float> struct A;

template <class> struct B;
template <template <class> class TT, class T> struct B<TT<T>>;   // #1
template <class T, class U>                   struct B<A<T, U>>; // #2
template struct B<A<int>>; // selects #2

template <class> struct C;
template <template <class> class TT, class T> struct C<TT<T>>;   // #3
template <class T, class U>                   struct C<A<T, U>>; // #4
template struct C<A<int>>; // selects #4
  • end example]

Modify example in §13.7.8 13.7.8 [temp.alias]/2:

[Example 1:

-13,7 +13,8
 template<template<class> class TT>
   void f(TT<int>);

-f(v);               // error: Vec not deduced
+// OK, TT = vector, Alloc<int> used as default argument for second parameter
+f(v);

 template<template<class,class> class TT>
   void g(TT<int, Alloc<int>>);

— end example]

4 Problem #2 - With vs Without Packs

Consider the following example:

template<template<class ...T1s> class TT1> struct A {};
template<class T2> struct B;
template struct A<B>; // #1

template<template<class T3> class TT2> struct C {};
template<class ...T4s> struct D;
template struct C<D>; // #2

Before [P0522R0], #1 was valid, and #2 was invalid.

After P0522R0, #1 stayed valid, and #2 became valid.

Now consider this partial ordering example:

template<class T1> struct A;

template<template<class ...T2s> class TT1, class T3>
struct A<TT1<T3>>; // #1

template<template<class T4> class TT2, class T5>
struct A<TT2<T5>> {}; // #2

template<class T6> struct B;
template struct A<B<int>>;

Before P0522R0, #2 was picked.

However, since the same rules which determine a template can bind to a template template parameter, are also used to determine one template template parameter is at least as specialized as another, and since P0522R0 made no special provisions in these rules for the latter, this example now becomes ambiguous.

But this is undesirable, because it is a breaking change, and also because logically #2 is more specialized.

The new paragraph inserted with P0522R0, which defines the ‘at least as specialized as’ rules in terms of function template rewrite, leads to this confusion:

There is a historical rule which allows packs in the parameter to match non-packs in the argument side.

The template argument list deduction rules accept packs in parameters and no packs in arguments, while the reverse is rejected, but in order to accept both #1 and #2 from the first example, both directions need to be accepted. An exception had to be carved out in 13.4.4 [temp.arg.template]/3 for this historical rule.

We propose a solution which will restore the semantics of the second example, by specifying that during partial ordering, packs must match non-packs in only one direction.

Additionally, as a consequence of this exception, all implementations seem to reject combinations of the P0522 and historical rule affordances, which would otherwise be accepted individually, such as this example:

template<template<class, int, int...> class> struct A {};
template<class, char> struct B;
template struct A<B>;

Where there are packs in parameter side matching non-pack in argument side, and also matching of NTTPs of different type.

This is a very arbitrary restriction, and we propose to make it clear this is valid.

Now consider this last example:

template <template <class...    > class TT1> struct A      { static constexpr int V = 0; };
template <template <class       > class TT2> struct A<TT2> { static constexpr int V = 1; };
template <template <class, class> class TT3> struct A<TT3> { static constexpr int V = 2; };

template <class ...          > struct B;
template <class              > struct C;
template <class, class       > struct D;
template <class, class, class> struct E;

static_assert(A<B>::V == 0);
static_assert(A<C>::V == 1);
static_assert(A<D>::V == 2);
static_assert(A<E>::V == 0);

Before P0522R0, this is accepted.

After P0522R0, this became wholly invalid: The partial specializations are not more specialized than the primary template. Also, the A<B> specialization becomes ambiguous.

With the proposed solution, the primary template becomes less specialized again.

But the other issue will remain: The A<B> specialization will stay ambiguous. A solution to this last problem is left for future work.

4.1 Solution to #2

We propose changing the deduction rules such that, only during partial ordering, packs matching to non-packs isn’t accepted both ways, that it should only be accepted in the argument to parameter direction, which is the opposite direction it’s normally accepted in the deduction of template argument lists.

We also propose scratching the classic pack exception clause in 13.4.4 [temp.arg.template]/3, in favor of explicitly specifying that outside of partial ordering, packs matching to non-packs must be accepted both ways, parameter to argument as well as argument to parameter.

4.2 Wording to #2

Modify §13.10.3.6 13.10.3.6 [temp.deduct.type]/9:

9 If P has a form that contains <T>or, <i>, or <TTopt>, then each argument Pi of the respective template argument list of P is compared with the corresponding argument Ai of the corresponding template argument list of A. If the template argument list of P contains a pack expansion that is not the last template argument, the entire template argument list is a non-deduced context. If Pi is a pack expansion, then the pattern of Pi is compared with each remaining argument in the template argument list of A. Each comparison deduces template arguments for subsequent positions in the template parameter packs expanded by Pi. During partial ordering, if Ai was originally a pack expansion:

(9.1) - if P does not contain a template argument corresponding to Ai then Ai is ignored;

(9.2) - otherwise, if Pi is not a pack expansion, template argument deduction fails.

(9.1) Except when deducing the argument list of X as specified in 13.4.4 [temp.arg.template]/4, while checking deduced template arguments, if Pi is a pack expansion, then the pattern of Pi is compared with each remaining argument in the template argument list of A. Each comparison deduces template arguments for subsequent positions in the template parameter packs expanded by Pi. During partial ordering, if Ai was originally a pack expansion:

(9.1.1) - if P does not contain a template argument corresponding to Ai then Ai is ignored;

(9.1.2) - otherwise, if Pi is not a pack expansion, template argument deduction fails.

(9.2) When deducing the argument list of X as specified in 13.4.4 [temp.arg.template]/4, if Ai is a pack expansion, and there is at least one remaining argument in P, then the pattern of Ai is compared with each remaining argument in the template argument list of P. Each comparison deduces template arguments for subsequent positions in the template parameter packs expanded by Ai. If Pi was originally a pack expansion:

(9.2.1) - if A does not contain a template argument corresponding to Pi then Pi is ignored;

(9.2.2) - otherwise, template argument deduction fails.

[Note: (9.2) is the reverse of (9.1) - end note]

Modify §13.4.4 13.4.4 [temp.arg.template]/3:

3 A template-argument matches a template template-parameter P when P is at least as specialized as the template-argument A. In this comparison, if P is unconstrained, the constraints on A are not considered. If P contains a template parameter pack, then A also matches P if each of A’s template parameters matches the corresponding template parameter in the template-head of P. Two template parameters match if they are of the same kind (type, non-type, template), for non-type template-parameters, their types are equivalent (13.7.7.2 [temp.over.link]), and for template template-parameters, each of their corresponding template-parameters matches, recursively. When P’s template-head contains a template parameter pack (13.7.4 [temp.variadic]), the template parameter pack will match zero or more template parameters or template parameter packs in the template-head of A with the same type and form as the template parameter pack in P (ignoring whether those template parameters are template parameter packs).

Append note and example to §13.4.4 13.4.4 [temp.arg.template]/4:

[Note: 13.10.3.6 [temp.deduct.type]/9 has a special case for this deduction - end note]

[Example:

template<class T1> struct A;
template<template<class ...> class TT, class T> struct A<TT<T>>; // #1
template<template<class    > class TT, class T> struct A<TT<T>>; // #2

template<class> struct B;
template struct A<B<int>>; // selects #2

template <template <class...> class TT> struct C;
// This partial specialization is more specialized than the primary template.
template <template <class> class TT> struct C<TT>;

template <template <class> class TT> struct D;
// This partial specialization is NOT more specialized than the primary template.
template <template <class...> class TT> struct D<TT>;
  • end example]

[Example:

template<template<class, int, int...> class> struct A {};
template<class, char> struct B;

// OK, `int` matches 'char', pack matching non-pack is accepted.
template struct A<B>;
  • end example]

5 Acknowledgements

Many thanks to those who have reviewed, contributed suggestions, and otherwise helped the paper reach it’s current state: Arthur O’Dwyer, Corentin Jabot, James Touton, Richard Smith.

6 References

[CWG1286] Gabriel Dos Reis. 2011-04-03. Equivalence of alias templates.
https://wg21.link/cwg1286
[CWG2398] Jason Merrill. 2016-12-03. Template template parameter matching and deduction.
https://wg21.link/cwg2398
[P0522R0] James Touton, Hubert Tong. 2016-11-11. DR: Matching of template template-arguments excludes compatible templates.
https://wg21.link/p0522r0