Skip to main content

Variadic template function - Part 1

 In C, we know we have something called printf() function. This printf() function can take any number of arguments of any built-in type (not user-defined type). As an example, the following piece of code is valid for the standard built-in printf() function.

<Code>

const char* msg = "%s can accept %i parameters (or %s).";
printf(msg, std::string("Variadic templates"), 100, "more");

</Code>

The problem in this code is, it will not print the string part, but it gets compiled with the MSVC as well as GCC 8.2 compiler.

However, if I change the code like below, now it prints everything properly.

<Code>

const char* msg = "%s can accept %i parameters (or %s).";
printf(msg, std::string("Variadic templates").c_str(), 100, "more");

</Code>

The printf is like a variadic template function but it sticks to only built-in types. Now the question comes how can I write variadic template functions in C++. In C++ 11 the support has been added.

Let's start with a simple objective, which is to create a function that takes any arbitrary number of parameters of any arbitrary type and just prints them on the screen. As an example, the function shall look like below: 

PrintAllTypes(1, 'C', "Hello World", 0.67, 1.002);

Here goes the code for PrintAllTypes:

<Code>
void PrintAllType() { std::cout << "\n"; } /* This is the base case */

template<typename T, typename... Rest>
void PrintAllType(const T& current, const Rest&... rest) {
    std::cout << current << " ";
    PrintAllType(rest...); // This is a recursive call using pack expansion syntax
}
</Code>

Below is another variant of Print that takes any number of parameters but is limited to numbers only.

<Code>
void Print() { std::cout << "\n"; } /* This is the base case */

template <typename T, 
    typename std::enable_if<std::is_arithmetic<T>::value>::type* = nullptr, typename... Rest>
void Print(const T& current, const Rest&... rest) {
    std::cout << current << " ";
    Print(rest...); // Again, this is a recursive call using pack expansion syntax
}
</Code>

Let's try the addition of numbers via the variadic template function:

<Code>
template <typename T>
auto AddGeneric(T& t)
{
    return t;
}

template<typename T, typename... Rest, 
    typename std::enable_if<std::is_arithmetic<T>::value>::type* = nullptr>
auto AddGeneric(T& current, Rest&... rest)
{
    return current + AddGeneric(rest...);
}

// The Client code:
    int x = 10, y = 20; double dbl = 5.5;
    auto res = AddGeneric(x, dbl, y);
    PrintAllType("Add Result: ", res);
</Code>

The output: 
Add Result: 35.5

What if I have a number array and I need to use that array as an argument in a variadic function. One possibility could be using a functor to unpack the array and then use it for a variadic function. 

<Code>
template <typename T>
auto AddGeneric(T& t)
{
    return t;
}

template<typename T, typename... Rest, 
    typename std::enable_if<std::is_arithmetic<T>::value>::type* = nullptr>
auto AddGeneric(T& current, Rest&... rest)
{
    return current + AddGeneric(rest...);
}

/* Array passed to a variadic function. With the help of a functor unpacking the array */
template<typename Functor, typename T, std::size_t N>
auto AdditionByArray(Functor fn, T(&t)[N])
{
    return AdditionByArrayImpl(fn, t, std::make_index_sequence<N>{});
}

template<typename F, typename T, std::size_t N, std::size_t... idx>
auto AdditionByArrayImpl(F fn, T(&t)[N], std::index_sequence<idx... >)
{
    return fn(t[idx]...);
}

struct AddSupli
{
    template <typename... Arguments>
    auto operator()(Arguments... args)
    {
        return AddGeneric(args...); // This is same recursive call
    }
};
</Code>

So far so good. Will come back to this topic later.
Labels:

Comments

Post a Comment

Popular posts from this blog

XOR (Exclusive OR) for branchless coding

The following example shows the array reversing using the  XOR operator . No need to take any additional variable to reverse the array.   int main(int argc, _TCHAR* argv[]) { char str[] = "I AM STUDENT"; int length = strlen(str); for(int i = 0; i < ((length/2)); i++) { str[i] ^= str[length - (1+i)]; str[length - (1+i)] ^= str[i]; str[i] ^= str[length - (1+i)]; } cout << str << endl; return 0; } The above example is one of the uses of XOR but XOR comes in handy when we can do branchless coding  methods like butterfly switch etc. Sometimes this is very effective in speeding up the execution.  Let's see one of the uses of XOR in branchless coding. I am taking a simple example of Y = | X |.  Yes, I am generating abs of a supplied number. So, my function signature/definition in C++ looks like below: int absoluteBranch( int x) {     if (x < 0 ) {         return ...
1 comment
Read more

Power of Two

  I n this post will be discussing how to calculate if a number is a power of two or not. As an example, 8 is a power of two but the number 10 is not. There are many ways we can solve this. First , we will take an approach which is simple and iterative. In this case, we will calculate the power of two one by one and check with the supplied number. The below code illustrates it. bool isPowerofTwo(unsigned num) { auto y = 1; while (0 != y) { if (num == y) return true; if (num < y) return false; y <<= 1; } return false; } Second , assuming, the number is a 32-bit number, this is also an iterative solution. In this scenario, iterating all bits and counting the set bits. Any number which is a power of 2 will have only one bit set and the rest will be zeros. As an example, 8 in binary representation is 1000. Using this observation, we can implement an iterative solution. bool isPowerofTwo(unsigned num) { auto one_count = 0; for (auto index = 0; index < ...
Post a Comment
Read more

Reversing char array without splitting the array to tokens

 I was reading about strdup, a C++ function and suddenly an idea came to my mind if this can be leveraged to aid in reversing a character array without splitting the array into words and reconstructing it again by placing spaces and removing trailing spaces. Again, I wanted an array to be passed as a function argument and an array size to be passed implicitly with the array to the function. Assumed, a well-formed char array has been passed into the function. No malformed array checking is done inside the function. So, the function signature and definition are like below: Below is the call from the client code to reverse the array without splitting tokens and reconstructing it. Finally, copy the reversed array to the destination.  For GNU C++, we should use strdup instead _strdup . On run, we get the following output: Demo code
Post a Comment
Read more