std::reverse_iterator::base

chromium code

  1: // base\containers\mru_cache.h 中
  2: // MRUCache entries are often processed in reverse order, so we add this
  3: // convenience function (not typically defined by STL containers).
  4: reverse_iterator Erase(reverse_iterator pos) {
  5:   // We have to actually give it the incremented iterator to delete, since
  6:   // the forward iterator that base() returns is actually one past the item
  7:   // being iterated over.
  8:   return reverse_iterator(Erase((++pos).base()));
  9: }

 

Iterator base() const;

(until C++17)

constexpr Iterator base() const;

(since C++17)

Returns the underlying base iterator. That is std::reverse_iterator(it).base() == it.

The base iterator refers to the element that is next (from the std::reverse_iterator::iterator_typeperspective) to the element the reverse_iterator is currently pointing to. That is &*(rit.base() - 1) == &*rit.

Parameters

(none)

Return value

The underlying iterator.

Exceptions

(none)

Example

  1: #include <iostream>
  2: #include <iterator>
  3: #include <vector>
  4: int main() {
  5:   std::vector<int> v = { 0, 1, 2, 3, 4, 5 };
  6:   using RevIt = std::reverse_iterator<std::vector<int>::iterator>;
  7:   RevIt r_end(v.begin());
  8:   RevIt r_begin(v.end());
  9:   for (auto it = r_end.base(); it != r_begin.base(); ++it) {
 10:     std::cout << *it << " ";
 11:   }
 12:   std::cout << "\n";
 13: }

Output:

0 1 2 3 4 5

调用reverse_iterator的base成员函数可以产生“对应的”iterator，但这句话有些辞不达意。

举个例子，看一下这段代码，我们首先把从数字1-5放进一个vector中，然后产生一个指向3的reverse_iterator，并且通过reverse_iterator的base初始化一个iterator：

  1: vector<int> v;
  2: v.reserve(5); // 参见条款14
  3: for(int i = 1；i <= 5; ++ i) { // 向vector插入1到5
  4:   v.push_back(i);
  5: }
  6: vector<int>::reverse_iterator ri = find(v.rbegin(), v.rend(), 3); // 使ri指向3
  7: vector<int>::iterator i(ri.base()); // 使i和ri的base一样 

执行上述代码后，可以想到产生的结果就像这样：

这张图很好的显示了reverse_iterator和它对应的base iterator之间特有的偏移量，就像rbegin()和rend()与相关的begin()和end()一样，但并没有说出了所有你需要知道的东西。特别是，它并没有解释怎样在ri上实现你在i上想要完成的操作。

有些容器的成员函数只接受iterator类型的参数。

如果你想要在ri所指的位置插入一个新元素，你不能直接这么做，因为vector的insert函数不接受reverse_iterator。

如果你想要删除ri 所指位置上的元素也会有同样的问题。erase成员函数会拒绝reverse_iterator，坚持要求iterator。

为了完成删除和一些形式的插入操作，你必须先通过base函数将reverse_iterator转换成iterator，然后用iterator来完成工作。

先让我们假设你要在ri指出的位置上把一个新元素插入v。特别的，我们假设你要插入的值是99。记住ri在上图中遍历的顺序是自右向左，而且插入操作会将新元素插入到ri位置，并且将原先ri位置的元素移到遍历过程的“下一个”位置，我们认为3应该出现在99的左侧。插入操作之后，v看起来像这样：

当然，我们不能用ri来指定插入的地方，因为它不是一个iterator。我们必须用i来代替。如上所述，当ri指向3时，i（就是ri.base()）指向4。

如果我们用ri来指定插入位置，那么用i指向插入位置，那个假设就是正确的。结论呢？要实现在一个reverse_iterator ri指出的位置上插入新元素，在ri.base()指向的位置插入就行了。对于insert操作而言，ri和ri.base()是等价的，而且ri.base()真的是ri对应的iterator。

现在再来考虑删除元素的情况。回顾一下最初的vector（也就是在插入99之前）ri与i的关系：

如果你要删除ri指向的元素，你不能直接使用i了，因为i与ri不是指向同一个元素。因此，你要删除的是i的前一个元素。要实现在一个reverse_iterator ri指出的位置上删除元素，就应该删除ri.base()的前一个元素。对于删除操作而言，ri和ri.base()并不等价，而且ri.base()不是ri对应的iterator。
我们还是有必要看看删除操作的代码，因为它还挺令人惊讶的。

  1: vector<int> v;
  2:  // 向v插入1到5，同上
  3: vecot<int>::reverse_iterator ri = find(v.rbegin(), v.rend(), 3); // 同上，ri指向3
  4: v.erase(--ri.base()); // 尝试删除ri.base()前面的元素；对于vector，一般来说编译不通过 

这个设计并不存在什么问题。表达式--ri.base()确实能够指出我们需要删除的元素。而且，它们能够处理除了vector和string之外的其他所有容器。它可能也能处理vector和string，但对于大多数vector和string的实现，它无法通过编译。在这样的实现下，iterator（和const_iterator）会采用内建的指针来实现，所以ri.base()的结果是一个指针。C和C++都规定了不能直接修改函数返回的指针，所以在string和vector的迭代器是指针的STL平台上，像--ri.base()这样的表达式无法通过编译。要移植从一个由reverse_iterator指出的位置删除元素时，你应该尽量避免修改base的返回值。没问题。如果你不能减少调用base的返回值， 只需要先增加reverse_iterator的值，然后再调用base！

  1: // 同上
  2: v.erase((++ri).base()); // 删除ri指向的元素；
  3: // 这下编译没问题了！ 

因为这个方法适用于所有的标准容器，这是删除一个由reverse_iterator指出的元素时首选的技巧。
现在已经很清楚了，reverse_iterator的base成员函数返回一个“对应的”iterator的说法并不准确。对于插入操作而言，的确如此；但是对于删除操作，并非如此。当需要把reverse_iterator转换成iterator的时候，有一点非常重要的是你必须知道你准备怎么处理 返回的iterator，因为只有这样你才能决定你得到的iterator是否是你需要的。