{"id":108259,"date":"2023-05-29T07:00:00","date_gmt":"2023-05-29T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=108259"},"modified":"2023-05-29T18:19:50","modified_gmt":"2023-05-30T01:19:50","slug":"20230529-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20230529-00\/?p=108259","title":{"rendered":"On writing functions that accept any specialization of a C++ template type"},"content":{"rendered":"

Suppose you want to write a template function that accepts any specialization of std::vector<\/code>. Your first try would probably be something like this:<\/p>\n

template<typename Value>\r\nvoid accept_any_vector(std::vector<Value> v);\r\n<\/pre>\n
However, this does not actually accept any vector specialization. There is a second template argument for the allocator, which has a default value that nearly everyone uses. But if somebody has a vector with a custom allocator, then your function won’t match.<\/p>\n
Okay, so add an allocator, too.<\/p>\n
template<typename Value, typename Allocator>\r\nvoid accept_any_vector(std::vector<Value, Allocator> v);\r\n<\/pre>\n
This works today, but it may not work tomorrow.<\/p>\n
A future version of std::vector<\/code>  might add new template arguments<\/a>, provided that they have suitable defaults that preserve existing behavior.\u00b9 We don’t want that future version to break us, so we should slurp up all the template arguments that exist:<\/p>\n
template<typename...Args>\r\nvoid accept_any_vector(std::vector<Args...> v);\r\n<\/pre>\n
Now, once we’ve accepted any kind of vector, we have lost the template parameters that name the value type and allocator. You might think you could rescue them by naming them and putting all the future nonsense in the variadic portion:<\/p>\n
template<typename Value, typename Allocator, typename...Extra>\r\nvoid accept_any_vector(std::vector<Value, Allocator, Extra...> v);\r\n<\/pre>\n
However, this doesn’t work:<\/p>\n
\/\/ msvc\r\nerror C2977: 'std::vector': too many template arguments\r\n\r\n\/\/ clang\r\nerror: too many template arguments for class template 'vector'\r\n\r\n\/\/ icc\r\nerror: too many arguments for class template \"std::vector\"\r\n\r\n\/\/ gcc\r\n(no errors)\r\n<\/pre>\n
Fortunately, you can recover the Value<\/code> and Allocator<\/code> from std::vector<Args...><\/code> because std::vector<\/code> lets you access the underlying type and allocator through member types.<\/p>\n
template<typename...Args>\r\nvoid accept_any_vector(std::vector<Args...> v)\r\n{\r\n    using vector = std::vector<Args...>;\r\n    using Value = typename vector::value_type;\r\n    using Allocator = typename vector::allocator_type;\r\n\r\n    ...\r\n}\r\n<\/pre>\n
C++ standard library types generally provide these member types to allow you to recover the template type arguments from the type. Other libraries are hit or miss.<\/p>\n
\u00b9 The standard also permits functions to accept default parameters or have additional default template arguments.\u00b2 This is used primarily for SFINAE purposes, so that some overloads become removed from consideration if particular requirements are not met. The standard has the concept of “addressable functions”, which are the functions that the standard guarantees will never be overloaded or have a signature different from the one printed in the standard.<\/p>\n
\u00b2 We ran afoul of this issue in an April Fool’s article about  invoke-oriented programming<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
There are the obvious arguments, the non-obvious arguments, and the invisible arguments.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-108259","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
There are the obvious arguments, the non-obvious arguments, and the invisible arguments.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/108259","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=108259"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/108259\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=108259"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=108259"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=108259"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}