Не собирается проект с шаблонным классом: "undefined reference"

@EricJForster · Регистрация: 10.06.2016

Подскажите пожалуйста, не собирается проект. Пишет "undefined reference to Unit::Set()" и такое же про Unit::Get();

Unit.h

C++

#ifndef UNIT_H
#define UNIT_H
 
 
template<class Type> class Unit
{
    public:
        Unit() {}
        Type Get();
        void Set(Type n);
    private:
        Type data;
};
 
#endif // UNIT_H

Unit.cpp

C++

#include "Unit.h"
 
template<class Type>
void Unit<Type>::Set(Type n)
{
    data = n;
}
 
template<class Type>
Type Unit<Type>::Get()
{
    return data;
}

main.cpp

C++

#include <iostream>
#include "Unit.h"
 
int main()
{
    Unit<int> unit;
    unit.Set(5);
    std::cout << unit.Get();
 
    return 0;
}

nd2 · 25.08.2016, 18:30

Содержимое .cpp помести в .h.

@EricJForster · 25.08.2016, 19:55 **[ТС]**

Сообщение от nd2

Содержимое .cpp помести в .h.

а тогда вообще зачем выносить определение методов класса в отдельный файл?

nd2 · 25.08.2016, 21:19

Сообщение от EricJForster

а тогда вообще зачем выносить определение методов класса в отдельный файл?

Для шаблонов не нужно выносить (шаблоны - это не определения), для не шаблонов нужно выносить.

@HelicopterK52 · 26.08.2016, 18:26

Сообщение от EricJForster

а тогда вообще зачем выносить определение методов класса в отдельный файл?

Всё для того, чтобы поиметь пользу от раздельной компиляции.
Суть проста - разные единицы трансляции ничего не знают друг о друге.
Компилятор стряпает код, и отдает его линковщику, а тот уже решает, какие определения и откуда брать.
Возьмём нешаблонную функцию (для простоты):

C++

//func.h
#ifndef MY_PROJECT_FUNC_H
#define MY_PROJECT_FUNC_H
 
void foo();//Объявляем foo
 
#endif //MY_PROJECT_FUNC_H

C++

//func.cpp
#include "func.h"
#include <iostream>
void foo()
{
   std::cout << "foo" << std::endl;
}

C++

//main.cpp
#include "func.h"
 
int main()
{
   foo();//используем функцию
}

Скомпилируем main.cpp: g++ main.cpp -c -o main.o.
Получили файл main.o. Как видим, никаких ошибок нет (ключик -c как раз "сказал" компилятору, что нужно только скомпилировать в объектник и нет необходимости вызывать линковщик).
В данном случае компилятору для сборки достаточно наличия объявления.
Скомпилируем и второй файл: g++ func.cpp -c -o func.o
И здесь всё нормально. Теперь соберем всё это.
Использовать также будем g++, он сам знает как вызвать линковщик (чтобы не морочить Вам голову всякими ld).
g++ -o main main.o func.o
Всё собралось. Запускаем: ./main, всё отлично, всё работает.
Теперь поменяем main.cpp, например, так:

C++

//main.cpp
#include "func.h"
 
int main()
{
    foo();
    foo();
}

Скомпилируем main.cpp: g++ -c -o main.o main.cpp.
Соберем в бинарник: g++ -o main main.o func.o.
Всё хорошо. Но ведь мы не компилировали func.cpp снова.
Мы лишь скомпилировали main.cpp и потом слинковали с уже имеющимся func.o.
То есть мы не тратили 100500 часов на сборку других библиотек из-за того, что поменяли main.cpp.
Нам достаточно было скомпилировать только измененные части.

А теперь про undefined reference. Возьмем эти же файлы и попробуем собрать таким образом: g++ -o main main.cpp.
Получили undefined reference. Почему?
Всё дело в том, что у компилятора при компилировании main.cpp есть объявление foo, которого ему достаточно для того, чтобы проверить правильность использования этого самого имени foo.
Искать где этот foo расположен будет уже линковщик.
Но линковщик тоже не знает где эту foo искать, ведь мы ему не указали на func.o.
Поэтому он сообщает нам, что возникла такая-то вот ошибка.
Если мы ему укажем func.o, то всё будет хорошо: g++ -o main main.cpp func.o.
При этом заметьте, что func.cpp вообще уже нигде не засвечен у нас.
В func.o есть нужное нам определение функции foo, так что линковщик смог его найти.
А теперь к шаблонам.

Сначала рассмотрим случай, когда у нас нет func.cpp:

C++

//func.h
#ifndef MY_PROJECT_FUNC_H
#define MY_PROJECT_FUNC_H
 
template<typename T>
void foo()
{
}
 
#endif //MY_PROJECT_FUNC_H

C++

//main.cpp
#include "func.h"
 
int main()
{
    foo<int>();
    foo<double>();
}

Соберем: g++ -o main main.cpp. Всё нормально.
В данном случае foo - не функция, это шаблон функции.
По данному шаблону компилятор может построить код.
При использовании foo: foo<int>(); компилятор генерирует код функции на основании данного шаблона (инстанцирование), где T - тип int.
Для foo<double>(); - аналогично, только T - double.
А теперь добавим func.cpp и вынесем туда реализацию foo:

C++

//func.h
#ifndef MY_PROJECT_FUNC_H
#define MY_PROJECT_FUNC_H
 
template<typename T>
void foo();
 
#endif //MY_PROJECT_FUNC_H

C++

//func.cpp
#include "func.h"
 
template<typename T>
void foo()
{
}

