原文:http://www.boost.org/libs/function/doc/reference.html

C++ BoostBoost.Function Reference Manual

Header <boost/function.hpp> synopsis

以下で、 MAX_ARGS は実装定義の定数であり、 Boost.Function でサポートされる引数の数の最大値 (少なくとも 10) である。このドキュメント中で参照される MAX_ARGS 定数は、ライブラリ中で直接的には定義されていない。

namespace boost {
  class function_base
  {
    typedef implementation-defined safe_bool;
    bool empty() const;
  };

  // [0, MAX_ARGS] の範囲の全ての N について
  template<typename Signature,
           typename Arg1,
	   typename Arg2,
           ...
           typename ArgN,
	   typename Policy    = empty_function_policy, // 推奨されない
	   typename Mixin     = empty_function_mixin, // 推奨されない
	   typename Allocator = std::allocator<function_base> >
  class functionN : public function_base, public Mixin
  {
    typedef ResultType result_type; // [1]
    typedef Policy     policy_type; // 推奨されない
    typedef Mixin      mixin_type; // 推奨されない
    typedef Allocator  allocator_type;

    typedef Arg1 argument_type;        // N == 1 の場合

    typedef Arg1 first_argument_type;  // N == 2 の場合
    typedef Arg2 second_argument_type; // N == 2 の場合

    typedef Arg1 arg1_type;
    typedef Arg2 arg2_type;
             .
             .
             .
    typedef ArgN argN_type;

    enum { arity = N };

    // 構築
    explicit functionN(const Mixin& = Mixin());
    functionN(const functionN&);
    template<typename F> functionN(F, const Mixin& = Mixin());
    template<typename F> functionN(reference_wrapper<F>);
    
    // 代入
    functionN& operator=(const functionN&);
    template<typename F> functionN& operator=(F);
    template<typename F> functionN& operator=(reference_wrapper<F>);
    void set(const functionN&); // 推奨されない
    template<typename F> void set(F); // 推奨されない
    void swap(functionN&);
    void clear();

    // bool 型の文脈
    operator safe_bool() const;
    bool operator!() const;

    // 呼び出し
    result_type operator()(Arg1 a1, Arg2 a2, ..., ArgN aN) const;
  };

  template<typename ResultType,
           typename Arg1,
	   typename Arg2,
           ...
	   typename ArgN,
           typename Policy, // 推奨されない
           typename Mixin, // 推奨されない
           typename Allocator>
  void swap(functionN<ResultType, Arg1, Arg2, ..., ArgN, Policy, Mixin, Allocator>&,
            functionN<ResultType, Arg1, Arg2, ..., ArgN, Policy, Mixin, Allocator>&);

  // [0, MAX_ARGS] の範囲の全ての N について
  template<typename Signature, // 関数型: ResultType (Arg1, Arg2, ..., ArgN)
	   typename Policy    = empty_function_policy, // 推奨されない
	   typename Mixin     = empty_function_mixin, // 推奨されない
	   typename Allocator = std::allocator<function_base> >
  class function : public functionN<ResultType, Arg1, Arg2, ..., ArgN>
  {
    // 構築
    function();
    function(const function&);
    function(const functionN<ResultType, Arg1, Arg2, ..., ArgN>&);
    template<typename F> functionN(F);
    
    // 代入
    function& operator=(const function&);
    function& operator=(const functionN<ResultType, Arg1, Arg2, ..., ArgN>&);
    template<typename F> function& operator=(F);
    void set(const function&); // 推奨されない
    void set(const functionN<ResultType, Arg1, Arg2, ..., ArgN>&); // 推奨されない
    template<typename F> void set(F); // 推奨されない
  };

  template<typename Signature, typename Policy, typename Mixin, typename Allocator>
  void swap(function<Signature, Policy, Mixin, Allocator>&,
            function<Signature, Policy, Mixin, Allocator>&);
}	   

Definitions

Class function_base

クラス function_base は全ての Boost.Function オブジェクトの共通基底クラスだ。 function_base 型のオブジェクトが直接作られる事はないだろう。

bool empty() const

Class template functionN

クラステンプレート functionN は実際には、 function0, function1, ... と、ある実装定義の最大値まで続く、関連するクラス群である。以下の文では、 N はパラメータの数、 f は暗黙のオブジェクトパラメータを表す。

explicit functionN(const Mixin& = Mixin());

functionN(const functionN& g);

template<typename F> functionN(F g, const Mixin& = Mixin());

template<typename F> functionN(reference_wrapper<F> g);

functionN& operator=(const functionN& g);

template<typename F> functionN& operator=(F g);

template<typename F> functionN& operator=(reference_wrapper<F> g);

void set(const functionN& g);

template<typename F> void set(F g);

void swap(functionN& g);

void clear();

operator safe_bool() const

bool operator!() const

result_type operator()(Arg1 a1, Arg2 a2, ..., ArgN aN) const;

Class template function

クラステンプレート function は、番号付きクラステンプレート function0, function1, ... の薄いラッパである。 MAX_ARGS までの引数を受け付ける。 N 個の引数を渡されれば、 functionN (引数 N 個専用のクラス) から派生する。

クラステンプレート function のメンバ関数のセマンティクスは、全て functionN オブジェクトと同じである。ただし、 function オブジェクトの正しいコピーコンストラクトやコピーの代入のために、追加のメンバ関数を定義している。

Operations

template<typename ResultType,
         typename Arg1,
	 typename Arg2,
         ...
	 typename ArgN,
         typename Policy, // 推奨されない
         typename Mixin, // 推奨されない
         typename Allocator>
void swap(functionN<ResultType, Arg1, Arg2, ..., ArgN, Policy, Mixin, Allocator>& f,
          functionN<ResultType, Arg1, Arg2, ..., ArgN, Policy, Mixin, Allocator>& g);
template<typename Signature, typename Policy, typename Mixin, typename Allocator>
void swap(function<Signature, Policy, Mixin, Allocator>& f,
          function<Signature, Policy, Mixin, Allocator>& g);

[1] コンパイラが void 型の return をサポートしていない場合、 ReturnTypevoid を指定すると、 Boost.Function オブジェクトの result_type は実装依存になる。


Doug Gregor
Last modified: Fri Oct 11 05:40:09 EDT 2002

Japanese Translation Copyright © 2003 Hiroshi Ichikawa
オリジナルの、及びこの著作権表示が全ての複製の中に現れる限り、この文書の複製、利用、変更、販売そして配布を認める。このドキュメントは「あるがまま」に提供されており、いかなる明示的、暗黙的保証も行わない。また、いかなる目的に対しても、その利用が適していることを関知しない。