最終更新日時: 2017年12月25日 04時40分03秒
Akira Takahashi が更新

コンテナに複数の並び順を持たせる

std::vectorやstd::mapといったコンテナを使用していると、希に「mapとして使いたいけど挿入順も覚えておきたい」といったことや、「mapに、値からキーを検索する機能がほしい」といった要求が出てくることがある。そういった要求を叶えてくれるのが、Boost Multi-Index Libraryである。

インデックス

boost::multi_index_containerの基本的な使い方 - 挿入順を知っているstd::set

Boost.Multi-Indexでは、boost::multi_index_containerというコンテナ型を使用する。

namespace boost {
namespace multi_index {

template <typename Value, typename IndexSpecifierList, typename Allocator>
class multi_index_container;

} // namespace multi_index

using multi_index::multi_index_container;

} // namespace boost

multi_index_containerのテンプレートパラメータ：

引数番号	パラメータ名	説明
1	`Value`	要素型
2	`IndexSpecifierList`	インデックス(並び順)のリスト
3	`Allocator`	メモリアロケータ

第2、第3テンプレートパラメータは省略でき、省略した場合のIndexSpecifierListはordered_unique(すなわちstd::set)となる。

boost::multi_index_container型を使用して、挿入順を知っているstd::setを表現するには、以下のようにする：

#include <iostream>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/identity.hpp>
#include <boost/range/algorithm/for_each.hpp>

using namespace boost::multi_index;

typedef multi_index_container< 
    int,
    indexed_by<
        ordered_unique<identity<int> >, // 辞書順(重複なし)
        sequenced<> // 挿入順
    >
> Container;

void disp(int x) { std::cout << x << ' '; }

int main()
{
    Container c;
    c.insert(1);
    c.insert(3);
    c.insert(2);
    c.insert(5);
    c.insert(4);

    boost::for_each(c, disp);
    std::cout << std::endl;

    // 挿入順に表示
    boost::for_each(c.get<1>(), disp);
}

実行結果：

1 2 3 4 5 
1 3 2 5 4

ここではインデックスに、重複なしの辞書順を表すordered_uniqueと、挿入順を表すsequencedの2つを指定しており、これらを指定したmulti_index_containerはこの2つの並び順を同時に表現できるようになっている。0番目のインデックス(デフォルト)がordered_uniqueのため、要素の追加にはinsert()を使用しているが、逆の場合にはpush_back()を使用する。

コンテナを使用する際に、何も使用しなければ、そのコンテナは0番目のインデックスとして振る舞うことになる。

そのため、この例において、BOOST_FOREACHやboost::for_eachといったアルゴリズムに、インデックスを指定せずにコンテナを渡した場合には、辞書順に処理されることになる。

// 辞書順に表示
boost::for_each(c, disp);

1 2 3 4 5

インデックスを指定する場合には、boost::multi_index_container::get<N>()メンバ関数テンプレートを使用する。

インデックスの番号をテンプレート引数として指定して、その並び順の表現を取得する。

ここでは、c.get<1>()とすることで、sequencedのインデックスが取得でき、挿入順に処理することができる。

// 挿入順に表示
boost::for_each(c.get<1>(), disp);

1 3 2 5 4

インデックスの表現を変数に持つ

インデックスの表現を変数に保持したい場合は、boost::multi_index_container::nth_index<N>メタ関数でインデックスの型を取得できるので、その型にget<N>()メンバ関数テンプレートで取得したコンテナを参照で格納する。

#include <iostream>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/identity.hpp>
#include <boost/range/algorithm/for_each.hpp>

using namespace boost::multi_index;

typedef multi_index_container< 
    int,
    indexed_by<
        ordered_unique<identity<int> >, // 辞書順(重複なし)
        sequenced<> // 挿入順
    >
> Container;

void disp(int x) { std::cout << x << ' '; }

int main()
{
    Container c;
    c.insert(1);
    c.insert(3);
    c.insert(2);
    c.insert(5);
    c.insert(4);

    typedef Container::nth_index<0>::type Set;
    typedef Container::nth_index<1>::type List;

    Set& s = c.get<0>();
    List& ls = c.get<1>();

    // 辞書順に表示
    boost::for_each(s, disp);
    std::cout << std::endl;

    // 挿入順に表示
    boost::for_each(ls, disp);
}

