C++ STL 迭代器失效問題

本文有更新，請移步我的個人博客：https://blog.andyqiao.top/article/17/

　　

之前看《C++ Primier》的時候，也解到在順序型窗口里insert/erase會涉及到迭代器失效的問題，並沒有深究。今天寫程序的時候遇到了這個問題。

1 莫名其妙的Erase　　

　　最初我的程序是醬紫的，別說話，我知道這樣是有問題的，可這樣是最直觀的想法

   int arr[]={0,1,2,3,4,5,6,7,8,9,10}; 
　　vector<int> a(arr,arr+sizeof(arr)/sizeof(*arr));for (auto it = a.begin(); it != a.end();++it ){
        if ((*it)&1){
            a.erase(it);
        }
    }   

　　沒錯，程序崩潰！刪除了迭代器it之后，it迭代器失效了，無法再進行++it操作了。

　　可是，當我覺得erase做的只是把it之后的元素向前移動一個位置而已，為什么迭代器失效了呢？我翻開《STL源碼剖析》，SGI STL的vector<T,Alloc>::erase的源碼是這樣的：

iterator vector<T, Alloc>::erase(iterator position)
    {
        if (position + 1 != end())
            copy(position + 1, finish, position);
        --finish;
        destroy(finish);
        return position;
    }

　　正如我所想，erase函數並沒有對輸入的position迭代器進行改寫！我打印出調試信息，發現erase之后，迭代器的_Ptr成員，也就是指針的值並沒有發生變化，而此指針所指的元素的確是下一個元素。那么為什么失效了呢？

　　我又查了《C++ Primier》，發現此書上的標准寫法是這樣的：

int arr[]={0,1,2,3,4,5,6,7,8,9,10}; 
　　vector<int> a(arr,arr+sizeof(arr)/sizeof(*arr));
    for (auto it = a.begin(); it != a.end();){
        if ((*it)&1){
            it=a.erase(it);
        }
        else
            ++it;    
    }  

　　運行了一下，這樣是沒錯的。我打印了調試信息，發現與之前一樣，erase之后把結果賦給it，it里的成員_Ptr並沒有發生變化。唯一的可能就是迭代器里還有別的標志，如果當前元素被刪除之后，該迭代器也就“失效”了。《C++ Primier》並未對此作出過多解釋，只是說，erase函數返回被刪除元素的下一個元素的迭代器。

　　結論：在STL里，我們不能以指針來看待迭代器，指針是與內存綁定的，而迭代器是與容器里的元素綁定的，刪除了之后，該迭代器就失效了，在對其重新賦值之前，不能再訪問此迭代器。

2 更加小心冀冀地Insert

　　機智如我，自然會去探索一下insert之后，迭代器會怎樣。於是：　　

    vector<int> a;
    for (int i = 0; i < 10; ++i)
    {
        a.push_back(i);
    }

    for (auto it = a.begin(); it != a.end(); ++it){
        if (*it == 5){ 
            a.insert(it, 100);
　　　　　　　++it;
        }
    }        

　　你猜怎么着？？

　　啥事兒沒有！你可能會問，插入之后為什么要++it。插入之前，it指向5，在5之前插入100后，it指向100。這樣下一次循環，it依然會指向5。相信我，你的程序會爆炸的！

　　我作了個++it之后，it又指向5，下一次循環就直接指向5之后的元素了，順利完成插入工作。

　　世界和平~世界和平~我還真不確定。

　　突然想到，當插入元素過多，vector的capacity會增加，這時會不會問題呢？說干就干：　　

    vector<int> a;
    for (int i = 0; i < 13; ++i)
    {
        a.push_back(i);
    }

    for (auto it = a.begin(); it != a.end(); ++it){
        if (*it == 5){ 
            a.insert(it, 100);
　　　　　　　++it;
        }
    }  

　　BOOM！果然崩潰了！也就是說插入之后的迭代器失效了。那之前的呢？

　　我決定粗暴地測試一下：

    vector<int> a;
    for (int i = 0; i < 13; ++i)
    {
        a.push_back(i);
    }
    auto it1=a.begin();
    for (auto it = it1; it != a.end(); ++it){
        if (*it == 5){ 
            a.insert(it, 100);
　　  　　　　it=it1;
        }
    }  

　　我插入之后，直接讓it指向begin()，然后單步調試。執行完it=it1還好好的，可再去執行++it還是崩潰了。

　　也就是說，capacity變化之后，所有的迭代器都失效了！這是當然了呀！capacity發生變化，容器內部做的不僅僅是增加capacity這么簡單，因為容器所在內存后面可能沒有足夠的內存讓我們使用，所以，容器要重新開辟一段足夠大的內存來存儲容器里的元素，當前內存會被釋放。這樣一來，迭代器自然失效了。

3 C++ Primier的總結

　　關於容器的迭代器失效的問題，C++ Primier用了一小節作了總結，我翻譯成中文如下：

　　（1）增加元素到容器后

　　對於vector和string，如果容器內存被重新分配，iterators,pointers,references失效；如果沒有重新分配，那么插入點之前的iterator有效，插入點之后的iterator失效；

　　對於deque，如果插入點位於除front和back的其它位置，iterators,pointers,references失效；當我們插入元素到front和back時，deque的迭代器失效，但reference和pointers有效；

　　對於list和forward_list，所有的iterator,pointer和refercnce有效。

　　（2）從容器中移除元素后

　　對於vector和string，插入點之前的iterators,pointers,references有效；off-the-end迭代器總是失效的；

　　對於deque，如果插入點位於除front和back的其它位置，iterators,pointers,references失效；當我們插入元素到front和back時，off-the-end失效，其他的iterators,pointers,references有效；

　　對於list和forward_list，所有的iterator,pointer和refercnce有效。

　　（3）在循環中refresh迭代器

　　當處理vector,string,deque時，當在一個循環中可能增加或移除元素時，要考慮到迭代器可能會失效的問題。我們一定要refresh迭代器。

int arr[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
    deque<int> v(arr,arr+sizeof(arr)/sizeof(*arr));
    for (auto it = v.begin(); it != v.end(); )
    {
        if ((*it) & 1)
        {
            it = v.insert(it, *it);
            it += 2;
        }
        else
            it = v.erase(it);
    }

　　至於it+=2，很容易解釋，insert之后，it指向新增加的元素，+2之后，it指向下一個要處理的元素。

　　（4）在循環不變式中不要store off-the-end迭代器

　　這個很容易理解了，增加或移除元素之后，off-the-end失效了，不store的話，每次從end()函數中取的都是最新的off-the-end，自然不會失效。

　　最后：《C++ Primier》是本好書。