Tools.h++ 7.0 クラスライブラリ・リファレンスマニュアル: RWTPtrHashMultiMap

バナーをクリックすれば目次に戻ります

Copyright 1999 Rogue Wave Software
Copyright 1999 Sun Microsystems, Inc.

## RWTPtrHashMultiMap<K,T,H,EQ>

### 形式

      #include <rw/tphmmap.h>
      RWTPtrHashMultiMap<K,T,H,EQ> m;

### 標準 C++ ライブラリ依存

  > 注 - RWTPtrHashMultiMap には標準 C++ ライブラリが必要です。

### 説明

  このクラスは、型 `pair<K* const, T*>` の関連付けの、ポインタにもとづくコレクションを維持します。これらのペアは、型 `H` のハッシュオブジェクトに従って格納されます。H は、次の公開メンバーを介して、型 `K` の要素に対するハッシュ関数を提供しなければなりません。

         unsigned long operator()(const K& x)

  コレクション中の同値キーは、型 `EQ` の同等オブジェクトにもとづいてグループ化されます。`EQ` は、次の公開メンバーを介して、このグループ化を保証しなければなりません。

         bool operator()(const K& x, const K& y)

  これは、`x` と `y` が等しい場合に `TRUE` を返します。RWTPtrHashMultiMap<K,T,H,EQ> には、互いに等しい複数のキーを含めることができます (RWTPtrHashMap<K,T,H,EQ> は、コレクション内の既存のキーと等しいキーは受け付けません)。等しいかどうかは、`==` 演算子ではなく、比較オブジェクトにもとづいて判定されます。

### 持続性

  同形

### 例

      //
      // tphmap.cpp
      //
      #include<rw/tphmmap.h>
      #include<rw/cstring.h>
      #include<iostream.h>

      struct silly_hash{
         unsigned long operator()(RWCString x) const
         { return x.length() * (long)x[0]; }
      };
      int main(){
        RWCString snd = "Second";
        RWTPtrHashMultiMap<RWCString,int,silly_hash,equal_to<RWCString> >
            contest;
        contest.insert(new RWCString("First"), new int(7));
        contest.insert(&snd, new int(3));
        contest.insert(&snd, new int(6));      //  重複キー可
        contest.insert(new RWCString("Third"), new int(2));

        cout << "There were " << contest.occurrencesOf(&snd)
             << " second place winners." << endl;

        return 0;
      }

  #### プログラム出力:

      There were 2 second place winners.

### 関連クラス

  クラス RWTPtrHashMap<K,T,H,EQ> は、互いに等しい複数のキーを受け付けないポインタにもとづくコレクションに対して同じインタフェースを提供します。

  クラス rw_hashmultimap<<K*,T*>,rw_deref_hash<H,K>,rw_deref_compare<EQ,K>> は、このコレクションの基礎となる実装として使用される C++ 標準スタイルコレクションです。

### 公開 Typedef

      typedef rw_deref_hash<H,K>                container_hash;
      typedef rw_deref_compare<EQ,K>            container_eq;
      typedef rw_hashmultimap<K*,T*,container_hash,container_eq>
                                                container_type;
      typedef container_type::size_type         size_type;
      typedef container_type::difference_type   difference_type;
      typedef container_type::iterator          iterator;
      typedef container_type::const_iterator    const_iterator;
      typedef pair <K* const, T*>               value_type;
      typedef pair <K* const, T*>&              reference;
      typedef const pair <K* const, T*>&        const_reference;
      typedef K*                                value_type_key;
      typedef T*                                value_type_data;
      typedef K*&                               reference_key;
      typedef T*&                               reference_data;
      typedef const K*const&                    const_reference_key;
      typedef const T*const&                    const_reference_data;

### 公開コンストラクタ

      RWTPtrHashMultiMap<K,T,H,EQ>();

    空のマップを作成します。

      RWTPtrHashMultiMap<K,T,H,EQ>(const container_type& m);

    C++ 標準ライブラリスタイルのハッシュマルチマップ `m` から要素ごとにコピーすることによって、マルチマップを作成します。

      RWTPtrHashMultiMap<K,T,H,EQ>
      (const RWTPtrHashMultiMap<K,T,H,EQ>& rwm);

    コピーコンストラクタ。

      RWTPtrHashMultiMap<K,T,H,EQ>
      (value_type* first, value_type* last);

    `first` が指す `pair` の配列から `last` が指すペアまで (ただし、そのペアは含みません)、要素をコピーすることによって、マップを作成します。

      RWTPtrHashMultiMap<K,T,H,EQ>
      (const H& h, size_type sz = RWDEFAULT_CAPACITY);

    この Tools.h++ 6.x スタイルのコンストラクタは、ハッシュオブジェクト `h` を使用し、初期容量 `sz` を持つ空ハッシュマルチマップを作成します。

