{"id":6126,"date":"2021-04-29T19:56:19","date_gmt":"2021-04-29T19:56:19","guid":{"rendered":"https:\/\/www.modernescpp.com\/index.php\/template-get-insight\/"},"modified":"2021-04-29T19:56:19","modified_gmt":"2021-04-29T19:56:19","slug":"template-get-insight","status":"publish","type":"post","link":"https:\/\/www.modernescpp.com\/index.php\/template-get-insight\/","title":{"rendered":"Templates – First Steps"},"content":{"rendered":"

The idea of this post is quite simple. I want to visualize templates and, in particular, the template instantiation process. Thanks to C++ Insights<\/a>, this visualization is pretty straightforward.<\/p>\n

<\/p>\n

\"templates\"<\/p>\n

Templates (class templates or function templates) are families of classes or functions. When you instantiate a template, you create a concrete class or a concrete function out of these families of classes or functions. Here are the first straightforward questions I want to answer. For simplicity reasons, I sometimes call a class template a generic class and a function template a generic function.<\/p>\n

When should I use a template?<\/h2>\n

You should use a template when your function or class stands for such a generic idea that this idea is not bound to a concrete type. For example, a function such as max <\/code>or a container such as vector<\/code> are usable for many types.<\/p>\n

How can I create a template?<\/h2>\n

I assume you have implemented a function max<\/code> accepting two ints.<\/p>\n

<\/p>\n

\n
int<\/span> max<\/span>(int<\/span> lhs, int<\/span> rhs) {\r\n    return<\/span> (lhs ><\/span> rhs)?<\/span> lhs :<\/span> rhs;\r\n}\r\n<\/pre>\n<\/div>\n
 Making a template out of the function is, in general straightforward.<\/p>\n
    \n
  1. Put the line template <typename T><\/code> before the function<\/li>\n
  2. Replace the concrete type int<\/code> with the type parameter T<\/code>.<\/li>\n<\/ol>\n
    <\/p>\n
    \n
    template<\/span> <<\/span>typename<\/span> T><\/span>              \/\/ (1)<\/span>\r\nT max(T lhs, T rhs) {              \/\/ (2)<\/span>\r\n    return<\/span> (lhs ><\/span> rhs)?<\/span> lhs :<\/span> rhs;\r\n}\r\n<\/pre>\n<\/div>\n
    I have to mark two additional remarks. First, instead of the name typename<\/code>, you can also use class<\/code>. I strongly suggest typename<\/code>, because T <\/code>must not be a class but <\/code>can be a  type, a non-type, or a template. Second, by convention, we use T<\/code> as the name for the first type parameter.<\/p>\n
    The same procedure also works when transforming a class into a template.<\/p>\n
    Now I have come to precisely the point where C++ Insights<\/a>, provides me with valuable services.<\/p>\n<\/p>\n
    What happens when I instantiate a template?<\/h2>\n
    Let instantiate the function template max for int<\/code> and double<\/code>.<\/p>\n
    <\/p>\n
    \n
    template<\/span> <<\/span>typename<\/span> T><\/span>\r\nT max(T lhs, T rhs) {\r\n    return<\/span> (lhs ><\/span> rhs)?<\/span> lhs :<\/span> rhs;\r\n}\r\n\r\nint<\/span> main() {\r\n  \r\n    max(10<\/span>, 5<\/span>);\r\n    max(10.5<\/span>, 5.5<\/span>);\r\n  \r\n}\r\n<\/pre>\n<\/div>\n
     C++ Insights<\/a> provides a deeper insight into this automatic process of template instantiation:<\/p>\n
    \"functionTemplateInstantiation\"<\/p>\n
    The process of template instantiation creates lines 6 – 23. Let me write a few words about the instantiation of the function max<\/code> for the two ints (lines 6 – 13). Line 6 in the screenshot expresses that line 8 in the source file (max(10, 5)<\/code>) causes the generation of lines 6 – 13. I assume the first two lines of the compiler-generate code are the most interesting ones.<\/p>\n
    <\/p>\n
    \n
    template<\/span><><\/span>\r\nint<\/span> max<<\/span>int<\/span>><\/span>(int<\/span> lhs, int<\/span> rhs)\r\n{\r\n  return<\/span> (lhs ><\/span> rhs) ?<\/span> lhs :<\/span> rhs;\r\n}\r\n<\/pre>\n<\/div>\n
    max<\/code> is a fully specialized function template for int: max<int><\/strong><\/code>.  The generic part is empty: template<><\/code>. The compiler generates out of the family of max<\/code>-functions one concrete function for int<\/code>. Does this also mean that the compiler generates a concrete function for each used type?<\/p>\n
    What happens, when I instantiate a template more than once for the same type?<\/h2>\n
    My next example is based on class templates. Here is a simple container two times instantiated for int<\/code>.<\/p>\n
    <\/p>\n
    \n
    template<\/span> <<\/span>typename<\/span> T, int<\/span> N><\/span>\r\nclass<\/span> Array<\/span>{\r\n public:<\/span>\r\n    int<\/span> getSize() const<\/span>{\r\n        return<\/span> N;\r\n    }\r\n private:<\/span>\r\n    T elem[N];\r\n};\r\n\r\nint<\/span> main<\/span>() {\r\n  \r\n    Array<<\/span>int<\/span>, 5<\/span>><\/span> myArr1;  \/\/ (1)<\/span>\r\n    Array<<\/span>int<\/span>, 10<\/span>><\/span> myArr2; \/\/ (2)<\/span>\r\n    Array<<\/span>int<\/span>, 5<\/span>><\/span> myArr3;  \/\/ (3)<\/span>\r\n  \r\n}\r\n<\/pre>\n<\/div>\n
    I instantiated two times Array<int, 5><\/code> (lines (1) and (3)) and one time Array<int, 10><\/code> (line 2). When you study the output of C++ Insights<\/a>, you recognize that the second instantiation of Array<int, 5><\/code> (line 3) uses the first instantiation already triggered by line (1). Here are the relevant parts of the output.<\/p>\n
    \"classTemplateInstantiation\"<\/p>\n
     <\/p>\n
    Are we done with this example? No! There are two additional exciting observations I want to make.<\/p>\n
    First, the process of template instantiation is lazy. Second, I use a non-type template parameter.<\/p>\n
    Template instantiation is lazy<\/h3>\n
    Did you recognize that the member function getSize<\/code>() was not instantiated? Only the declaration of the member function is available. The process of template instantiation is lazy. Meaning if you don’t need it will not be instantiated. This works fine so far that you can use invalid code in a member function. Of course, the member function must not be called. If you don’t believe me, compile the following small program. First, disable line (1), and second, enable line (1).<\/p>\n
    <\/p>\n
    \n
    \/\/ number.cpp<\/span>\r\n\r\n#include <cmath><\/span>\r\n#include <string><\/span>\r\n\r\ntemplate<\/span> <<\/span>typename<\/span> T><\/span>\r\nstruct<\/span> Number {\r\n\tint<\/span> absValue() {\r\n        return<\/span> std::<\/span>abs(val);\r\n    }\r\n  T val{};\r\n};\r\n\r\nint<\/span> main<\/span>() {\r\n  \r\n    Number<<\/span>std::<\/span>string><\/span> numb;\r\n    \/\/ numb.absValue();       \/\/ (1)<\/span>\r\n  \r\n}\r\n<\/pre>\n<\/div>\n
    Let’s go back to my previous program and invoke getSize()<\/code>. Here is the modified main<\/code> program.<\/p>\n
    <\/p>\n
    \n
    int<\/span> main<\/span>() {\r\n  \r\n    Array<<\/span>int<\/span>, 5<\/span>><\/span> myArr1;  \r\n    Array<<\/span>int<\/span>, 10<\/span>><\/span> myArr2; \r\n    Array<<\/span>int<\/span>, 5<\/span>><\/span> myArr3;  \r\n    myArr3.getSize();     \/\/ (1)<\/span>\r\n  \r\n}\r\n<\/pre>\n<\/div>\n
     Accordingly, the following screenshot shows the compiler-generated code for the member function getSize()<\/code> (lines 18 – 21).<\/p>\n
    \"classTemplateGetSize\"<\/p>\n
     <\/p>\n
    int<\/code> as a non-type template parameter<\/h4>\n
    I used in this example two type-parameters in the second one is, in particular, an int. int <\/code>is an example of a non-type template parameter. Besides int<\/code>, you can use all integral types, floating-point types (C++20), pointers, or references as non-type template parameters. What happens when I instantiate two arrays of different lengths?<\/p>\n
    <\/p>\n
    \n
    template<\/span> <<\/span>typename<\/span> T, int<\/span> N><\/span>\r\nclass<\/span> Array<\/span>{\r\n public:<\/span>\r\n    int<\/span> getSize() const<\/span>{\r\n        return<\/span> N;\r\n    }\r\n private:<\/span>\r\n    T elem[N];\r\n};\r\n\r\nint<\/span> main<\/span>() {\r\n  \r\n    Array<<\/span>float<\/span>, 5<\/span>><\/span> myArr1;\r\n    Array<<\/span>float<\/span>, 10<\/span>><\/span> myArr2;\r\n  \r\n}\r\n<\/pre>\n<\/div>\n
     You probably guessed it. Two arrays are instantiated. Here is the crucial output from C++ Insights<\/a><\/p>\n
    \"classTemplateTwoInts\"<\/p>\n
    This means that both instantiations use different int<\/code> values create different types.<\/p>\n
    What’s next<\/h2>\n
    After these first steps with templates, I make, in my next post, <\/a>a deep dive into function templates.<\/p>\n
     <\/p><\/p>\n","protected":false},"excerpt":{"rendered":"
    The idea of this post is quite simple. I want to visualize templates and, in particular, the template instantiation process. Thanks to C++ Insights, this visualization is pretty straightforward.<\/p>\n","protected":false},"author":21,"featured_media":6121,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[376],"tags":[],"class_list":["post-6126","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-templates"],"_links":{"self":[{"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/posts\/6126","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/users\/21"}],"replies":[{"embeddable":true,"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/comments?post=6126"}],"version-history":[{"count":0,"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/posts\/6126\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/media\/6121"}],"wp:attachment":[{"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/media?parent=6126"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/categories?post=6126"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.modernescpp.com\/index.php\/wp-json\/wp\/v2\/tags?post=6126"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}