5. erase

最終更新日時(UTC):
が更新

履歴 編集

function
<unordered_map>

std::unordered_multimap::erase(C++11)

iterator erase(iterator position);                         // (1) C++17

iterator erase(const_iterator position);                   // (2) C++11

size_type erase(const key_type& k);                        // (3) C++11

iterator erase(const_iterator first, const_iterator last); // (4) C++11

概要

指定された要素を削除する

要件

  • position は、有効で、かつ、間接参照可能な（dereferenceable、つまり cend() ではない）当該コンテナを指す読み取り専用イテレータでなければならない。
  • first と last は [first, last) が当該コンテナの有効な範囲である読み取り専用イテレータでなければならない。
    なお、規格書では first は間接参照可能である必要があることになっているが、他の種類のコンテナの要件と照らし合わせると、間接参照可能である必要はない（つまり、first と last が共に cend() でも良い）ものと思われる。

効果

  • (1), (2) : position で指定された要素を削除する。
  • (3) : k と等価なキーの要素を削除する。
  • (4) : イテレータ範囲[first, last) にある要素を全て削除する。

戻り値

  • (1), (2) : 「削除前に、削除された要素の次だった位置」を指すイテレータ。erase() を呼び出しても削除された要素以外を指す全てのイテレータは無効にならないため、std::next(position) と同じ位置を指す iterator である。
    なお、position は const_iterator なのに対して、戻り値は iterator であるため注意が必要である。
  • (3) : 削除した要素数。
  • (4) : 「削除前に、削除された要素の範囲の次だった位置」を指すイテレータ。erase() を呼び出しても削除された要素以外を指す全てのイテレータは無効にならないため、last と同じ位置を指す iterator である。
    なお、first 及び last は const_iterator なのに対して、戻り値は iterator であるため注意が必要である。
    また、要件に示したように first が間接参照可能である必要がなかった場合にも、他の種類のコンテナの戻り値と照らし合わせると、last と同じ位置を指す iterator を返すのが適切であるものと思われる。

例外

  • (1), (2) : 投げない。
  • (3) : コンテナの key_equal と hasher のオブジェクト（それぞれ key_eq() と hash_function() が返すオブジェクト）が例外を投げなければ、例外を投げない。
  • (4) : 投げない。

計算量

  • (1), (2) : 平均的なケースでは定数（O(1)）だが、最悪のケースではコンテナの要素数に比例（O(size())）
  • (3) : 平均的なケースでは削除された要素数に比例（O(count(k))）だが、最悪のケースではコンテナの要素数に比例（O(size())）
  • (4) : 平均的なケースでは指定された範囲の要素数に比例（O(std::distance(first, last))）だが、最悪のケースではコンテナの要素数に比例（O(size())）

備考

削除された要素を指すイテレータ、および、参照のみ無効になる。なお、規格書に明確な記載は無いが、削除された要素を指すポインタも無効になる。

例

基本的な使い方 (C++11)

#include <iostream>
#include <unordered_map>
#include <iterator>
#include <algorithm>
#include <string>
#include <utility>

using si = std::pair<const std::string, int>;

std::ostream& operator<<(std::ostream& os, const si& p)
{
  return os << '(' << p.first << ", " << p.second << ')';
}

template <class C>
void print(const char* label, const C& c, std::ostream& os = std::cout)
{
  os << label << " : ";
  std::for_each(c.cbegin(), c.cend(), [&os](const si& p) { os << p << ", "; });
  os << '\n';
}

int main()
{
  // 指定した位置にある要素を削除（(1)の形式）
  {
    std::unordered_multimap<std::string, int> um{ {"1st", 1}, {"3rd", 3}, {"5th", 5}, {"7th", 7}, {"9th", 9}, {"3rd", 33}, };
    print("(1) erase(const_iterator) before", um);

    auto it1 = um.find("3rd");
    std::cout << "argument: " << *it1 << '\n';
    auto it2 = um.erase(it1);
    std::cout << "return value: " << *it2 << '\n';
    print("after", um);
    std::cout << std::endl;
  }

  // 指定したキーと等価な要素を削除（(3)の形式）
  {
    std::unordered_multimap<std::string, int> um{ {"1st", 1}, {"3rd", 3}, {"5th", 5}, {"7th", 7}, {"9th", 9}, {"3rd", 33}, };
    print("(3) erase(const value_type&) before", um);

    auto count1 = um.erase("5th");
    auto count2 = um.erase("8th");
    auto count3 = um.erase("3rd");
    std::cout << "argument: 5th, 8th, 3rd" << '\n';
    std::cout << "return value: " << count1 << ", " << count2 << ", " << count3 << '\n';
    print("after", um);
    std::cout << std::endl;
  }

  // 指定した位置にある要素を削除（(4)の形式）
  {
    std::unordered_multimap<std::string, int> um{ {"1st", 1}, {"3rd", 3}, {"5th", 5}, {"7th", 7}, {"9th", 9}, {"3rd", 33}, };
    print("(4) erase(const_iterator, const_iterator) before", um);

    auto it1 = std::next(um.cbegin());
    auto it2 = std::next(it1, 2);
    std::cout << "arguments: " << *it1 << ", " << *it2 << '\n';
    auto it3 = um.erase(it1, it2);
    std::cout << "return value: " << *it3 << '\n';
    print("after", um);
    std::cout << std::endl;
  }
}

出力例

(1) erase(const_iterator) before : (9th, 9), (7th, 7), (5th, 5), (3rd, 33), (3rd, 3), (1st, 1), 
argument: (3rd, 33)
return value: (3rd, 3)
after : (9th, 9), (7th, 7), (5th, 5), (3rd, 3), (1st, 1), 

(3) erase(const value_type&) before : (9th, 9), (7th, 7), (5th, 5), (3rd, 33), (3rd, 3), (1st, 1), 
argument: 5th, 8th, 3rd
return value: 1, 0, 2
after : (9th, 9), (7th, 7), (1st, 1), 

(4) erase(const_iterator, const_iterator) before : (9th, 9), (7th, 7), (5th, 5), (3rd, 33), (3rd, 3), (1st, 1), 
arguments: (7th, 7), (3rd, 33)
return value: (3rd, 33)
after : (9th, 9), (3rd, 33), (3rd, 3), (1st, 1),

注：unordered_multimap は非順序連想コンテナであるため、出力順序は無意味であることに注意

イテレート中に要素を削除する

#include <iostream>
#include <unordered_map>

int main()
{
  std::unordered_multimap<int, char> um = {
    {3, 'a'},
    {1, 'b'},
    {4, 'c'}
  };

  // イテレート中に要素削除をするような場合には、
  // 範囲for文は使用できない
  for (auto it = um.begin(); it != um.end();) {
    // 条件一致した要素を削除する
    if (it->first == 1) {
      // 削除された要素の次を指すイテレータが返される
      it = um.erase(it);
    }
    // 要素削除をしない場合に、イテレータを進める
    else {
      ++it;
    }
  }

  for (const auto& x : um) {
    std::cout << x.first << ':' << x.second << std::endl;
  }
}

出力例

4:c
3:a

バージョン

言語

  • C++11

処理系

関連項目

名前 説明
emplace コンテナ内への要素の直接構築
emplace_hint 挿入位置のヒントを使用したコンテナ内への要素の直接構築
insert 要素の追加
clear 全要素の削除
swap 内容の交換

参照