### 公開メンバー演算子

      RWTPtrHashMultiMap<K,T,H,EQ>&
      operator=(const container_type&jjj m);
      RWTPtrHashMultiMap<K,T,H,EQ>&
      operator=(const RWTPtrHashMultiMap<K,T,H,EQ>& m);

    自分自身のすべての関連付けを削除し、`m` からすべての関連付けをコピーすることによって、それらを置き換えます。

      bool
      operator==(const RWTPtrHashMultiMap<K,T,H,EQ>& m);

    自分自身が `m` と等しい場合は `TRUE` を返し、それ以外の場合は `FALSE` を返します。2 つのコレクションのエントリ数が同じで、両方のコレクションを反復したときに個々の要素が互いに等しい場合、両者は等しいと言えます。要素は比較前に間接参照されます。

### 公開メンバー関数

      void
      apply(void (*fn)(const K*, T*&,void*),void* d);
      void
      apply(void (*fn)(const K*, const T*, void*), void* d) const;

    `fn` が指すユーザー定義関数を、コレクション内の各関連付けに適用します。`fn` 関数は、次のプロトタイプの 1 つを持っていなければなりません。

          void yourfun(const K* key, T*& a, void* d);
          void yourfun(const K* key, const T* a, void* d);

    クライアントデータは、パラメータ `d` を通して渡すことができます。

      void
      applyToKeyAndValue(void (*fn)(const K*, T*&,void*),void* d);
      void
      applyToKeyAndValue

      (void (*fn)(const K*, const T*, void*), void* d) const;

    これは、上記 `apply` メンバーの陳腐化した (古くなった) バージョンです。機能は `apply` とまったく同じです。

      iterator
      begin();
      const_iterator
      begin() const;

    自分自身内の最初のペアの位置にある反復子を返します。

      size_type
      capacity() const;

    基礎となるハッシュ表現で使用可能なバケット (スロット) 数を返します。下記の `resize` を参照してください。

      void
      clear();

    自分自身から項目をすべて削除することによって、コレクションを消去します。

      void
      clearAndDestroy();

    コレクションからすべての関連付けを削除し、`delete` 演算子を使用して、キーとそれらの関連付けられた項目が指すオブジェクトを破棄します。同じオブジェクトに対して複数のポインタが格納される場合は、このメソッドを使用しないでください。

      bool
      contains(const K* key) const;

    自分自身内に `*key` と等しいキー `j` が存在する場合は、`TRUE` を返します。それ以外の場合は、`FALSE` を返します。

      bool
      contains(bool (*fn)(value_type,void*),void* d) const;

    自分自身内に式 `((*fn)(a,d))` が `TRUE` になるような関連付け `a` が存在する場合は、`TRUE` を返します。それ以外の場合は、`FALSE` を返します。`fn` が指すユーザー定義テスター関数は、次のプロトタイプを持っていなければなりません。

         bool yourTester(value_type* a, void* d);

    クライアントデータは、パラメータ `d` を通して渡すことができます。

      iterator
      end();
      const_iterator
      end() const;

    自分自身内の最後の関連付けの「直後」にある反復子を返します。

      size_type
      entries() const;

    自分自身内の関連付けの数を返します。

      float
      fillRatio() const;

    `entries()/capacity()` の比率を返します。

      const K*
      find(const K* key) const;

    自分自身内に `*key` と等しいキー `j` が存在する場合は、`j` を返します。それ以外の場合は、`rwnil` を返します。

      value_type
      find(bool (*fn)(value_type,void*), void* d) const;

    自分自身内に式 `((*fn)(a,d))` が `TRUE` になるような関連付け `a` が存在する場合は、`a` を返します。それ以外の場合は、`pair<rwnil,rwnil>` を返します。`fn` が指すユーザー定義テスター関数は、次のプロトタイプを持っていなければなりません。

        bool yourTester(value_type a, void* d);

    クライアントデータは、パラメータ `d` を通して渡すことができます。

      T*
      findValue(const K* key);
      const T*
      findValue(const K* key) const;

    自分自身内に `*key` と等しいキー `j` が存在する場合は、`j` に関連付けられている項目を返します。それ以外の場合は、`rwnil` を返します。

      const K*
      findKeyAndValue(const K* key, T*& tr);
      const K*
      findKeyAndValue(const K* key, const T*& tr) const;

    自分自身内に `*key` と等しいキー `j` が存在する場合は、`j` を `kr` に代入し、`j` に関連付けられている項目を `tr` に代入し、`j` を返します。それ以外の場合は、`rwnil` を返し、`tr` の値は変更しません。

      bool
      insert(K* key,T* a);

    項目 `a` が関連付けられている `key` をコレクションに追加します。`TRUE` を返します。

      bool
      insertKeyAndValue(K* key,T* a);

    これは、上記 `insert` メンバーの陳腐化した (古くなった) バージョンです。機能は `insert` とまったく同じです。

      bool
      isEmpty() const;

    コレクション内に項目が存在しない場合は `TRUE` を返し、それ以外の場合は `FALSE` を返します。

      size_type
      occurrencesOf(const K* key) const;

    `*key` と等しい自分自身内のキー `j` の数を返します。

      size_type
      occurrencesOf
      (bool(*fn)(value_type,void*),void* d)const;

    式 `((*fn)(a,d))` が `TRUE` になるような自分自身内の関連付け `a` の数を返します。`fn` が指すユーザー定義テスター関数は、次のプロトタイプを持っていなければなりません。

         bool yourTester(value_type a, void* d);

    クライアントデータは、パラメータ `d` を通して渡すことができます。

      K*
      remove(const K* key);

    `*key` と等しい自分自身内のキー `j` との最初の関連付けを削除します。そのような関連付けが存在しない場合は、`rwnil` を返します。

      K*
      remove(bool (*fn)(value_type,void*), void* d);

    式 `((*fn)(a,d))` が `TRUE` になるような自分自身内の最初の関連付け `a` を削除し、そのキーを返します。そのような関連付けが存在しない場合は、`rwnil` を返します。`fn` が指すユーザー定義テスター関数は、次のプロトタイプを持っていなければなりません。

        bool yourTester(value_type a, void* d);

    クライアントデータは、パラメータ `d` を通して渡すことができます。

      size_type
      removeAll(const K* key);

    `key` と等しい自分自身内のキー `j` との関連付けをすべて削除します。削除した関連付けの数を返します。

      size_type
      removeAll(bool (*fn)(value_type,void*), void* d);

    式 `((*fn)(a,d))` が `TRUE` になるような自分自身内のすべての関連付け `a` を削除します。削除した数を返します。`fn` が指すユーザー定義テスター関数は、次のプロトタイプを持っていなければなりません。

         bool yourTester(value_type a, void* d);

    クライアントデータは、パラメータ `d` を通して渡すことができます。

      void
      resize(size_type sz);

    `sz` の容量を用いて新しいハッシュマルチマップを作成することによって、自分自身の容量を変更します。次に、`resize` は、自分自身のすべての要素を新しいコンテナにコピーし、最後に、その新しいコンテナの内部表現を自分自身の内部表現と交換します。

      container_type&
      std();
      const container_type&
      std() const;

    自分自身に対する実装として使用される、基礎となる C++ 標準コレクションへの参照を返します。