実行結果：

1 2 3 4 5 
1 3 2 5 4

インデックスに名前を付ける

0番目のインデックス、1番目のインデックス、といった指定は、プログラムが小さいうちはいいかもしれないが、直値の指定は一般に管理しにくい。そこで、「タグ」と呼ばれる空の型を作り、それをインデックスを示す名前として使用することができる。

これまでインデックス番号を指定していたget<N>()にはタグ名を指定し、インデックスの型を取得するnth_indexメタ関数の代わりにboost::multi_index_container::index<Tag>メタ関数を使用する。

#include <iostream>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/identity.hpp>
#include <boost/range/algorithm/for_each.hpp>

using namespace boost::multi_index;

struct order {}; // 辞書順のタグ
struct seq {}; // 挿入順のタグ

typedef multi_index_container< 
    int,
    indexed_by<
        ordered_unique<tag<order>, identity<int> >, // 辞書順(重複なし)
        sequenced<tag<seq> > // 挿入順
    >
> Container;

void disp(int x) { std::cout << x << ' '; }

int main()
{
    Container c;
    c.insert(1);
    c.insert(3);
    c.insert(2);
    c.insert(5);
    c.insert(4);

    typedef Container::index<order>::type Set;
    typedef Container::index<seq>::type List;

    Set& s = c.get<order>();
    List& ls = c.get<seq>();

    // 辞書順に表示
    boost::for_each(s, disp);
    std::cout << std::endl;

    // 挿入順に表示
    boost::for_each(ls, disp);
}

実行結果：

1 2 3 4 5 
1 3 2 5 4

インデックスと標準コンテナの対応表

Boost.Multi-Indexのインデックスは、以下のテーブルのように標準コンテナに対応している。

インデックス	対応する標準コンテナ	説明
`ordered_unique`	std::set	辞書順(重複なし)
`ordered_non_unique`	std::multiset	辞書順(重複あり)
`hashed_unique`	std::unordered_set	ハッシュ表(重複なし)
`hashed_non_unique`	std::unordered_multiset	ハッシュ表(重複あり)
`sequenced`	std::list	挿入順
`random_access`	std::vector	ランダムアクセス

なお、std::mapはordered_(non_)uniqueで表現でき、std::unordered_mapはhashed_(non_)uniqueで表現できる。mapを表現するにはboost::multi_index::memberを使用する。mapの例は、「複数のキーを持つmap」を参照。

複数のキーを持つmapを定義する

boost::multi_index::memberを使用すると、ordered_(non_)uniqueをstd::map、hashed_(non_)uniqueをstd::unordered_mapのように扱うことができる。

memberのテンプレートパラメータは、以下のようになっている：

namespace boost { namespace multi_index {

template <class Class, typename Type, Type Class::*PtrToMember>
struct member;

}} // namespace boost::multi_index

引数番号	パラメータ名	説明
1	`Class`	`multi_index_container`の要素型`Value`
2	`Type`	キーにしたいメンバ変数の型
3	`PtrToMember`	キーにしたいメンバ変数へのポインタ

memberを使用すると、IDをキーにして要素を検索するmap、名前をキーにして要素を検索するmapを同時に存在させることができる。

#include <iostream>
#include <string>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/ordered_index.hpp>

using namespace boost::multi_index;

struct person {
    int id;
    std::string name;
    int age;

    person(int id, const std::string& name, int age)
        : id(id), name(name), age(age) {}

    void print() const
        { std::cout << id << "," << name << "," << age << std::endl; }
};

struct id {};
struct name {};
struct age {};

typedef multi_index_container<
    person,
    indexed_by<
        ordered_unique<tag<id>,   member<person, int,         &person::id> >,
        ordered_unique<tag<name>, member<person, std::string, &person::name> >,
        ordered_unique<tag<age>,  member<person, int,         &person::age> >
    >
> dictionary;

