如何use/createboost::multi_index?

How to use/create boost::multi_index?

有人可以详细解释一下如何使用 boost::multi_index 创建多索引地图吗?网上看了很多例子,还有boost页面,但是看不懂。我想通过多个 int/longs 作为键来映射 class 对象指针。有人可以帮我理解这个吗?

我有一个 class X 和 class 的多个属性,它们是 long longlongintint。我想将属性 long longlongintint 存储为要映射到的键 ->

我希望能够在给定任何 属性 的情况下查找指针。有些属性对于 X 的每个对象都是唯一的,有些则不是唯一的。

Boost.Multi-index 提供了一个极其可定制的界面,但代价是提供了一个极其复杂的界面,所以很容易理解为什么你会被卡住。

我将提供一个应符合您的用例的注释示例。

首先,我们的数据:

struct X
{
  long long l; // assume unique
  int i1; // assume unique
  int i2; // assume non-unique
  // plus any ohter data you have in your class X
};

接下来,我们将为我们希望容器拥有的每个索引准备一个标签。标签不是绝对必要的(索引可以按顺序访问),但为每个索引提供名称更方便:

struct IndexByL {};
struct IndexByI1 {};
struct IndexByI2 {};

现在,我们已经有了将容器类型放在一起所需的内容:

using Container = boost::multi_index_container<
  X*, // the data type stored
  boost::multi_index::indexed_by< // list of indexes
    boost::multi_index::hashed_unique<  //hashed index over 'l'
      boost::multi_index::tag<IndexByL>, // give that index a name
      boost::multi_index::member<X, long long, &X::l> // what will be the index's key
    >,
    boost::multi_index::ordered_unique<  //ordered index over 'i1'
      boost::multi_index::tag<IndexByI1>, // give that index a name
      boost::multi_index::member<X, int, &X::i1> // what will be the index's key
    >,
    boost::multi_index::hashed_non_unique<  //hashed non-unique index over 'i2'
      boost::multi_index::tag<IndexByI2>, // give that index a name
      boost::multi_index::member<X, int, &X::i2> // what will be the index's key
    >
  >
>;

就是这样,我们有一个容器。接下来,这是我们如何使用它:

Container c;  // empty container
X x1{...}, x2{...}, x3{...};  // some data

// Insert some elements
auto& indexByL = c.get<IndexByL>(); // here's where index tags (=names) come in handy
indexByL.insert(&x1);
indexByL.insert(&x2);
indexByL.insert(&x3);

// Look up by i1
auto& indexByI1 = c.get<IndexByI1>();
auto itFound = indexByI1.find(42);
if (itFound != indexByI1.end())
{
  X *x = *itFound;
}

// Look up by i2
auto& indexByI2 = c.get<IndexByI2>();
size_t numberOfHundreds = indexByI2.count(100);

[Live example]

现在,一些关于野兽一般如何运作的散文。

您通过指定它将存储的对象类型(X* 在您的情况下)和一个或多个可用于访问存储对象的索引来定义多索引容器。将索引视为访问数据的接口。

索引可以有不同的种类:

  • 基于按键排序的索引(想想 std::setstd::map
  • 基于键排名的索引(认为相同加上容易访问第 n 个元素)
  • 基于散列键的索引(想想 std::unordered_setstd::unordered_map
  • 基于稳定访问顺序的索引(认为 std::list
  • 基于稳定顺序随机访问的索引(想想std::vector

基于键的索引也可以是唯一的(如 std::map)或非唯一的(如 std::multimap)。

定义容器时,您将希望拥有的每个索引作为一个模板参数传递给 boost::multi_index::indexed_by。 (在我们上面的例子中,我添加了三个索引)。

对于不使用键的索引(稳定顺序和随机访问),不需要指定任何内容;你只要说 "I want such an index."

对于基于键的索引,您还需要指定如何从数据中获取键。这就是密钥提取器发挥作用的地方。 (这些是示例中 boost::multi_index::member 的三种用法)。基本上,对于每个索引,您提供一个方法(或算法)来从存储在容器中的数据中派生密钥。当前可用的密钥提取器是:

  • 使用元素本身:identity
  • 使用元素的数据成员:member
  • 使用元素的(常量)成员函数:[const_]mem_fun
  • 使用全局函数:global_fun
  • 将多个密钥提取器合并为一个:composite_key

请注意,密钥提取器能够透明地取消引用指针。也就是说,如果您的数据元素是指向 class C 的指针,您可以在 class C 上指定密钥提取器,并且取消引用将自动发生。 (这个属性也用在例子中)

这样就定义了一个带索引的容器。要访问索引,您可以在容器上调用 get 成员函数模板。您可以通过索引在 indexed_by 的模板参数列表中的序号来引用索引。然而,为了更具可读性的操作,您可以为每个索引(或其中的一些)引入一个标签。标签是任意类型(通常是具有合适名称的空结构),它允许您将该类型用作 get 的模板参数,而不是索引的序号。 (示例中也使用了这个)。

一旦从容器中检索到对索引的引用,就可以像使用索引对应的数据结构(映射、哈希集、向量...)一样使用它。通过该索引所做的更改将影响整个容器。