### 関連の大域演算子

      RWvostream&
      operator<<(RWvostream& strm,
              const RWTPtrHashMultiMap<K,T,H,EQ>& coll);
      RWFile&
      operator<<(RWFile& strm,
              const RWTPtrHashMultiMap<K,T,H,EQ>& coll);

    出力ストリーム `strm` にコレクション `coll` を保存するか、すでに保存されている場合は、そのコレクションに対する参照を保存します。

      RWvistream&
      operator>>(RWvistream& strm,
              RWTPtrHashMultiMap<K,T,H,EQ>& coll);
      RWFile&
      operator>>(RWFile& strm,
              RWTPtrHashMultiMap<K,T,H,EQ>& coll);

    コレクション `coll` の内容を入力ストリーム `strm` から復元します。

      RWvistream&
      operator>>(RWvistream& strm,
              RWTPtrHashMultiMap<K,T,H,EQ>*& p);
      RWFile&
      operator>>(RWFile& strm,
              RWTPtrHashMultiMap<K,T,H,EQ>*& p);

    入力ストリーム `strm` 上の次のオブジェクトを調べて、ヒープから新しいコレクションを作成してそれを指すように `p` を設定するか、または前に読み込んだインスタンスを指すように `p` を設定します。コレクションをヒープから作成した場合、ユーザーはそれを削除する責任があります。