Einführung in die Programmierung mit Templates



  • In diesem Artikel versuche ich, einen kleinen Einblick in die Welt der generischen Programmierung mit Templates in C++ zu geben.

    Inhalt:

    • 1 Einführung
    • 2 Die Compiler-Frage
    • 3 Definition von Templates
    • 3.1 Funktions-Templates
    • 3.2 Klassen-Templates
    • 4 Übergabe von Argumenten
    • 5 Überladen (Spezialisierung) von Funktions-Templates
    • 6 Vollständige/Partielle Spezialisierung von Klassen-Templates
    • 7 Das Schlüsselwort export
    • 8 Zum Schluss...

    1 Einführung

    Wem ging das nicht schon mal so: Eine (ähnliche, ja fast gleiche) Funktion oder Klasse musste mehrfach implementiert werden, weil wir sie für verschiedene Typen einsetzen wollten. Das Paradebeispiel sind Container-Klassen wie Listen: Einmal brauchen wir eine für int, dann eine für std::string und schließlich noch eine für unsere eigenen Klassen. Jedesmal eine Liste speziell für einen Typ zu schreiben, das wäre sehr zeitaufwändig und auch mühsam, abgesehen davon würden sich wahrscheinlich Fehler einschleichen, da viel mit Copy & Paste gearbeitet würde. Glücklicherweise bietet uns C++ aber ein Werkzeug an, mit dem wir "typunabhängig" programmieren können: Templates! Praktisch die gesamte C++-Standardbibliothek besteht aus Templates, angefangen bei std::string über std::vector bis zu den vielen Algorithmen wie std::copy oder std::find.

    2 Die Compiler-Frage

    Der immer noch sehr weitverbreitete und veraltete "VC++ 6"-Compiler ist leider nicht besonders gut für die (insbesondere fortgeschrittene) Template-Programmierung geeignet, für ein vernünftiges Arbeiten ist mindestens der VC 7.1 notwendig. Mit einem aktuellen g++ ist man auch auf der sicheren Seite.

    Normale Templates wie Container sind für den VC++ 6 kein Problem, aber bei komplizierteren Deklarationen streikt er ziemlich schnell. Folgende, von evilissimo vorgeschlagene, Template-Klasse wird der VC++ 6 mit vielen Fehlermeldungen quittieren, obwohl der Code korrekt ist (im Extremfall kann der Compiler abstürzen):

    template < template < typename A , typename B , template < typename D > class C > class A >
    struct BreakCompilerBack{};
    

    Im Übrigen ist selbst der sehr gute g++ nicht unverwundbar. Es gibt einige Sachen, die der Compiler einfach (noch) nicht verträgt. Gerade SFINAE (Substitution failure is not an error) ist sehr tödlich für einige Compiler.

    Wir empfehlen das VS 2008 Express Edition zu benutzen. Beide lassen sich nach einer Registrierung kostenlos bei Microsoft herunterladen. Gerade als Anfänger hat man keinen Grund, noch mit dem veralteten VC++ 6 zu beginnen, sondern sollte gleich mit einer neueren, besseren Version in die C++-Programmierung einsteigen. Die neuen Compiler werden sich auch abseits des Template-Schlachtfelds positiv mit schnellerem und besserem Code bemerkbar machen.
    Ich habe die Beispiele alle mit dem g++ 3.3.6 problemlos kompilieren können. Man sollte sich im Übrigen von den "umfangreichen" Fehlermeldungen des Compilers bei Templates nicht einschüchtern lassen, auch wenn sie zu Beginn kaum lesbar erscheinen, mit der Zeit gewöhnt man sich daran.

    3 Definition von Templates

    Und los geht's: Um dem Compiler mitzuteilen, dass man ein Template definieren möchte, bedient man sich folgendem Präfix, welches einer Funktion oder Klasse vorangestellt wird:

    template <class T>
    //oder: template <typename T>
    

    T stellt einen Parameter mit einem beliebigen Typ dar, und obwohl hier das Schlüsselwort class steht, kann man auch char oder double einsetzen. Das Schlüsselwort typename ist gleichwertig mit class, allerdings kann man die Verwendung von beiden wie folgt einteilen: typename wird verwendet, wenn ein built-in oder eine Klasse als Parameter kommen kann, class wird benutzt, wenn ausschließlich Klassen erwartet werden. Diese Einteilung dient nur der Übersichtlichkeit und hat sonst keine Auswirkungen.

    Selbstverständlich kann man auch mehrere Template-Parameter angeben:

    //Zwei Parameter, einer vom Typ T und einer vom Typ U
    template <class T, class U>
    ...
    
    template <class T, int number> //Ein Parameter vom Typ T und einer vom Typ int
    ...
    

    Für "nicht-Typ-Parameter", also built-ins, gelten folgende Einschränkungen:

    1. Sie dürfen nicht verändert werden
    2. Sie dürfen nur ganzzahlig sein

    Im Übrigen werden built-ins als Konstanten behandelt, auf diesem Wege könnten wir z.B. bei einem Array<T, int> Klassen-Template die Größe festlegen.

    Es ist jedoch möglich, Referenzen oder Zeiger auf Gleitpunkt-Typen als Parameter anzugeben:

    template <class T, float &f>
    ...
    

    Außerdem kann man den Parametern, wie gewohnt, Default-Werte geben:

    //FastCopy ist irgendeine Klasse
    template <class T=FastCopy, int number=10>
    ...
    

    Hierbei gelten die gleichen Regeln wie bei normalen Default-Parametern:

    1. Wenn ein Parameter einen Default-Wert bekommt, so müssen alle nachfolgenden Parameter einen bekommen
    2. Wird bei der Instanzierung ein Argument weggelassen, so müssen alle nachfolgenden Argumente weggelassen werden

    3.1 Funktions-Templates

    Früher, als die Gummistiefel noch auch Holz waren 😉 , war min ein äußerst beliebtes und bekanntes Makro, um den kleineren von zwei Werten herauszufinden:

    #include <iostream>
    
    #define MIN(a,b) ((a<b)? a:b)
    
    using namespace std;
    
    int main (int argc, char **argv) {
      int x=5,y=6;
    
      int z = MIN(x,y);
      cout<<z<<'\n';  //Gibt 5 aus
      return EXIT_SUCCESS;
    };
    

    Das war in C vielleicht noch gut, aber in C++ haben wir Templates, um solche Dinge sauber zu implementieren (die STL enthält bereits eine Template-Funktion namens min):

    #include <iostream>
    
    //Ermittelt das Minimum aus a und b
    template <typename T>
    inline const T& minimum(const T &a, const T &b) {
      return a < b ? a:b;
    };
    
    int main (int argc, char **argv) {
      int x=5, y=6;
    
      //Explizite Instanzierung (siehe "Übergabe von Argumenten"):
      int z = minimum<int>(x,y);
      std::cout<<z<<'\n';
    
      //Funktioniert auch für chars:
      char a = 'a', b = 'b';
    
      //Implizite Instanzierung (siehe "Übergabe von Argumenten"):
      std::cout<<minimum(a,b)<<'\n';  //Gibt a aus
    
      return EXIT_SUCCESS;
    };
    

    Das Funktions-Template minimum hat zwei Parameter vom Typ Referenz auf const-T und als Rückgabewert ebenfalls eine Referenz auf const-T. Was T ist bzw. später mal sein wird, das interessiert uns nicht. Das braucht nur der Aufrufer zu wissen.

    Der Maschinencode für ein Funktions-Template wird bei der ersten Instanzierung für einen Typ erzeugt, bei der Definition selber wird nichts erzeugt. So wird im obigen Beispiel zuerst eine Funktion für den Typ int erzeugt, und dann noch eine weitere für den Typ char. Vereinfacht gesagt geht der Compiler hin und setzt für jedes T den von uns gewählten Typ ein.

    Vom Compiler werden Templates zweimal auf Fehler überprüft: zuerst beim Kompilieren der Template-Definition und dann noch einmal bei der Instanzierung. Beim ersten Drübergehen werden typunabhängige Fehler (z.B. Syntaxfehler) erkannt. Fehler, die vom Typ abhängen, z.B. ein fehlender Operator des Typs, werden dann beim zweiten Mal angezeigt.

    3.2 Klassen-Templates

    Da es möglich ist, Funktions-Templates zu bilden, muss es auch möglich sein, ein Klassen-Template zu erstellen. Am Beispiel der Klasse Pair (die STL enthält bereits ein Klassen-Template namens pair), die ein Wertepaar darstellt, werden wir uns dies anschauen:

    #include <iostream>
    #include <string>
    
    //Diesmal zwei Parameter, U ist per default gleich T
    template <typename T, typename U=T>
    struct Pair {
      //Zwei Datenelemente
      T first;
      U second;
    
      Pair(const T &a, const U &b) : first(a), second(b) {}
      Pair(const Pair &p) : first(p.first), second(p.second) {}
      ~Pair() {}
    
      Pair& operator=(const Pair&);
    };
    
    //Definition außerhalb der Klasse:
    template <typename T, typename U>
    Pair<T,U>& Pair<T,U>::operator=(const Pair<T,U> &p) {
      if (this == &p)
        return *this;
    
      first = p.first;
      second = p.second;
      return *this;
    };
    
    int main (int argc, char **argv) {
      //Wir bilden ein Paar vom Typ float:
      Pair<float> floatPair(5.1,8.9);
      std::cout<<floatPair.first<<'\t'<<floatPair.second<<'\n';
    
      //Erster Parameter ist ein string, der zweite ein int:
      Pair<std::string, int> mixPair("zwanzig", 20); 
      std::cout<<mixPair.first<<'\t'<<mixPair.second<<'\n';
    
      return EXIT_SUCCESS;
    };
    

    Bei der ersten Instanzierung von Pair wird zuerst der Maschinencode aller Methoden generiert (die Methoden der Klasse Pair sind im Grunde nur Funktions-Templates), und erst dann das Objekt floatPair aufgebaut. Der Maschinencode von mixPair unterscheidet sich im Übrigen von dem Maschinencode von floatPair!
    Hier wird auch deutlich, dass wir mit Templates den Maschinencode nicht reduzieren, aber sehr wohl das Duplizieren von Sourcecode vermeiden können.
    Außerdem sollte man sich vor Augen führen, dass Templates, bedingt durch ihre Natur, sehr statische Konstrukte sind.

    Verwendung finden Templates auch bei der Implementierung von Container-Klassen wie einem Stack, gerade hier kann man durch Verwendung von Templates richtig Zeit einsparen, anstatt einen IntStack, einen CharStack usw. zu schreiben, schreibt man eine Template-Klasse:

    template <typename T>
    class Stack {
    public:
      Stack(size_t);
      Stack(const Stack&);
      ~Stack();
    
      void push(const T&);
      T pop();
    
      const T& peek() const;
    
      void clear();
      bool empty() const;
    
      Stack& operator=(const Stack&);
    
    private:
      T *arr;
      size_t sz, tip;
    };
    

    4 Übergabe von Argumenten

    Bei der Übergabe von Argumenten an Templates gibt es einige Regeln, die man unbedingt kennen sollte:

    Die Typen der Argumente müssen exakt mit den Typen der Template-Parameter übereinstimmen, bei einer impliziten Instanzierung findet nicht einmal eine, sonst übliche, implizite Konvertierung wie z.B. von int nach long statt:

    long l=7;
    int i=8;
    
    //minimum Template von oben, ein long und ein int
    cout<<minimum(l,i)<<'\n';  //Implizit: Eeeh, Fehler!
    cout<<minimum<long>(l,i)<<'\n';  //Explizit: Funktioniert!
    

    Bei der expliziten Instanzierung kann man den gewünschten Typ angeben und es wird eine Typumwandlung durchgeführt. Die explizite Instanzierung ist ebenfalls notwendig, wenn der Typ nicht als Parameter einer Funktion erscheint, sondern nur intern verwendet wird:

    template <typename T>
    void foo() {
      T tmp;
      //...
    };
    
    //Explizite Instanzierung notwendig!
    foo<int>();
    

    Für Template-Argumente gibt es wiederum einige Einschränkungen, diese gelten aber nur für built-ins:

    1. Ist der Parameter ein Zeiger, so dürfen nur Adressen mit globalem Geltungsbereich übergeben werden
    2. Ist der Parameter eine Referenz, so dürfen nur Objekte mit globalem oder statischem Geltungsbereich übergeben werden
    3. Ist der Parameter weder Referenz noch Zeiger, so dürfen nur konstante Werte übergeben werden

    5 Überladen (Spezialisierung) von Funktions-Templates

    Manchmal passiert es, dass ein Template für einen bestimmten Typ kein vernünftiges Ergebnis liefert oder eine spezialisierte Funktion effizienter arbeiten könnte. Unser minimum-Template funktioniert z.B. für int ganz ausgezeichnet, aber was ist mit C-Strings? Da würde unser Template versagen bzw. einfach den C-String mit der kleineren Adresse zurückgeben, nicht gerade das, was wir wollen:

    #include <iostream>
    #include <cstring>
    
    using namespace std;
    
    //Ermittelt das Minimum aus a und b
    template <typename T>
    inline const T& minimum(const T &a, const T &b) {
      return a < b ? a:b;
    };
    
    //Überladung für C-Strings
    inline const char* minimum(const char *str1, const char *str2) {
      return ( (strcmp(str1,str2) < 0 ) ? str2 : str1 );
    };
    
    int main (int argc, char **argv) {
      //Aufruf der "normalen" Template-Funktion
      cout<<minimum(8,10)<<'\n';  
    
      //Aufruf der überladenen Funktion
      cout<<minimum("HALLO", "hallo")<<'\n';
    
      return EXIT_SUCCESS;
    };
    

    Wir haben jetzt die Funktion minimum überladen, um unser Ziel zu erreichen.
    Es gibt aber noch eine andere Möglichkeit: Das Spezialisieren des Funktions-Templates. Das Spezialisieren unterscheidet sich vom Überladen, denn die überladene Funktion von oben ist eine ganz gewöhnliche Funktion. Spezialisiert man die Funktion jedoch, hat man eine "echte" Template-Funktion:

    //Generische Implementierung
    template <typename T>
    void func(T param) {
      //mach was mit param
    };
    
    //Spezialisierte Implementierung für int
    template < >
    void func(int param) {
      //mach was mit param
    };
    

    Wer sich näher für die exakten Unterschiede interessiert, dem empfehle ich Abschnitt 14.5.5 fortfolgend im C++ Standard. Dort sind auch einige Beispiele aufgeführt. In diesem Zusammenhag ist der Artikel Why not specialize function templates? ebenfalls sehr interessant. Vielen Dank an tommie-lie für diesen Link.

    Es kann durchaus vorkommen, dass eine ganze Reihe an Funktionen mit dem gleichen Namen umherschwirrt. Der Compiler geht bei der Auswahl der passenden Funktion folgendermaßen vor:

    1. Findet der Compiler eine normale Funktion, die er ohne Typumwandlung aufrufen kann, so wird diese aufgerufen
    2. Wenn es ein spezialisiertes Template (zusätzlich zu der generischen Implementierung) gibt, dann nimmt der Compiler immer dieses, gibt es mehrere spezialisierte Templates, so wählt er das am meisten Spezialisierte aus
    3. Konnte keine passende Funktion gefunden werden, so werden normale Funktionen überprüft, bei denen Typumwandlungen zum Erfolg führen

    Wird keine oder mehrere passende Funktion(en) gefunden, ist dies ein Fehler.

    Nun ist die überladene Version von minimum aber eine gewöhnliche Funktion, d.h. es wird sobald der Header von mehreren Sourcefiles eigebunden wird, Linkerfehler wegen mehrfacher Definition von minimum hageln.
    Um dies zu vermeiden, sollten wir die Funktion in eine Implementationdatei auslagern. Des Weiteren könnten wir sie inline oder static klassifizieren oder wir betten sie in einen (anonymen) namespace ein. Die namespace-Variante hat allerdings den Nachteil, dass minimum in mehreren Objektdateien präsent ist.

    6 Vollständige/Partielle Spezialisierung von Klassen-Templates

    Manchmal ist es wichtig, dass eine Template-Klasse bei einer gewissen Kombination der Typ-Parameter etwas ganz Spezielles tut, dies erreicht man durch die partielle bzw. vollständige Spezialisierung von Template-Klassen. Partielle Spezialisierung von Funktionen ist nicht möglich.

    Bevor wir die partielle Spezialisierung sehen, zuerst eine vollständige Spezialisierung der Pair-Klasse:

    #include <iostream>
    
    template <typename T, typename U=T>
    struct Pair {
      //wie oben
    };
    
    struct MyServer {};
    struct MyClient {};
    
    //MyServer und MyClient sind hier irgendwelche Klassen, für die das Template
    //vollständig spezialisiert wird:
    template <>
    struct Pair<MyServer, MyClient> {
      Pair() { std::cout<<"Vollstaendige Spezialisierung aufgerufen!"<<'\n'; }
      //...
    };
    
    int main(int argc, char **argv) {
      Pair<MyServer, MyClient> myPair;  //Instanzierung des Templates
    
      return EXIT_SUCCESS;
    };
    

    Wenn wir jetzt also die Klasse Pair mit diesen speziellen Parametern, nämlich MyServer und MyClient, aufrufen, dann wird das spezialisierte Template benutzt. Andernfalls wird die generische Implementierung verwendet.

    Kommen wir nun zu der partiellen Spezialisierung, bei der es (mal wieder) ein paar Regeln zu beachten gilt:

    1. Ein Klassen-Template kann sowohl vollständig als auch partiell spezialisiert werden
    2. Eine Member-Methode eines Klassen-Templates kann nur vollständig spezialisiert werden
    3. Eine Funktion auf Namespace-Ebene kann nicht partiell spezialisiert werden, wobei die Überladung (siehe oben) als eine Art Ersatz angesehen werden kann.

    Und so kann partielle Spezialisierung aussehen:

    //Spezialisierung für MyServer und ein beliebiges U
    template <typename U>
    struct Pair<MyServer, U> {
      //...
    };
    
    //Spezialisierung für ein beliebiges T und MyClient
    template <typename T>
    struct Pair<T, MyClient> {
      //...
    };
    
    int main(int argc, char **argv) {
      //Aufruf der ersten Spezialisierung
      Pair<MyServer, UnknownClient> firstPair;
    
      //Aufruf der zweiten Spezialisierung
      Pair<SomeServer, MyClient> secondPair;
    
      //Aufruf der generischen Implementation
      Pair<SomeServer, UnknownClient> thirdPair;
    
      return 0;
    };
    

    Das Spielchen kann man ziemlich weit treiben, denn der Algorithmus zur Bestimmung des am meisten spezialisierten Templates ist sehr exakt und wählt die Implementierung mit der höchsten Übereinstimmung aus.

    7 Das Schlüsselwort export

    Dieser Abschnitt wurde von 7H3 N4C3R beigesteuert, an dieser Stelle ein Dankeschön von mir.

    Bei den vorangegangenen Beispielen war es noch nicht notwendig, aber wenn man größere Klassen oder Bibliotheken implementiert, dann möchte man die Schnittstelle in eine .hpp-Datei und die Implementation in eine .cpp-Datei schreiben.
    Die Motivation dahinter ist, dass jede Änderung an einer Headerdatei dazu führt, dass all der Code neu kompiliert werden muss, der diese Headerdatei benutzt. Gerade in Projekten mit vielen Dateien löst das große Neu-Kompilier-Wellen aus, die ziemlich lange dauern können.

    Leider geht das bei Templates so nicht. Das liegt daran, dass das Template erst überall dort in den Code eingesetzt wird, wo es auch verwendet wird. Vorher ist es "nur ein Stück Text", erst beim Einsetzen bekommt es seine Bedeutung. Genau das verursacht aber das oben beschriebene Verhalten vom Neu-Kompilieren.

    Der eine oder andere hat nun aber vielleicht schon vom Schlüsselwort export gehört, welches nun doch genau diese Trennung ermöglichen soll. In die Headerdatei schreibt man vor das template einfach nur das Wörtchen export, und schon kann man eine .cpp-Datei mit der Implementation füllen.

    Stopp. Soweit so gut, das war die Theorie. In der Praxis steht es um export aber völlig anders. Zuerst: Kaum ein Compiler unterstützt es überhaupt. Lediglich die Front-Ends, die auf den EDG-Compiler (Edison Design Group) aufsetzen, beherrschen es. Das ist im Wesentlichen der Comeau-Compiler. Das und die Tatsache, dass die Entwicklungszeit für dieses Compilerfeature drei Mannjahre betrug, sollte einen stutzig machen (eine mittelgroße bis große Individualanwendung hat ca. zwei Mannjahre Entwicklungszeit). Was stimmt also mit export nicht?

    Im Wesentlichen kann export nicht das halten, was man sich von der Trennung in .hpp- und .cpp-Datei verspricht.

    Man könnte denken, dass bei einer Auslieferung einer selbst geschriebenen Bibliothek nur die .hpp-Datei mitgegeben werden muss und die Implementierung in der .cpp-Datei versteckt bleibt (als kompilierte .o-Datei zur Bibliothek dazugelinkt). Das ist nicht so. Die kurze Antwort ist, dass der Standard verlangt, dass das Template bei seiner Instanzierung vollständig (inklusive Implementation im Quellcode-Format) bekannt ist.

    Auch ein anderer scheinbarer Vorteil ist nicht gegeben, nämlich dass durch das Auslagern der Implementation nicht mehr soviel Quellcode neu übersetzt werden muss. Das ist zwar so schon richtig, dafür muss aber die .cpp-Datei des Templates für jeden Datentyp, für den das Template instanziert wird, übersetzt werden. Die Abhängigkeiten, die durch das Verlagern der Implementation in die .cpp-Datei verschwinden, schlagen hinterrücks wieder zu. Denn sie sind nur versteckt, aber nicht aus der Welt.

    Andere Nachteile von export sind in der Regel höhere Kompilierzeiten, auch wenn sie in der Theorie eigentlich sinken sollten. Auerdem haben EDG-basierte Compiler nur eine mögliche Implementierung von export. Das liegt daran, dass der Standard dieses Schlüsselwort nicht genau genug beschreibt. Es wäre möglich, dass andere Compilerhersteller export nach der Beschreibung im Standard korrekt implementieren, es sich aber überall unterschiedlich verhält und unterschiedlichen Code produziert.

    Der wohl schlimmste Nachteil von export (dessen Erklärung hier im Detail wohl zu weit führt) ist, dass es die Bedeutung von definierten Sprachfeatures gefährlich verändert. Im Endeffekt muss man höllisch aufpassen, um mit export denselben Code zu schreiben wie ohne.

    Deshalb das Fazit (zumindest für die nächste Zeit): Finger weg von export.

    Es ist jedoch möglich, diese Einschränkung mit einem Trick zu umgehen: Wir inkludieren einfach eine .impl-Datei (normale Source-Datei mit .impl-Endung) in die .hpp-Datei:

    //stack.hpp
    template <typename T>
    class Stack {
      //wie oben, nur die Schnittstelle
    };
    
    //Achtung:
    #include "stack.impl"
    
    //stack.impl
    template<typename T>
    inline bool Stack<T>::empty() const {
      return (tip==0) ? true : false;
    };
    //...
    

    Es ist zwar kein export, aber so kann man zumindest die Schnittstelle von der Implementation sauber trennen.

    8 Zum Schluss...

    Das war jetzt nur eine kleine Einführung, es gibt noch so vieles, was man mit Templates machen kann, von Policy-basiertem Klassendesign über Typlisten bis zu Objektfabriken. Templates können einem das Leben extrem erleichtern. Für einen tieferen Einstieg in die Materie empfehle ich "C++ Templates: The Complete Guide" von David Vandervoorde und Nicolai M. Josuttis und "Modernes C++ Design" von Andrei Alexandrescu . "Gehobenes Niveau", aber sehr lesenswert.



  • Schöner Artikel. Gefällt mir gut. 🙂

    GPC schrieb:

    Das war jetzt nur eine kleine Einführung, es gibt noch so vieles, was man mit Templates machen kann, von Policy-basiertem Klassendesign über Typlisten bis zu Objektfabriken. Templates können einem das Leben extrem erleichtern. Für einen tieferen Einstieg in die Materie empfehle ich "Modernes C++ Design" von Andrei Alexandrescu. "Gehobenes Niveau", aber sehr lesenswert.

    Modernes C++ Design ist wirklich ein sehr gutes Buch. Das Problem ist nur, dass zum verstehen diese Template-Einführung nicht reichen wird und Alexandrescu selbst nichts von den verwendeten C++ Techniken erklärt.
    Deshalb würde ich empfehlen das folgende Buch noch vor Alexandrescus Buch zu lesen.
    C++ Templates | ISBN: 0201734842



  • Das stimmt allerdings, wenn man nicht schon genug Vorwissen im Bereich Templates hat, kann einem Modernes C++ Design wirklich Schwierigkeiten machen. Ich werde deine Empfehlung in den Artikel einbauen.



  • Sehr schöne Einführung 👍.

    Vielleicht könnte man Punkt 6 noch ergänzen indem man erwähnt, dass man Spezialisierungen doch in eine gewöhnliche Implementationsdatei schreiben muss, wenn man sie nicht inline oder static deklariert, damit es keine Linkerfehler aufgrund mehrfacher Definitionen gibt.



  • Hallo,

    hagman schrieb:

    Sehr schöne Einführung 👍.

    Vielen Dank 🙂

    Vielleicht könnte man Punkt 6 noch ergänzen indem man erwähnt, dass man Spezialisierungen doch in eine gewöhnliche Implementationsdatei schreiben muss, wenn man sie nicht inline oder static deklariert, damit es keine Linkerfehler aufgrund mehrfacher Definitionen gibt.

    Bei welchem Compiler tritt dieses Problem auf? Bei meinem g++ 3.3.6 kann ich dies bei folgendem Beispiel nicht nachvollziehen:

    //min.hpp
    #ifndef MIN_HPP
    #define MIN_HPP
    
    template <typename T>
    const T& minimum(const T &a, const T &b) {
      return a < b ? a:b;
    };
    
    const char* minimum(const char *str1, const char *str2) {
      return ( (strcmp(str1,str2) < 0 ) ? str2 : str1 );
    };
    
    #endif //MIN_HPP
    
    //main.cpp
    #include <iostream>
    #include "min.hpp"
    
    int main() {
      std::cout<<minimum<int>(5,7)<<'\n'
               <<minimum("hallo","HALLO")<<'\n';
      return EXIT_SUCCESS;
    }
    

    Oder meintest du etwas anderes?

    Mfg

    GPC



  • Und auch erwähnen sollte man, dass partielle spezialisierungen von klassentemplates im selben scope stattfinden müssen.

    ISO 14882:2003 14.5.4p6 schrieb:

    A class template partial specialization may be declared
    or redeclared in any namespace scope in which its
    definition may be defined (14.5.1 and 14.5.2).

    Deshalb geht z.B.

    namespace foo
    {
        template<class T, class U>
        struct s
        {
        }
    }
    
    namespace bar
    {
        template<class T>
        struct foo::s<T, int>
        {
        }
    }
    

    nicht.



  • Genau das meine ich. Hast du min.hpp im selben Programm noch in eine andere Übersetzunseinheit inkludiert? Das hätte ich vielleicht noch erwähnen sollen. Also ich habe dein Beispiel mal unverändert genommen und innerhalb eines Programms in zwei verschiedene Implementierungsdateien inkludiert. Folgende Linkerfehler habe ich erhalten:

    VC 2003 und VC 2005 schrieb:

    Error 1 error LNK2005: "char const * __cdecl minimum(char const *,char const *)" (?minimum@@YAPBDPBD0@Z) already defined in main.obj foo.obj
    Error 2 fatal error LNK1169: one or more multiply defined symbols found E:\test\console\Debug\console.exe

    gcc 4.0.2 schrieb:

    g++ -c main.cpp
    g++ -c min.cpp
    g++ -c foo.cpp
    g++ -o test main.o min.o foo.o
    foo.o: In function minimum(char const*, char const*)': foo.cpp:(.text+0x0): multiple definition ofminimum(char const*, char const*)'
    main.o:main.cpp:(.text+0x0): first defined here
    collect2: ld returned 1 exit status
    make: *** [test] Error 1

    Das liegt wohl daran, dass minimum durch die Spezialisierung zu einer fertig implementierten, "gewöhnlichen" Funktion wird. Deshalb gelten für das spezialisierte minimum die Regeln wie für normale Funktionen auch: Definition in die Implementationsdatei oder als inline oder static spezifizieren.



  • Hallo (sorry für die lange Reaktionszeit),

    hagman schrieb:

    Genau das meine ich. Hast du min.hpp im selben Programm noch in eine andere Übersetzunseinheit inkludiert?
    Das hätte ich vielleicht noch erwähnen sollen.

    Yo, dann haben wir ein Problem mit unserem Freund, dem Linker. Aber das macht nichts, denn anstatt die Spezialisierung static zu machen (oder inline, was manchmal einfach nicht geht), setzen wir sie in einen (anonymen) namespace:

    //min.hpp
    #ifndef MIN_HPP
    #define MIN_HPP
    
    namespace {
    
    template <typename T>
    const T& minimum(const T &a, const T &b) {
      return a < b ? a:b;
    };
    
    const char* minimum(const char *str1, const char *str2) {
      return ( (strcmp(str1,str2) < 0 ) ? str2 : str1 );
    };
    
    };  //namespace
    
    #endif //MIN_HPP
    

    Jetzt alles klar?

    @ness
    Auch deine Anmerkung wird Einzug im Artikel finden, danke dir für den Hinweis.

    Mfg

    GPC



  • naja, aber der anonyme namespace ist doch eine ziemlich "unsaubere" Lösung, finde ich. Entweder du wilst die funktionen inlinen, dann benutz das schlüsselwort, oder eine vollständig spezialisierte funktion gehört in eine implementierungsdatei.



  • Hallo,

    ness schrieb:

    naja, aber der anonyme namespace ist doch eine ziemlich "unsaubere" Lösung, finde ich. Entweder du wilst die funktionen inlinen, dann benutz das schlüsselwort, oder eine vollständig spezialisierte funktion gehört in eine implementierungsdatei.

    das kann man jetzt halten, wie man will. Für gewöhnlich lagere ich die spezialisierte Funktion auch in eine Implementationsdatei aus, oft habe ich aber schon benannte Namensräume, und dann lass ich sie einfach im Header.

    Btw. Was findest du, ist unsauber daran?

    mfg

    GPC



  • naja, weil du dann den code mehrmals (in jeder objektdatei) hast. In dem sinne kannst du fast alles in unbenannte namespace packen.



  • Hi,

    ness schrieb:

    naja, weil du dann den code mehrmals (in jeder objektdatei) hast. In dem sinne kannst du fast alles in unbenannte namespace packen.

    stimmt, das ist bei größeren Funktionen/Klassen ein Argument. Werd mich über's WE mal ransetzen, sofern ich Zeit finde.

    Mfg

    GPC



  • Hi, cooler Artikel 👍 ( nochmal Grundlagen aufgefrischt 😃 )

    GPC schrieb:

    Selbstverständlich kann man auch mehrere Template-Parameter angeben:

    //Zwei Parameter, einer vom Typ T und einer vom Typ U
    template <class T, class U>
    ...
    
    template <class T, int number> //Ein Parameter vom Typ T und einer vom Typ int
    ...
    

    Für "nicht-Typ-Parameter", also built-ins, gelten folgende Einschränkungen:

    1. Sie dürfen nicht verändert werden
    2. Sie dürfen nur ganzzahlig sein

    Vielleicht sollte man hier auch noch erwähnen das built-ins als template paramterer als Konstanten betrachtet werden(Bei generischen Klassen).

    Weil sie zur Compilezeit bekannt sind un man sie dadurch als Größenangabe für Array's verwenden kann und sie auch nicht verändert werden können.



  • Hallo,

    Freak_Coder schrieb:

    Hi, cooler Artikel 👍 ( nochmal Grundlagen aufgefrischt 😃 )

    Vielen Dank.

    GPC schrieb:

    Selbstverständlich kann man auch mehrere Template-Parameter angeben:

    //Zwei Parameter, einer vom Typ T und einer vom Typ U
    template <class T, class U>
    ...
    
    template <class T, int number> //Ein Parameter vom Typ T und einer vom Typ int
    ...
    

    Für "nicht-Typ-Parameter", also built-ins, gelten folgende Einschränkungen:

    1. Sie dürfen nicht verändert werden
    2. Sie dürfen nur ganzzahlig sein

    Vielleicht sollte man hier auch noch erwähnen das built-ins als template paramterer als Konstanten betrachtet werden(Bei generischen Klassen).

    Dachte eigentlich, das sei klar, nachdem ich erwähnt habe, dass eine Auswertung zur Compilezeit erfolgt.

    Weil sie zur Compilezeit bekannt sind un man sie dadurch als Größenangabe für Array's verwenden kann und sie auch nicht verändert werden können.

    Aber ich pack's noch dazu, damit alle Klarheiten beseitigt sind.

    Mfg

    GPC



  • Guter Artikel 👍

    Allerdings komme ich bei folgendem nicht ganz mit:

    GPC schrieb:

    Bei den vorangegangenen Beispielen war es noch nicht notwendig, aber wenn man größere Klassen oder Bibliotheken implementiert, dann möchte man die Schnittstelle in eine .hpp-Datei und die Implementation in eine .cpp-Datei schreiben.
    Die Motivation dahinter ist, dass jede Änderung an einer Headerdatei dazu führt, dass all der Code neu kompiliert werden muss, der diese Headerdatei benutzt. Gerade in Projekten mit vielen Dateien löst das große Neu-Kompilier-Wellen aus, die ziemlich lange dauern können.

    Leider geht das bei Templates so nicht. Das liegt daran, dass das Template erst überall dort in den Code eingesetzt wird, wo es auch verwendet wird. Vorher ist es "nur ein Stück Text", erst beim Einsetzen bekommt es seine Bedeutung. Genau das verursacht aber das oben beschriebene Verhalten vom Neu-Kompilieren.

    Und genau das ist doch auch erwünscht, wenn ich ein Template ändere, oder nicht? Mir ist deswegen nicht ganz klar, warum man Teile der Template-Implementierung (die effektiv Teil des Templates sind) irgendwohin auslagern wollen könnte. Um auf das verwendete Beispiel einzugehen:

    //stack.hpp
    template <typename T>
    class Stack {
      //wie oben, nur die Schnittstelle
    };
    
    //Achtung:
    #include "stack.impl"
    
    //stack.impl
    template<typename T>
    inline bool Stack<T>::empty() const {
      return (tip==0) ? true : false;
    };
    //...
    

    "Normalerweise" hätte man die Template-Funktion Stack<>::empty() ebenfalls im Header stack.hpp. Ändere ich nun den, wird jede .cpp-Datei neu kompiliert, die diesen Header eingefügt hat, weil sich ja etwas für den Quellcode interessantes geändert haben könnte. Mit der gezeigten Methode, eine Datei stack.impl zu benutzen, könnte ich stack.impl ändern und (sofern ich mein Build-System davon nicht benachrichtigt habe) mir einen Wolf kompilieren, ohne daß die Änderungen wirksam werden, weil das Änderungsdatum des Headers nicht neuer ist als das der kompilierten Objekte.
    Genauso kann ich aber etwas an stack.hpp ändern und werde trotzdem den Rattenschwanz der stack.impl hinter mir herziehen, weil dann mein Build-System merkt: "Aha, Header neuer als Objekt, Kompilation anstoßen", der Compiler (Präprozessor) wird merken, daß da eine eigenartige stack.impl eingefügt wird und diese korrekterweise in den header einfügen, worauf dann der Compiler wieder den vollständigen Template-Code "sieht" und das Template so oft instanziiert, wie es nunmal nötig ist.
    Vielleicht liegt's nur an mir, aber mit verschließt sich der Sinn dieses Vorgehens (von der Erhöhung der Übersichtlichkeit mal abgesehen, aber es wird ja auf die Compile-Performance eingegangen). 😕



  • tommie-lie schrieb:

    Guter Artikel 👍

    Danke.

    Und genau das ist doch auch erwünscht, wenn ich ein Template ändere, oder nicht?

    Hat sich was geändert, soll es neu kompiliert werden, korrekt.

    "Normalerweise" hätte man die Template-Funktion Stack<>::empty() ebenfalls im Header stack.hpp. Ändere ich nun den, wird jede .cpp-Datei neu kompiliert, die diesen Header eingefügt hat, weil sich ja etwas für den Quellcode interessantes geändert haben könnte. Mit der gezeigten Methode, eine Datei stack.impl zu benutzen, könnte ich stack.impl ändern und (sofern ich mein Build-System davon nicht benachrichtigt habe) mir einen Wolf kompilieren, ohne daß die Änderungen wirksam werden, weil das Änderungsdatum des Headers nicht neuer ist als das der kompilierten Objekte.

    Die Trennung ist in dem Fall auch rein optischer Natur, denn am Ende inkludiere ich ja die cpp datei in die hpp Datei und damit bin ich gleich weit, wie wenn ich alles in die hpp Datei geschrieben hätte. Es ist nur eine Erleichterung der Übersicht.

    Vielleicht liegt's nur an mir, aber mit verschließt sich der Sinn dieses Vorgehens (von der Erhöhung der Übersichtlichkeit mal abgesehen, aber es wird ja auf die Compile-Performance eingegangen). 😕

    Es dient nur der Erhöhung der Übersichtlichkeit... hab ich das nicht auch irgendwo geschrieben? Egal.

    MfG

    GPC



  • GPC schrieb:

    Vielleicht liegt's nur an mir, aber mit verschließt sich der Sinn dieses Vorgehens (von der Erhöhung der Übersichtlichkeit mal abgesehen, aber es wird ja auf die Compile-Performance eingegangen). 😕

    Es dient nur der Erhöhung der Übersichtlichkeit... hab ich das nicht auch irgendwo geschrieben?

    Klang für mich nicht so. In den ersten beiden Absätzen beschwerst du (oder 7H3 N4C3R) dich über die mitunter längeren Kompilierungszyklen, die entstehen, wenn man seine 100 Templates neu durch den Compiler jagt. Ich dachte, daß damit auch Augenmerk auf die Performance gelegt werden soll und die beschriebene Lösung die Performance verbessern soll.
    Aber der letzte Satz des Absatzes sagt ja, daß man dmait die Schnittstelle von der Implementierung trennt, vielleicht hätte ich mehr auf den Satz als auf die ersten beiden Absätze hören sollen 😉
    Aber vielleicht sollte man über eine Warnung nachdenken, daß man sein Build-System irgendwie davon überzeugen sollte, daß stack.impl nun ebenfalls Teil des entsprechenden Moduls ist. Ich denke nicht, daß die GNU autotools da ohne Handarbeit automatisch drauf reagieren.



  • Hallo,

    tommie-lie schrieb:

    GPC schrieb:

    Vielleicht liegt's nur an mir, aber mit verschließt sich der Sinn dieses Vorgehens (von der Erhöhung der Übersichtlichkeit mal abgesehen, aber es wird ja auf die Compile-Performance eingegangen). 😕

    Es dient nur der Erhöhung der Übersichtlichkeit... hab ich das nicht auch irgendwo geschrieben?

    Klang für mich nicht so. In den ersten beiden Absätzen beschwerst du (oder 7H3 N4C3R) dich über die mitunter längeren Kompilierungszyklen, die entstehen, wenn man seine 100 Templates neu durch den Compiler jagt. Ich dachte, daß damit auch Augenmerk auf die Performance gelegt werden soll und die beschriebene Lösung die Performance verbessern soll.

    schön wär's. Aber leider hat das performancetechnisch keine Auswirkungen.

    Aber der letzte Satz des Absatzes sagt ja, daß man dmait die Schnittstelle von der Implementierung trennt, vielleicht hätte ich mehr auf den Satz als auf die ersten beiden Absätze hören sollen 😉

    kein Thema.

    Aber vielleicht sollte man über eine Warnung nachdenken, daß man sein Build-System irgendwie davon überzeugen sollte, daß stack.impl nun ebenfalls Teil des entsprechenden Moduls ist. Ich denke nicht, daß die GNU autotools da ohne Handarbeit automatisch drauf reagieren.

    äh, nein. Das tun sie nicht. denn die impl Datei ist ja nicht "direkt" am Build-Prozess beteiligt. Du siehst, die impl-Lösung zieht nen Rattenschwanz von Problemen nach sich. Ich pers. verzichte auf diese Möglichkeit und knall alles direkt in den Header.

    MfG

    GPC



  • GPC schrieb:

    Du siehst, die impl-Lösung zieht nen Rattenschwanz von Problemen nach sich.

    Ich weiß 😉

    GPC schrieb:

    Ich pers. verzichte auf diese Möglichkeit und knall alles direkt in den Header.

    Ich auch 😉



  • haha, okay, dann sind wir uns ja einig... 😉


Log in to reply