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);
[现场示例]
现在,一些关于野兽一般如何工作的散文。
您可以通过指定它将存储的对象类型(X*
在您的情况下)以及可用于访问存储对象的一个或多个索引来定义多索引容器。将索引视为访问数据的接口。
索引可以是不同的类型:
- 基于键排序的索引(想想
std::set
或std::map
)
- 基于键排名的索引(认为相同并且易于访问第n个元素)
- 基于散列键的索引(想想
std::unordered_set
或std::unordered_map
)
- 基于稳定顺序访问的索引(想想
std::list
)
- 基于稳定顺序随机访问的索引(想想
std::vector
)
基于键的索引也可以是唯一的(like std::map
)或非唯一的(like std::multimap
)。
定义容器时,您将希望拥有的每个索引作为一个模板参数传递给boost::multi_index::indexed_by
. (在上面的示例中,我添加了三个索引)。
对于不使用密钥的索引(稳定顺序和随机访问),不需要指定任何内容;你只是说“我想要这样一个索引”。
对于基于键的索引,您还需要指定如何从数据中获取键。这就是关键提取器发挥作用的地方。(这些是boost::multi_index::member
示例中的三种用法)。基本上,对于每个索引,您都提供了一个配方(或算法),用于从存储在容器中的数据中获取密钥。当前可用的密钥提取器有:
- 使用元素本身:
identity
- 使用元素的数据成员:
member
- 使用元素的(常量)成员函数:
[const_]mem_fun
- 使用全局函数:
global_fun
- 将多个密钥提取器合并为一个:
composite_key
请注意,密钥提取器能够透明地取消引用指针。也就是说,如果您的数据元素是指向 class 的指针C
,您可以在 class 上指定键提取器,C
并且取消引用将自动发生。(示例中也使用了此属性)。
这样就定义了一个带有索引的容器。要访问索引,请调用get
容器上的成员函数模板。您可以通过其在模板参数列表中的序号来引用索引indexed_by
。但是,为了更易读的操作,您可以为每个索引(或其中一些索引)引入一个标签。标记是任意类型(通常是具有合适名称的空结构),它允许您将该类型用作模板参数,get
而不是索引的序号。(这也用于示例中)。
一旦从容器中检索到对索引的引用,就可以像使用索引对应的数据结构(map、hashset、vector...)一样使用它。通过该索引所做的更改将影响整个容器。