int main()
{
    dictionary dict;
    dict.insert(person(3, "Akira",  30));
    dict.insert(person(1, "Millia", 20));
    dict.insert(person(4, "Johnny", 10));

    // IDをキーにするmap
    {
        typedef dictionary::index<id>::type id_map;
        id_map& m = dict.get<id>();

        // IDをキーにして検索
        id_map::iterator it = m.find(1);
        if (it != m.end()) {
            it->print();
        }
    }

    // 名前をキーにするmap
    {
        typedef dictionary::index<name>::type name_map;
        name_map& m = dict.get<name>();

        // 名前をキーにして検索
        name_map::iterator it = m.find("Akira");
        if (it != m.end()) {
            it->print();
        }
    }

    // 年齢をキーにするmap
    {
        typedef dictionary::index<age>::type age_map;
        age_map& m = dict.get<age>();

        // 年齢をキーにして検索
        age_map::iterator it = m.find(10);
        if (it != m.end()) {
            it->print();
        }
    }
}

実行結果：

1,Millia,20
3,Akira,30
4,Johnny,10

双方向mapを定義する

「複数のキーをもつmapを定義する」と同じ方法で、IDから名前を調べる、名前からIDを調べる、というような双方向mapを、Boost.Multi-Indexで定義できる。

#include <iostream>
#include <string>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/ordered_index.hpp>

using namespace boost::multi_index;

struct product {
    int id;
    std::string name;

    product(int id, const std::string& name)
        : id(id), name(name) {}
};

struct id {};
struct name {};

typedef multi_index_container<
    product,
    indexed_by<
        ordered_unique<tag<id>,   member<product, int,         &product::id> >,
        ordered_unique<tag<name>, member<product, std::string, &product::name> >
    >
> dictionary;

int main()
{
    dictionary dict;
    dict.insert(product(2852, "coffee"));
    dict.insert(product(7777, "cola"));

    // IDから名前を調べる
    {
        typedef dictionary::index<id>::type id_map;
        id_map& m = dict.get<id>();

        // IDをキーにして検索
        id_map::iterator it = m.find(2852);
        if (it != m.end()) {
            std::cout << it->name << std::endl;
        }
    }

    // 名前からIDを調べる
    {
        typedef dictionary::index<name>::type name_map;
        name_map& m = dict.get<name>();

        // 名前をキーにして検索
        name_map::iterator it = m.find("cola");
        if (it != m.end()) {
            std::cout << it->id << std::endl;
        }
    }
}

実行結果：

coffee
7777

要素を書き換える

boost::multi_index_containerの要素書き換えには、replace()メンバ関数を使用する方法と、modify()メンバ関数を使用する方法の2種類がある。これは、前者が安全優先の関数であり、後者が速度優先の関数である。

replace()メンバ関数による要素書き換え

replace()メンバ関数は、安全優先の要素書換え関数である。

指定したイテレータの位置の要素を第2引数の値で置き換え、その変更が全てのインデックスに適用される。

#include <boost/multi_index_container.hpp>
#include <boost/multi_index/ordered_index.hpp>

#include <iostream>
#include <boost/range/algorithm/for_each.hpp>

using namespace boost::multi_index;
typedef multi_index_container<int> Container;

void disp(int x) { std::cout << x <<  ' '; }

int main()
{
    Container c;
    c.insert(3);
    c.insert(1);
    c.insert(4);

    Container::iterator it = c.find(1);
    c.replace(it, 2);

    boost::for_each(c, disp);
}

実行結果：

2 3 4

replace()は以下の方法でこの置き換えを行う。

変更された要素がすべてのインデックスリストに関してオリジナルの並び順を保持する場合、計算量は定数時間で、そうでなければ対数時間
イテレータと参照の有効性は保たれる
操作は強い例外安全、つまり、(システムまたはユーザーのデータ型によって引き起こされる)何らかの例外が投げられた場合、multi_index_containerオブジェクトは変化しない

replace()は、標準のコンテナで提供されなかった強力な操作と、強い例外安全が必要であるときに特に便利だ。

replace()の便利さにはコストが伴うので注意。更新(と内部のreplaceを検索)のために2回全体の要素をコピーしなければならない。要素をコピーすることが高コストな場合、これはまさしくオブジェクトの小さな部分変更のためのかなりの計算コストであるかもしれない。

modify()関数による要素書き換え

replace()が安全優先な実装なのに対し、modify()関数は速度優先の要素書き換えを行う。

replace()は、書き換える要素へのイテレータと、要素書き換えのための関数オブジェクトをとる。

#include <boost/multi_index_container.hpp>
#include <boost/multi_index/ordered_index.hpp>

