C++ Boost

Using Concept Checks

各コンセプトに対して、与えられた型 (あるいは型の集合) がコンセプトをモデル化していることを確かめるために使用することができる、何らかのコンセプト・チェック用クラスが存在する。 Boost コンセプト・チェック・ライブラリ (BCCL) は、C++ 標準ライブラリの中で使用される全てのコンセプト+αを対象とした、コンセプト・チェック用クラスを含んでいる。 Reference セクションに、このコンセプト・チェック用クラスをリストしてある。 さらに、他の Boost ライブラリも、ライブラリ独自の特別なコンセプトに対応するコンセプト・チェック用クラスを付随している。 例えば、graph concept および property map concept がある。 さらに、クラス・テンプレートや関数テンプレートを記述する者は、既存のコンセプトでカバーされていない要求事項を表現する必要のある場合は常に、新しいコンセプト・チェック用クラスを作成すべきである。 その方法は Creating Concept Checking Classes で説明する。

BCCL のコンセプト・チェック用クラスの例として、EqualityComparableConcept クラスを挙げる。 このクラスは、C++ 標準 20.1.1 に記述されている EqualityComparable (等値比較可能) 要求事項および、SGI STL で文書化されている EqualityComparable (等値比較可能) コンセプトに相当する。

  template <class T>
  struct EqualityComparableConcept;

テンプレート引数 T はチェック対象の型と意図されている。 すなわち、EqualityComparableConcept の目的は、T に対して与えられたテンプレート引数が 等値比較可能コンセプトをモデル化しているかどうか確認することである。

個々のコンセプト・チェック用クラスには、該当するコンセプトにおいて有効な式を内包する constraints() という名前のメンバー関数がある。 ある型が EqualityComparable (等値比較可能) であるかどうかチェックするためには、その型でコンセプト・チェック用クラスのインスタンスを生成し、次に、コンパイラに、実際に constraints() 関数を実行することなくコンパイルさせる方法を見つける必要がある。 Boost コンセプト・チェック・ライブラリは、これを容易にする2つのユーティリティ: function_requires()BOOST_CLASS_REQUIRE を定義している。

function_requires()

function_requires() 関数は関数本体の中で使用できる。また、BOOST_CLASS_REQUIRE マクロはクラス定義本体で使用できる。 function_requires() 関数は引数をとらないが、コンセプト・チェック用クラスを受けるためのテンプレート・パラメータを有する。 これは、以下に示すように、インスタンス化されたコンセプト・チェック用クラスを明示的にテンプレート引数として与えられなければならないことを意味する。

  // In my library:
  template <class T>
  void generic_library_function(T x)
  {
    function_requires< EqualityComparableConcept<T> >();
    // ...
  };

  // In the user's code:  
  class foo {
    //... 
  };

  int main() {
    foo f;
    generic_library_function(f);
    return 0;
  }

BOOST_CLASS_REQUIRE

BOOST_CLASS_REQUIRE マクロは、ある型がコンセプトをモデル化しているかどうかチェックするために、クラス定義の内部で使用することができる。

  // In my library:
  template <class T>
  struct generic_library_class
  {
    BOOST_CLASS_REQUIRE(T, boost, EqualityComparableConcept);
    // ...
  };

  // In the user's code:  
  class foo {
    //... 
  };

  int main() {
    generic_library_class<foo> glc;
    // ...
    return 0;
  }

Example

以前の Motivating Example に対してコンセプト・チェックを応用する場合、良いやり方として、テンプレート・パラメータ型が RandomAccessIterator をモデル化していることを確認するために std::stable_sort() の一番上に function_requires() を挿入することが一つ挙げられる。 さらに、std::stable_sort() は、イレテータの value_typeLessThanComparable (未満比較可能) を満足することが必要であるから、これをチェックするために、重ねて function_requires() を使用する。

  template <class RandomAccessIter>
  void stable_sort(RandomAccessIter first, RandomAccessIter last)
  {
    function_requires< RandomAccessIteratorConcept<RandomAccessIter> >();
    typedef typename std::iterator_traits<RandomAccessIter>::value_type value_type;
    function_requires< LessThanComparableConcept<value_type> >();
    ...
  }

コンセプトによっては複数の型を処理するものがある。 この場合、対応するコンセプト・チェック用クラスは複数のテンプレート・パラメータを持つことになる。 以下の例は、function_requires() を、2つの型パラメータ(プロパティ・マップ型とそのキーとなる型)をとる ReadWritePropertyMap コンセプトに対して使用する方法を示す。

  template <class IncidenceGraph, class Buffer, class BFSVisitor, 
            class ColorMap>
  void breadth_first_search(IncidenceGraph& g, 
    typename graph_traits<IncidenceGraph>::vertex_descriptor s, 
    Buffer& Q, BFSVisitor vis, ColorMap color)
  {
    typedef typename graph_traits<IncidenceGraph>::vertex_descriptor Vertex;
    function_requires< ReadWritePropertyMap<ColorMap, Vertex> >();
    ...
  }

BOOST_CLASS_REQUIRE の使用例として、std::vector が有すべきコンセプト・チェックを考察する。 要素型に対して当てはめる要求事項の一つは、それが Assignable (割当可能)でなければならない、ということである。 これは、std::vector の定義の一番上にclass_requires<AssignableConcept<T> >(訳注1)を挿入することにより、チェックすることができる。

  namespace std {
    template <class T>
    struct vector {
      BOOST_CLASS_REQUIRE(T, boost, AssignableConcept);
      ...
    };
  }

コンセプト・チェックは、ジェネリック・ライブラリの実装者が使用するために設計されているが、エンドユーザーにおいても有用である。 往々にして、ある型が特定のコンセプトをモデル化しているかどうか、不明確な場合がある。 こういうケースでは、問題の型とコンセプトを対象として function_requires() を使用する、小さなプログラムを作成することで容易にチェックできる。 ファイル stl_concept_checks.cpp は、STL コンテナにコンセプト・チェックを適応する実例となっている。

次へ: Creating Concept Checking Classes
前へ: Concept Checking Introduction


訳注

  1. 原文まま。正しくは BOOST_CLASS_REQUIRE(T, boost, AssignableConcept) と思われる。詳しくは、implementation.htm のコメント内を参照されたい。

Copyright © 2000 Jeremy Siek, Univ.of Notre Dame (jsiek@lsc.nd.edu)