Sunday, 11 June 2017

c++ - Why can templates only be implemented in the header file?




Quote from The C++ standard library: a tutorial and handbook:




The only portable way of using templates at the moment is to implement them in header files by using inline functions.




Why is this?



(Clarification: header files are not the only portable solution. But they are the most convenient portable solution.)



Answer



It is not necessary to put the implementation in the header file, see the alternative solution at the end of this answer.



Anyway, the reason your code is failing is that, when instantiating a template, the compiler creates a new class with the given template argument. For example:



template
struct Foo
{
T bar;
void doSomething(T param) {/* do stuff using T */}

};

// somewhere in a .cpp
Foo f;


When reading this line, the compiler will create a new class (let's call it FooInt), which is equivalent to the following:



struct FooInt
{

int bar;
void doSomething(int param) {/* do stuff using int */}
}


Consequently, the compiler needs to have access to the implementation of the methods, to instantiate them with the template argument (in this case int). If these implementations were not in the header, they wouldn't be accessible, and therefore the compiler wouldn't be able to instantiate the template.



A common solution to this is to write the template declaration in a header file, then implement the class in an implementation file (for example .tpp), and include this implementation file at the end of the header.



// Foo.h

template
struct Foo
{
void doSomething(T param);
};

#include "Foo.tpp"

// Foo.tpp
template

void Foo::doSomething(T param)
{
//implementation
}


This way, implementation is still separated from declaration, but is accessible to the compiler.






Another solution is to keep the implementation separated, and explicitly instantiate all the template instances you'll need:



// Foo.h

// no implementation
template struct Foo { ... };

//----------------------------------------
// Foo.cpp


// implementation of Foo's methods

// explicit instantiations
template class Foo;
template class Foo;
// You will only be able to use Foo with int or float


If my explanation isn't clear enough, you can have a look at the C++ Super-FAQ on this subject.


No comments:

Post a Comment

c++ - Does curly brackets matter for empty constructor?

Those brackets declare an empty, inline constructor. In that case, with them, the constructor does exist, it merely does nothing more than t...