8.11. Написание шаблона класса
8.11. Написание шаблона класса
Проблема
Имеется класс, чьи члены в различных ситуациях должны иметь разные типы, а использование обычного полиморфного поведения очень сложно или сильно избыточно. Другими словами, как разработчик класса, вы хотите, чтобы пользователь класса при создании объектов этого класса мог выбрать типы различных его частей, вместо того чтобы указывать их при первоначальном определении класса.
Решение
Для параметризации типов, которые используются при объявлении членов класса (и в других случаях), используйте шаблон класса. Это значит, что требуется написать класс с заполнителями типов, оставив, таким образом, выбор используемых типов на усмотрение пользователя класса. В примере 8.12 показан пример класса узла дерева, который может указывать на любой тип.
Пример 8.12. Написание шаблона класса
#include <iostream>
#include <string>
using namespace std;
template<typename T>
class TreeNode {
public:
TreeNode (const T& val) : val_(val), left_(NULL), right_(NULL) {}
~TreeNode() {
delete left_;
delete right_;
}
const T& getVal() const {return(val_);}
void setVal(const T& val) {val_ = val;}
void addChild(TreeNode<T>* p) {
const T& other = p->getVal();
if (other > val_)
if (rights)
right_->addChild(p);
else
right_ = p;
else
if (left_)
left_->addChild(p);
else
left_ = p;
}
const TreeNode<T>* getLeft() {return(left_);}
const TreeNode<T>* getRight() {return(right_);}
private:
T val_;
TreeNode<T>* left_;
TreeNode<T>* right_;
};
int main() {
TreeNode<string> node1("frank");
TreeNode<string> node2("larry");
TreeNode<string> node3("bill");
node1.addChild(&node2);
node1.addChild(&node3);
}
Обсуждение
Шаблоны классов предоставляют способ параметризации типов, используемых в классе, так что эти типы могут указываться пользователем класса при создании объектов. Однако шаблоны могут оказаться несколько запутанными, так что позвольте мне перед разбором их работы пояснить приведенный выше пример.
Рассмотрим объявление шаблона класса TreeNode из примера 8.12.
template<typename T> class TreeNode {
//...
Часть template<typename T> — это то, что делает этот класс шаблоном, а не обычным классом. Эта строка говорит, что T — это имя типа, который будет указан при использовании класса, а не при его объявлении. После этого параметр T может использоваться в объявлении и определении TreeNode так, как будто это обычный тип — встроенный или определенный пользователем. Например, имеется частный член с именем val_, который должен иметь тип T. Тогда его объявление будет иметь вид:
T val_;
Здесь просто объявляется член класса с именем val_ некоторого типа, который будет определен позднее. Это объявление выглядит так же, как и при использовании для val_ типов int, float, MyClass или string. В этом отношении его можно рассматривать как макрос (т.е. использование #define), хотя сходство с макросом на этом и заканчивается.
Параметр типа может применяться любым способом, которым можно использовать обычный параметр: возвращаемые значения, указатели, параметры методов и т.д. Рассмотрим методы установки и получения val_.
const T& getVal() const (return(val_);}
void setVal(const T& val) {val_ = val;}
getVal возвращает const-ссылку на val_, имеющий тип T, a setVal принимает ссылку на T и записывает ее значение в val_. Некоторые сложности появляются в отношении методов getLeft и getRight, так что далее я вернусь к этому вопросу. Подождите немного.
Теперь, когда TreeNode объявлен с помощью заполнителя типа, его должен использовать клиентский код. Вот как это делается.
TreeNode — это простая реализация двоичного дерева. Чтобы создать дерево, которое хранит строковые значения, создайте узлы следующим образом.
ТreeNode<string> node1("frank");
TreeNode<string> node2("larry");
TreeNode<string> node3("bill");
Тип между угловыми скобками — это то, что используется вместо T при создании экземпляра класса. Создание экземпляра шаблона — это процесс, выполняемый компилятором при создании версии TreeNode при условии, что T — это string. Двоичное физическое представление TreeNode<string> создается тогда, когда создается его экземпляр (и только в этом случае). В результате в памяти получается структура, эквивалентная той, которая была бы, если TreeNode был написан без ключевого слова template и параметра типа, а вместо T использовался бы string.
Создание экземпляра шаблона для данного параметра типа аналогично созданию экземпляра объекта любого класса. Ключевое различие состоит в том, что создание экземпляра шаблона происходит в процессе компиляции, в то время как создание объекта класса происходит во время выполнения программы. Это означает, что если вместо string двоичное дерево должно хранить данные типа int, его узлы должны быть объявлены вот так.
TreeNode<int> intNode1(7);
TreeNode<int> intNode2(11);
TreeNode<int> intNode3(13);
Как и в случае с версией для string, создается двоичное представление шаблона класса TreeNode с использованием внутреннего типа int.
Некоторое время назад я сказал, что рассмотрю методы getLeft и getRight. Теперь, когда вы знакомы с созданием экземпляра шаблона (если еще не были), объявление и определение getLeft и getRight должно стать более осмысленным.
const TreeNode<T>* getLeft() {return(left_);}
const TreeNode<T>* getRight() {return(right_);}
Здесь говорится, что каждый из этих методов возвращает указатель на экземпляр TreeNode для T. Следовательно, когда создается экземпляр TreeNode для, скажем, string, экземпляры getLeft и getRight создаются следующим образом.
const TreeNode<string>* getLeft() {return(left_);}
const TreeNode<string>* getRight() {return(right_);}
При этом не существует ограничения одним параметром шаблона. Если требуется, можно использовать несколько таких параметров. Представьте, что вам требуется отслеживать число дочерних узлов данного узла, но пользователи вашего класса могут быть ограничены в использовании памяти и не захотят использовать int, если смогут обойтись short. Аналогично они могут захотеть применять для подсчета использованных узлов что-то более сложное, чем простой встроенный тип (например, их собственный класс). В любом случае это можно разрешить сделать с помощью еще одного параметра шаблона.
template<typename T, typename N = short>
class TreeNode {
// ...
N getNumChildren();
private:
TreeNode() {}
T val_;
N numChildren_;
// ...
Таким образом, человек, использующий ваш класс, может указать для отслеживания размера поддеревьев каждого узла int, short или что-либо еще.
Для параметров шаблона также можно указать аргументы по умолчанию, как это сделано в моем примере, для чего используется такой же синтаксис, как и при объявлении параметров функций по умолчанию.
template<typename T, typename N = short>
Как и в случае с параметрами функций по умолчанию, их можно использовать только для отдельных параметров при условии, что этот последний параметр или все параметры справа от него имеют аргументы по умолчанию.
В примере 8.12 определение шаблона дается в том же месте, что и его объявление. Обычно это делается для экономии места, занимаемого примером, не в данном случае есть и еще одна причина. Шаблоны (классов или функций — см. рецепт 8.12) компилируются в двоичную форму только тогда, когда создается их экземпляр. Таким образом, невозможно создать объявление шаблона в заголовочном файле, а его реализацию — в исходном файле (т.е. .cpp) Причина заключается в том, что в нем нечего компилировать! Из этого правила имеются исключения, но обычно при написании шаблона класса его реализация должна помешаться в заголовочном файле или встраиваемом файле, который подключается заголовочным.
В этом случае требуется использовать несколько необычный синтаксис. Методы и другие части класса объявляются как в обычном классе, но при определении методов требуется включить дополнительные лексемы, которые говорят компилятору, что это части шаблона класса. Например, getVal можно определить вот так (сравните с примером 8.12)
template<typename T>
const T& TreeNode<T>::getVal() const {
return(val_);
}
Тело функции выглядит точно так же.
Однако с шаблонами следует быть осторожными, так как если написать шаблон, который используется повсеместно, то можно получить раздувание кода, что случается, когда один и тот же шаблон с одними и теми же параметрами (например, TreeNode<int, short>) компилируется в нескольких объектных файлах. По существу в нескольких файлах окажется одно и то же двоичное представление экземпляра шаблона, и это сделает библиотеку или исполняемый файл значительно больше по размеру, чем требуется.
Одним из способов избежать этого является использование явного создания экземпляров, что позволяет указать компилятору создать версию шаблона класса для определенного набора аргументов шаблона. Если сделать это в таком месте, которое компонуется вместе с остальными клиентскими частями, то раздувания кода не произойдет. Например, если известно, что в приложении будет использоваться TreeNode<string>, то в общий исходный файл можно поместить такую строку.
// common.cpp
template class TreeNode<string>;
Соберите динамическую библиотеку с этим файлом, и после этого код, использующий TreeNode<string>, сможет применять эту библиотеку динамически, не содержа своей собственной скомпилированной версии шаблона. Другой код может включить заголовочный файл шаблона класса, затем скомпоноваться с этой библиотекой и. следовательно, избежать необходимости иметь свою копию. Однако этот подход требует проведения экспериментов, так как не все компиляторы имеют одинаковые проблемы с раздуванием кода, но это общий подход для его минимизации.
Шаблоны C++ (как классов, так и функций) — это очень обширная тема, и имеется огромное количество методик создания мощных, эффективных проектов на основе шаблонов. Великолепным примером шаблонов классов являются контейнеры из стандартной библиотеки, такие как vector, list, set и другие, которые описываются в главе 15. Большая часть интересных разработок, описанных в литературе по С++, связана с шаблонами. Если вы заинтересовались этим предметом, почитайте группы новостей comp.lang.std.c++ и comp.lang.c++. В них всегда можно найти интересные вопросы и ответы на них.
Смотри также
Рецепт 8.12.