Собираем: g++ -o main main.cpp и получаем undefined reference.
Почему? Потому что у нас есть объявление foo, но нет определения, поэтому компилятор не может инстанцировать функцию (сгенерировать на основании шаблона), компилятор лишь сопоставил использование - всё в порядке и отдал объектник линковщику, а линковщик не может найти реализацию, ведь он не знает где её искать.
Ну ок, соберем так: g++ -o main main.cpp func.cpp и снова undefined reference.
Почему, ведь мы указали где реализация?
А вот теперь здесь в игру снова вступает раздельная компиляция.
main.cpp скомпилирована, func.cpp - тоже. Друг о друге они ничего не знают.
В main.cpp использование foo, но в func.cpp на самом деле нет инстанцирований этого шаблона.
Почему его нет? Оно в func.cpp нигде не использовалось, поэтому компилятор не стал инстанцировать шаблон.
То есть, если шаблон с неким набором аргументов шаблона не используется, то компилятор не будет генерировать код для шаблона с заданным набором аргументов.
Как быть? А давайте "заставим" компилятор в func.cpp сгенерировать код. Как? А просто где-то используем foo<тип>, например:

C++

//func.cpp
#include "func.h"
 
 
template<typename T>
void foo()
{
}
 
 
void bar()
{
    foo<int>();
    foo<double>();
}

Собираем: g++ -o main main.cpp func.cpp.
Всё собралось и работает. Почему?
В func.cpp появилась функция bar,
в которой используется foo<int> и foo<double>,
и в данной единице трансляции имеется определение шаблона,
а значит компилятор будет инстанцировать шаблон
и теперь в func.cpp есть нужные определения и линкер может их найти.
Т.е. задача выполнена - мы заставили компилятор инстанцировать шаблон.
Но для этого нам пришлось использовать другую не шаблонную функцию.
Но есть и более адекватное решение - явное инстанцирование.
Явное инстанцирование заставляет компилятор инстанцировать шаблон с данным набором аргументов.
Изменим func.cpp

C++

//func.cpp
#include "func.h"
 
 
template<typename T>
void foo()
{
}
 
 
template void foo<int>();//Явное инстанцирование шаблона foo с параметром int
template void foo<double>();

Собираем: g++ -o main main.cpp func.cpp.
Всё хорошо, всё собралось.
Но, стоит добавить в main, например foo<char>();,
как мы снова получим undefined reference,
ведь у нас компилятор не генерировал код для данного набора аргументов (char).
То есть мы можем вынести реализацию шаблона в .cpp,
но при этом нужно будет как-то инстанцировать шаблон для нужных наборов аргументов.

Если нужно, могу продолжить изыскания на данную тематику, сейчас просто некогда.

Добавлено через 5 минут
Перечитал. Препод из меня будет хреновый.

@hoggy · 26.08.2016, 21:42

Сообщение от HelicopterK52

Если нужно, могу продолжить изыскания на данную тематику

конечно.
в частности штуки с явным инстанцированием на самом деле достаточно редко используется.
некоторые ребята про него даже и не знают ничего.

так что материал может быть весьма полезным.

Сообщение от HelicopterK52

Перечитал. Препод из меня будет хреновый

а по моему, все достаточно наглядно и понятно получилось.

@HelicopterK52 · 26.08.2016, 22:01

Сообщение от hoggy

а по моему, все достаточно наглядно и понятно получилось.

Это потому что мы уже "в теме".

@TheCalligrapher · 14.04.2020, 21:54

Сообщение от HelicopterK52

Но есть и более адекватное решение - явное инстанцирование.
Явное инстанцирование заставляет компилятор инстанцировать шаблон с данным набором аргументов.

К этому можно добавить, что все определения явных инстанцирований, которые вы делаете в .cpp файле можно также дополнить объявлениями явных инстанцирований в .h файле при помощи ключевого слова extern. Для функций это выглядит как

C++

1	extern template void foo<double>();

а для классов как

C++

1	extern template class MyClass<double>;

Это повышает эффективность компиляции больших проектов, использующих явное инстанцирование. Опять же - это лишь "оптимизатор процесса компиляции". Код будет правильно собираться и без таких объявлений.

nd2 3405 / 2786 / 1251 Регистрация: 29.01.2016 Сообщений: 9,423
	25.08.2016, 18:30	2
	Содержимое .cpp помести в .h. 1

@EricJForster 1 / 1 / 0 Регистрация: 10.06.2016 Сообщений: 32
	25.08.2016, 19:55 [ТС]	3
	Сообщение от nd2 Содержимое .cpp помести в .h. а тогда вообще зачем выносить определение методов класса в отдельный файл? 0

nd2 3405 / 2786 / 1251 Регистрация: 29.01.2016 Сообщений: 9,423
	25.08.2016, 21:19	4
	Сообщение от EricJForster а тогда вообще зачем выносить определение методов класса в отдельный файл? Для шаблонов не нужно выносить (шаблоны - это не определения), для не шаблонов нужно выносить. 2

@hoggy 8336 / 3891 / 844 Регистрация: 15.11.2014 Сообщений: 8,795
	26.08.2016, 21:42	6
	Сообщение от HelicopterK52 Если нужно, могу продолжить изыскания на данную тематику конечно. в частности штуки с явным инстанцированием на самом деле достаточно редко используется. некоторые ребята про него даже и не знают ничего. так что материал может быть весьма полезным. Сообщение от HelicopterK52 Перечитал. Препод из меня будет хреновый а по моему, все достаточно наглядно и понятно получилось. 0

@HelicopterK52 823 / 247 / 34 Регистрация: 27.07.2016 Сообщений: 497 Записей в блоге: 1
	26.08.2016, 22:01	7
	Сообщение от hoggy а по моему, все достаточно наглядно и понятно получилось. Это потому что мы уже "в теме". 0

Не собирается проект с шаблонным классом: "undefined reference"

Решение