## Concept Covering and Archetypes

We have discussed how it is important to select the minimal requirements (concepts) for the inputs to a component, but it is equally important to verify that the chosen concepts cover the algorithm. That is, any possible user error should be caught by the concept checks and not let slip through. Concept coverage can be verified through the use of archetype classes. An archetype class is an exact implementation of the interface associated with a particular concept. The run-time behavior of the archetype class is not important, the functions can be left empty. A simple test program can then be compiled with the archetype classes as the inputs to the component. If the program compiles then one can be sure that the concepts cover the component. The following code shows the archetype class for the Input Iterator concept. Some care must be taken to ensure that the archetype is an exact match to the concept. For example, the concept states that the return type of `operator*()` must be convertible to the value type. It does not state the more stringent requirement that the return type be `T&` or `const T&`. That means it would be a mistake to use `T&` or `const T&` for the return type of the archetype class. The correct approach is to create an artificial return type that is convertible to `T`, as we have done here with `reference`. The validity of the archetype class test is completely dependent on it being an exact match with the concept, which must be verified by careful (manual) inspection.

      template <class T>
      class input_iterator_archetype
      {
      private:
        typedef input_iterator_archetype self;
      public:
        typedef std::input_iterator_tag iterator_category;
        typedef T value_type;
        struct reference {
          operator const value_type&() const { return static_object<T>::get(); }
        };
        typedef const T* pointer;
        typedef std::ptrdiff_t difference_type;
        self& operator=(const self&) { return *this;  }
        bool operator==(const self&) const { return true; }
        bool operator!=(const self&) const { return true; }
        reference operator*() const { return reference(); }
        self& operator++() { return *this; }
        self operator++(int) { return *this; }
      };

Generic algorithms are often tested by being instantiated with a number of common input types. For example, one might apply `std::stable_sort()` with basic pointer types as the iterators. Though appropriate for testing the run-time behavior of the algorithm, this is not helpful for ensuring concept coverage because C++ types never match particular concepts, they often provide much more than the minimal functionality required by any one concept. That is, even though the function template compiles with a given type, the concept requirements may still fall short of covering the functions actual requirements. This is why it is important to compile with archetype classes in addition to testing with common input types.

The following is an excerpt from `stl_concept_covering.cpp` that shows how archetypes can be used to check the requirement documentation for `std::stable_sort()`. In this case, it looks like the CopyConstructible and Assignable requirements were forgotten in the SGI STL documentation (try removing those archetypes). The Boost archetype classes have been designed so that they can be layered. In this example the value type of the iterator is composed out of three archetypes. In the archetype class reference below, template parameters named `Base` indicate where the layered archetype can be used.

      {
        typedef less_than_comparable_archetype<
            sgi_assignable_archetype<> > ValueType;
        random_access_iterator_archetype<ValueType> ri;
        std::stable_sort(ri, ri);
      }

Next: Programming with Concepts
Prev: Creating Concept Checking Classes

Copyright © 2000 | Jeremy Siek(jsiek@osl.iu.edu) Andrew Lumsdaine(lums@osl.iu.edu)