#include <iostream>
#include <boost/range/algorithm/for_each.hpp>

using namespace boost::multi_index;
typedef multi_index_container<int> Container;

class change_value {
    int value_;
public:
    explicit change_value(int value)
        : value_(value) {}

    void operator()(int& target) const
    {
        target = value_;
    }
};

void disp(int x) { std::cout << x <<  ' '; }

int main()
{
    Container c;
    c.insert(3);
    c.insert(1);
    c.insert(4);

    Container::iterator it = c.find(1);
    c.modify(it, change_value(2));

    boost::for_each(c, disp);
}

実行結果：

2 3 4

modify()は速度を優先するために、衝突により書き換え失敗が起こった場合に、壊れたデータになってしまうことを防ぐために、要素を削除する。

さらに、一貫性のためにmodify()は、衝突により書き換え失敗が起こった場合にロールバックするための関数オブジェクトを任意に指定するバージョンも提供している。

#include <boost/multi_index_container.hpp>
#include <boost/multi_index/ordered_index.hpp>

#include <iostream>
#include <boost/range/algorithm/for_each.hpp>

using namespace boost::multi_index;
typedef multi_index_container<int> Container;

class change_value {
    int value_;
public:
    explicit change_value(int value)
        : value_(value) {}

    void operator()(int& target) const
    {
        target = value_;
    }
};

class rollback_value {
    int value_;
public:
    explicit rollback_value(int value)
        : value_(value) {}

    void operator()(int& target) const
    {
        target = value_;
    }
};

void disp(int x) { std::cout << x <<  ' '; }

int main()
{
    Container c;
    c.insert(3);
    c.insert(1);
    c.insert(4);

    Container::iterator it = c.find(1);
    c.modify(it, change_value(2), rollback_value(1));

    boost::for_each(c, disp);
}

プログラマは、最良の更新メカニズムを決定するためにreplace()、modify()およびロールバックをもつmodify()の振る舞いの差をケースバイケースで考慮しなければならない。

更新関数と衝突時の動作をまとめると、以下のようになる：

操作	衝突時の動作
`replace(it, x)`	置換は行われない
`modify(it, mod)`	要素は消去される
`modify(it, mod, back)`	`back`は復旧するのに使用される(`back`が例外を投げた場合、要素は消去される)

並び順を動的に変更する

Boost.Multi-Indexのordered indices, random access indices, sequenced indicesなどのインデックスは不変であるため、通常の手段では並び順をあとから変えることはできない。

typedef multi_index_container<
    int,
    indexed_by<random_access<> >
> container;

container c;
boost::random_shuffle(c); // エラー！書き換えできない

こういった動的な並び順をインデックスとして持たせるために、multi_index_containerクラスにはrearrange()というメンバ関数が用意されている。

以下がその使用例である。2つめのrandom access indicesを、動的な並び順として扱えるようにしている。

#include <iostream>
#include <vector>
#include <boost/range/algorithm.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/random_access_index.hpp>
#include <boost/assign/list_of.hpp>
#include <boost/foreach.hpp>
#include <boost/ref.hpp>

using namespace boost::multi_index;
typedef multi_index_container<
    int,
    indexed_by<
        random_access<>,
        random_access<>
    >
> container;

int main()
{
    container c = boost::assign::list_of(1)(2)(3)(4)(5);

    std::vector<boost::reference_wrapper<const int> > v;
    BOOST_FOREACH(const int& i, c) {
        v.push_back(boost::cref(i));
    }

    boost::random_shuffle(v);
    c.get<1>().rearrange(v.begin());

    boost::for_each(c.get<0>(), [](int x) { std::cout << x; }); std::cout << std::endl;
    boost::for_each(c.get<1>(), [](int x) { std::cout << x; }); std::cout << std::endl;
}

実行結果：

12345
52431

1つめのrandom access indicesの並び順はそのままに、2つめのrandom access indicesの方だけが、random_shuffle()を適用した動的な並び順になっていることがわかる。

rearrange()を使用するには、multi_index_containerの要素を一旦、reference wrapperのコンテナに持たせてそのコンテナに対して並び順の操作を行う必要がある。

Boost.Multi-Indexのドキュメントでは、トランプをシャッフルする例が紹介されている。

http://www.boost.org/doc/libs/release/libs/multi_index/example/rearrange.cpp