C++ STL迭代器原理和實作-有解無憂

1. 迭代器簡介

為了提高C++編程的效率，STL（Standard Template Library）中提供了許多容器，包括vector、list、map、set等，然而有些容器（vector）可以通過下標索引的方式訪問容器里面的資料，但是大部分的容器（list、map、set）不能使用這種方式訪問容器中的元素，為了統一訪問不同容器時的訪問方式，STL為每種容器在實作的時候設計了一個內嵌的iterator類，不同的容器有自己專屬的迭代器（專屬迭代器負責實作對應容器訪問元素的具體細節），使用迭代器來訪問容器中的資料，除此之外，通過迭代器可以將容器和通用演算法結合在一起，只要給予演算法不同的迭代器，就可以對不同容器執行相同的操作，例如find查找函式（因為迭代器提供了統一的訪問方式，這是使用迭代器帶來的好處），迭代器對一些基本操作如*、->、++、==、!=、=進行了多載，使其具有了遍歷復雜資料結構的能力，其遍歷機制取決于所遍歷的容器，所有迭代器的使用和指標的使用非常相似，通過begin，end函式獲取容器的頭部和尾部迭代器，end迭代器不包含在容器之內，當begin和end回傳的迭代器相同時表示容器為空，

STL主要由 容器、迭代器、演算法、函式物件、和記憶體分配器 五大部分構成，

2. 迭代器的實作原理

首先，看看STL中迭代器的實作思路：

從上圖中可以看出，STL通過型別別名的方式實作了對外統一；在不同的容器中型別別名的真實迭代器型別是不一樣的，而且真實迭代器型別對于++、--、*、->等基本操作的實作方式也是不同的，（PS：迭代器很好地詮釋了介面與實作分離的意義）

既然我們已經知道了迭代器的實作思路，現在如果讓我們自己設計一個list容器的簡單迭代器，應該如何實作呢？

list類需要有操作迭代器的方法
1. begin/end
2. insert/erase/emplace
list類有一個內部類list_iterator
1. 有一個成員變數ptr指向list容器中的某個元素
2. iterator負責多載++、--、*、->等基本操作
list類定義內部類list_iterator的型別別名

以上就是實作一個list容器的簡單迭代器需要考慮的具體細節，

3. 迭代器的簡單實作

my_list.h（重要部分有注釋說明）

//
// Created by wengle on 2020-03-14.
//

#ifndef CPP_PRIMER_MY_LIST_H
#define CPP_PRIMER_MY_LIST_H

#include <iostream>

template<typename T>
class node {
public:
    T value;
    node *next;
    node() : next(nullptr) {}
    node(T val, node *p = nullptr) : value(val), next(p) {}
};

template<typename T>
class my_list {
private:
    node<T> *head;
    node<T> *tail;
    int size;

private:
    class list_iterator {
    private:
        node<T> *ptr; //指向list容器中的某個元素的指標

    public:
        list_iterator(node<T> *p = nullptr) : ptr(p) {}
        
        //多載++、--、*、->等基本操作
        //回傳參考，方便通過*it來修改物件
        T &operator*() const {
            return ptr->value;
        }

        node<T> *operator->() const {
            return ptr;
        }

        list_iterator &operator++() {
            ptr = ptr->next;
            return *this;
        }

        list_iterator operator++(int) {
            node<T> *tmp = ptr;
            // this 是指向list_iterator的常量指標，因此*this就是list_iterator物件，前置++已經被多載過
            ++(*this);
            return list_iterator(tmp);
        }

        bool operator==(const list_iterator &t) const {
            return t.ptr == this->ptr;
        }

        bool operator!=(const list_iterator &t) const {
            return t.ptr != this->ptr;
        }
    };

public:
    typedef list_iterator iterator; //型別別名
    my_list() {
        head = nullptr;
        tail = nullptr;
        size = 0;
    }

    //從鏈表尾部插入元素
    void push_back(const T &value) {
        if (head == nullptr) {
            head = new node<T>(value);
            tail = head;
        } else {
            tail->next = new node<T>(value);
            tail = tail->next;
        }
        size++;
    }

    //列印鏈表元素
    void print(std::ostream &os = std::cout) const {
        for (node<T> *ptr = head; ptr != tail->next; ptr = ptr->next)
            os << ptr->value << std::endl;
    }

public:
    //操作迭代器的方法
    //回傳鏈表頭部指標
    iterator begin() const {
        return list_iterator(head);
    }

    //回傳鏈表尾部指標
    iterator end() const {
        return list_iterator(tail->next);
    }

    //其它成員函式 insert/erase/emplace
};

#endif //CPP_PRIMER_MY_LIST_H

test.cpp

//
// Created by wengle on 2020-03-14.
//

#include <string>
#include "my_list.h"

struct student {
    std::string name;
    int age;

    student(std::string n, int a) : name(n), age(a) {}

    //多載輸出運算子
    friend std::ostream &operator<<(std::ostream &os, const student &stu) {
        os << stu.name << " " << stu.age;
        return os;
    }
};

int main() {
    my_list<student> l;
    l.push_back(student("bob", 1)); //臨時量作為實參傳遞給push_back方法
    l.push_back(student("allen", 2));
    l.push_back(student("anna", 3));
    l.print();

    for (my_list<student>::iterator it = l.begin(); it != l.end(); it++) {
        std::cout << *it << std::endl;
        *it = student("wengle", 18);
    }
    return 0;
}

4. 迭代器失效

// inserting into a vector
#include <iostream>
#include <vector>

int main ()
{
  std::vector<int> myvector (3,100);
  std::vector<int>::iterator it;

  it = myvector.begin();
  it = myvector.insert ( it , 200 );

  myvector.insert (it,200,300);
  //it = myvector.insert (it,200,300);
  myvector.insert (it,5,500); //當程式執行到這里時，大概率會crash
  for (std::vector<int>::iterator it2=myvector.begin(); it2<myvector.end(); it2++)
    std::cout << ' ' << *it2;
  std::cout << '\n';

  return 0;
}

上面的代碼很好地展示了什么是迭代器失效？迭代器失效會導致什么樣的問題？
當執行完myvector.insert (it,200,300);這條陳述句后，實際上myvector已經申請了一塊新的記憶體空間來存放之前已保存的資料和本次要插入的資料，由于it迭代器內部的指標還是指向舊記憶體空間的元素，一旦舊記憶體空間被釋放，當執行myvector.insert (it,5,500);時就會crash（PS：因為你通過iterator的指標正在操作一塊已經被釋放的記憶體，大多數情況下都會crash)，迭代器失效就是指：迭代器內部的指標沒有及時更新，依然指向舊記憶體空間的元素，

insert原始碼

上圖展示了STL原始碼中vector容器insert方法的實作方式，當插入的元素個數超過當前容器的剩余容量時，就會導致迭代器失效，這也是測驗代碼中myvector.insert (it,200,300);插入200個元素的原因，為了模擬超過當前容器剩余容量的場景，如果你的測驗環境沒有crash，可以將插入元素設定的更多一些，

5. 參考資料

Iterator invalidation rules
迭代器失效問題？

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/56850.html

標籤：C++

上一篇：題解 P5116 【[USACO18DEC]Mixing Milk】

下一篇：關于C++的例外拋出