Xderives from a class template instantiation using
Xitself as template argument. The name of this idiom was coined by Jim Coplien, who had observed it in some of the earliest C++ template code.
Typically, the base class template will take advantage of the fact that member function bodies (definitions) are not instantiated until long after their declarations, and will use members of the derived class within its own member functions, via the use of a
static_cast, or simply a cast e.g.:
This technique achieves a similar effect to the use of virtual functions, without the costs (and some flexibility) of dynamic polymorphism. This particular use of the CRTP has been called "simulated dynamic binding" by some. This pattern is used extensively in the Windows ATL and WTL libraries.
To elaborate on the above example, consider a base class with no virtual functions. Whenever the base class calls another member function, it will always call its own base class functions. When we inherit from this class, a derived class, we inherit all the member variables and member functions that weren't overridden (no constructors or destructors, of course, either). If the derived class calls an inherited function that then calls another member function, that function will never call any derived or overridden member functions in the derived class. As a result of this behavior, most C++ programmers define member functions as virtual to avoid this problem.
However, if base class member functions use the CRTP pattern for all member function calls, the overridden functions in the derived class will get selected at compile time. This effectively emulates the virtual function call system at compile time without the costs in size or function call overhead (VTBL structures, and method lookups, multiple-inheritance VTBL machinery) and the slight disadvantage of not being able to do this choice at runtime.
The main purpose of an object counter is retrieving statistics of object creation and destruction for a given class. This can be easily solved using CRTP:
Each time an object of class
X is created, the constructor of
counter is called, incrementing both the created and alive count. Each time an object of class
X is destroyed, the alive count is decremented. It is important to note that
counter are two separate classes and this is why they will keep separate counts of
Y's. Also note that
counter does not necessarily use the type in this example, except to keep the counts separate.
The CRTP makes an appearance in the Java programming language standard library where the Enum class is defined as
Enum<T extends Enum<T>>. Java programmers use the CRTP in practice when they write a comparable class:
class X implements Comparable<X>.