A very interesting feature introduced in C++11 is called “variadic templates,” which, in short, are template classes and functions that can accept a variable number of parameterized types. They can be useful for several things, for example:
- Providing type-safe replacements for functions with a variable number of arguments (stdarg.h).
- Allowing the user to create instances of n-tuples.
- Creating type-safe containers with elements of various types.
This post takes a look at variadic template functions.
For example, consider a function called show() that accepts any number of parameters and displays them separated by whitespace.
Thus, the following calls would be valid:
show(1, 2, 3); // that would output 1 2 3
show("Today is", dayOfTheWeek); // that would output "Today is Tuesday"
show(p1, p2, p3, p4, p5);
In plain old C, a function with a similar, though not identical, signature could be implemented using the variable argument functions mechanism provided by C, along with the functions, types, and macros defined in the stdarg.h library. However, there are two problems with that approach:
- The number of arguments must be provided explicitly or implicitly. A good example of this is the C
printffunction. When declaring its signature, the number of format specifiers used implicitly defines the number of parameters that need to be accessed. For example,printf("%d %s", a, b);knows that there are two variables, andprintf("%d %d %d", x, y, z);knows that there are three. - The function is not type-safe in the sense that the programmer is responsible for determining the type of each variadic argument (that’s what the “%s” or “%d” in
printfare used for).
void show(int n, ...)
{
va_list x;
va_start(x, n);
for (int i = 0; i < n; i++)
{
// retrieve the parameter with va_arg and show it. There is no type info here.
}
va_end(x);
}
With the example above, since the type of each parameter after n is not specified, the supported types should be documented somehow; otherwise, the behavior will not be deterministic.
Before C++11, there were two partial solutions to this problem: one would be to create several overloaded functions, similar to this implementation:
template <typename T1>
void show(const T1& t1)
{
std::cout << t1 << std::endl;
}
template <typename T1, typename T2>
void show(const T1& t1, const T2& t2)
{
std::cout << t1 << " " << t2 << std::endl;
}
template <typename T1, typename T2, typename T3>
void show(const T1& t1, const T2& t2, const T3& t3)
{
std::cout << t1 << " " << t2 << " " << t3 << std::endl;
}
… and so on.
The other solution would be to have a base class (similar to the Java object model) and implement a method similar to this one:
void show(const Object* o1, const Object* o2 = nullptr, const Object* o3 = nullptr, const Object* o4 = nullptr, const Object* o5 = nullptr, const Object* o6 = nullptr)
{
std::cout << o1->toString() << " ";
if (o2)
std::cout << o2->toString() << " ";
if (o3)
std::cout << o3->toString() << " ";
if (o4)
std::cout << o4->toString() << " ";
if (o5)
std::cout << o5->toString() << " ";
if (o6)
std::cout << o6->toString() << " ";
std::cout << std::endl;
}
Though they would work, both approaches have their weaknesses. Both will support only a fixed number of arguments. In the first implementation, the programmer must provide N overloads to support N parameters, and in the second implementation, the programmer must provide a class hierarchy to make it work.
Variadic templates perform a type expansion similar to the template-based implementation (my first solution above), but this is done by the compiler instead of the programmer.
What is interesting about such expansion is that it is performed recursively.
This code implements the show function using variadic templates:
template <typename T>
void show(const T& value)
{
std::cout << value << std::endl;
}
template <typename U, typename... T>
void show(const U& head, const T&... tail)
{
std::cout << head << " ";
show(tail...);
}
The first overload will be the base case, where either a single parameter is passed to the show() method or when all the other overloads have already been expanded.
The second overload is very interesting because we declare a function that takes two elements: U and T. U represents a concrete type (the type of the element to be actually printed), while T represents a list of types (notice the ... syntax). The argument list of the function is also interesting: head will be a const reference to a value of type U, and ...tail will represent a set of const references to several types.
Now, look at the implementation. We take the head and display it using std::cout, and then invoke another overload of show() by passing the tail list of parameters The tail... syntax is called parameter pack expansion, and it is similar to taking all the arguments that tail represents and “expanding” them as individual parameters in the function call. At this point, if the list of parameters contains more than one type, the compiler will create a new overload for this method. If the list of parameters contains only one type, the compiler will invoke the first overload already defined.
Amazing, isn’t it?
This feature is heavily used in variadic template-based classes in the Standard Library, such as std::C++11: std::tuple and C++17: std::variant.