C++圖解單向鏈表類模板和iterator迭代器類模版詳解

Posted on by

鏈表用來構建許多其它數據結構，如堆棧，隊列和他們的派生。

對於非線性的鏈表，可以參見相關的其他數據結構，例如二叉樹、圖等。

1.鏈表介紹

常見的線性鏈表分為三種

單鏈表: 每個結點都含有指向其後繼結點的地址信息

雙向鏈表: 每個結點都有指向其前驅結點和後繼結點的地址信息

循環雙向鏈表: 在雙向鏈表的基礎上,將數據結點頭的前驅信息保存數據結點尾部地址,數據結點尾部的後驅信息保存數據結點頭地址、

鏈表中包含的關鍵詞如下所示:

  • 鏈表頭: 也就是head指針, 每次訪問鏈表時都可以從這個頭指針依次遍歷鏈表中的每個元素
  • 頭結點: 數據內容無效,指向數據結點
  • 數據結點: 存儲數據元素的結點
  • 尾結點：數據內容無效,位於數據結點尾部,標志最後一個結點

對於鏈表而言,鏈表頭必須存在。而頭結點和尾結點在有些鏈表中是不存在的,但是擁有頭結點會有很大的好處

擁有頭結點的好處:

每次插入刪除時,無需判斷是否為第一個結點(對於無頭結點的鏈表,每次都要判斷如果是第一個結點,需要將前驅信息設置為鏈表頭,並且將鏈表頭的後繼信息設置為第一個結點)

如果是雙向循環鏈表(下章實現),我們可以通過頭結點的前驅節點輕松獲取到最後一個數據結點,從而實現append函數進行尾部插入結點,無需每次遍歷鏈表至末尾再插入結點.

1.1 單鏈表插入某個節點流程

如下圖所示:

從頭結點開始遍歷,通過要插入的索引號-1找到pre指針後,代碼如下所示:

Node* pre = getNode(i-1);     // 獲取上個節點
Node* node = new Node();      // new一個新節點
node->data = value;           // 設置data數據元素
node->next = pre->next;       // 將新節點的next鏈接到下個節點
pre->next = node;             // 將前個節點的next鏈接到創建的新節點
m_length += 1;

1.2 單鏈表刪除某個節點流程

如下圖所示:

從頭結點開始遍歷,通過要刪除的索引號-1找到current指針的前一個結點pre後,代碼如下所示:

Node* pre = getNode(i-1);
Node* current = pre->next;     // 獲取要刪除的節點
pre->next = current->next;     // 將當前節點的下個節點鏈接到前一個的next中
delete current;                // delete空閑的節點
m_length -= 1;

1.3 單鏈表清除所有節點流程

代碼如下所示:

    while(m_header.next) {
        Node* node = m_header.next;
        m_header.next = node->next;
        delete node;
    }
    m_length = 0;

2.實現單鏈表

需要實現的函數:

int length() : 獲取鏈表數據長度

void clear() : 清空鏈表所有數據

Node* getNode(int i): 獲取i處的節點

bool insert(int i, const T& value) : 在索引號i處插入一個新的數據

bool remove(int i) : 刪除鏈表中索引號i所在的數據

T get(int i): 獲取i處的數據

bool set(int i, const T& value): 設置i處的數據

void append(const T &value) ：在鏈表尾部追加一個新的數據

void prepend(const T &value) : 在鏈表頭部插入一個新的數據

void clear() : 清空鏈表內容

LinkedList& operator << (const T& value):  重寫<<操作符,方便尾部追加數據

int indexOf(const T &value, int from =0) : 在鏈表中向前查找value所在的索引號.默認從from索引號0(表頭)開始.如果未找到則返回-1.

2.1indexOf()函數示例如下所示:

LinkedList<int> list;
list << 1 << 2 << 4 << 2 << 6;
cout<<"from index0 find 2 :"<<list.indexOf(2)<<endl;    //returns 1
cout<<"from index1 find 2 :"<<list.indexOf(2, 1)<<endl; //returns 1
cout<<"from index2 find 2 :"<<list.indexOf(2, 2)<<endl; //從索引號2開始查找,returns 3
cout<<"from index0 find 3 :"<<list.indexOf(3)<<endl;    //returns -1

打印效果如下所示:

本章SingleLinkedList.h的整個代碼實現如下所示(包含迭代器類):

#ifndef SingleLinkedLIST_H
#define SingleLinkedLIST_H
#include "throw.h"
// throw.h裡面定義瞭一個ThrowException拋異常的宏,如下所示:
//#include <iostream>
//using namespace std;
//#define ThrowException(errMsg)  {cout<<__FILE__<<" LINE"<<__LINE__<<": "<<errMsg<<endl; (throw errMsg);}
/*鏈表節點類模板*/
template <typename T>
struct SingleLinkedNode
{
    inline SingleLinkedNode(){ }
    inline SingleLinkedNode(const T &arg): value(arg) { }
    SingleLinkedNode *next;        // 後驅節點
    T value;                 // 節點值
};
/*單鏈表類模板*/
template <class T>
class SingleLinkedList
{
protected:
    typedef SingleLinkedNode<T> Node;
    Node m_header;          // 頭節點
    int m_length;
public:
    SingleLinkedList() { m_header.next = nullptr; m_length = 0; }
    ~SingleLinkedList() { clear(); }
    void append(const T &value) { insert(m_length, value);}
    void prepend(const T &value) {insert(0, value);}
    int length()  {return m_length;}
    Node* begin() {return m_header.next;}
    static bool rangeValid(int i,int len)  {return ((i>=0) && (i<len));}
    /*獲取i位置處的節點*/
    Node* getNode(int i)
    {
        Node* ret = &m_header;
        while((i--)>-1) {       // 由於有頭節點所以,i為0時,其實ret = m_header->n
            ret = ret->next;
        }
        return ret;
    }
    /*插入一個新的節點*/
    bool insert(int i, const T& value)
    {
        if (!((i>=0) && (i<=m_length))) {
            ThrowException("Invalid parameter i to get value ...");
            return false;
        }
        Node* pre = getNode(i-1);
        Node* node = new Node(value);    // new一個新節點
        node->next = pre->next;          // 將新節點的next鏈接到下個節點
        pre->next = node;                // 將前個節點的next鏈接到創建的新節點
        m_length +=1;
        return true;
    }
    /*刪除一個節點*/
    bool remove(int i)
    {
        if (!rangeValid(i, m_length)) {
            ThrowException("Invalid parameter i to get value ...");
            return false;
        }
        Node* pre = getNode(i-1);
        Node* current = pre->next;		 // 獲取要刪除的節點
        pre->next = current->next;       // 將當前節點的下個節點鏈接到前一個的next中
        delete current;                  // delete空閑的節點
        m_length -=1;
        return true;
    }
    /*獲取節點數據*/
    T get(int i)
    {
        T ret;
        if (!rangeValid(i, m_length)) {
            ThrowException("Invalid parameter i to get value ...");
        } else {
            ret = getNode(i)->value;
        }
        return ret;
    }
    /*設置節點*/
    bool set(int i, const T& value)
    {
        if (!rangeValid(i, m_length)) {
            ThrowException("Invalid parameter i to get value ...");
            return false;
        }
        getNode(i)->value = value;
        return true;
    }
    void clear()
    {
        while(m_header.next) {
            Node* node = m_header.next;
            m_header.next = node->next;
            delete node;
        }
        m_length = 0;
    }
    SingleLinkedList<T>& operator << (const T& value)
    {
        append(value);
        return *this;
    }
    /*在鏈表中向前查找value所在的索引號.默認從from索引號0(表頭)開始.如果未找到則返回-1.*/
    int indexOf(const T &value, int from =0)
    {
        int ret = 0;
        Node* node = m_header.next;
        while(node) {
           if (ret >= from && node->value == value) {
               return ret;
           }
           node = node->next;
           ret+=1;
        }
        return -1;
    }
};
/*單鏈表迭代器類模板*/
template <class T>
class SingleLinkedListIterator
{
    typedef SingleLinkedNode<T> Node;
    SingleLinkedList<T> *list;
    Node *m_current;     // 當前指標
public:
    explicit SingleLinkedListIterator(SingleLinkedList<T> &l):list(&l) { m_current = l.begin(); }
    void toBegin() { m_current = list->begin(); }
    bool hasNext()  { return (m_current); }
    T& next() { Node *ret = m_current;  m_current = m_current->next; return ret->value; }
    T& value()
    {
        if (m_current == nullptr) {
            ThrowException(" Current value is empty ...");
        }
        return m_current->value;
    }
    T& move(int i)  {
        if (!list->rangeValid(i, list->length())) {
            ThrowException("Invalid parameter i to get value ...");
        }
        m_current = list->getNode(i);
        return value();
    }
};
#endif // SingleLinkedLIST_H

測試代碼如下所示:

    SingleLinkedList<int> list;
    for(int i = 0; i< 5; i++)
      list.append(i);
    for(int i = 0; i< 5; i++)
      list<<i+5;
    cout<<"print:"<<endl;
    cout<<"list.length:"<<list.length()<<endl;
    for(int i = 0; i< list.length(); i++){
        cout<<" "<<list.get(i)<<" ";
    }
    cout<<endl;
    // 修改鏈表數據
    list.set(1,100);
    list.set(2,200);
    list.remove(3);
    list.insert(5,500);
    cout<<"changed:"<<endl;
    cout<<"list.length:"<<list.length()<<endl;
    for(int i = 0; i< list.length(); i++){
        cout<<" "<<list.get(i)<<" ";
    }
    cout<<endl;

運行打印:

3.實現一個迭代器來優化鏈表遍歷

迭代器（iterator）有時又稱光標（cursor）是程序設計的軟件設計模式，可在容器對象（container，例如鏈表或數組）上遍訪的接口，設計人員無需關心容器對象的內存分配的實現細節。

3.1 為什麼要實現一個迭代器?

比如我們剛剛寫的遍歷鏈表代碼:

for(int i = 0; i< list.length(); i++){        // 時間復雜度為O(n)
        cout<<" "<<list.get(i)<<" ";         // get函數的時間復雜度為O(n)
}

每次for循環調用鏈表的get時,都會重復去遍歷鏈表,所以遍歷一個鏈表需要的時間復雜度為O(n^2),所以我們需要實現迭代器來優化鏈表遍歷

迭代器需要實現以下幾個函數:

  • bool hasNext(): 是否有下個節點
  • T &next(): 移動光標到下一個節點,並返回之前的值
  • T &value(): 獲取當前光標的節點數據
  • void toBegin(): 將迭代器的光標定位到開頭位置
  • T& move(int i): 將迭代器當前光標定位到i位置處,並返回當前位置的值

迭代器類實現如下所示:

/*單鏈表迭代器類模板*/
template <class T>
class SingleLinkedListIterator
{
    typedef SingleLinkedNode<T> Node;
    SingleLinkedList<T> *list;
    Node *m_current;     // 當前指標
public:
    explicit SingleLinkedListIterator(SingleLinkedList<T> &l):list(&l) { m_current = l.begin(); }
    void toBegin() { m_current = list->begin(); }
    bool hasNext()  { return (m_current); }
    T& next() { Node *ret = m_current;  m_current = m_current->next; return ret->value; }
    T& value()
    {
        if (m_current == nullptr) {
            ThrowException(" Current value is empty ...");
        }
        return m_current->value;
    }
    T& move(int i)  {
        if (!list->rangeValid(i, list->length())) {
            ThrowException("Invalid parameter i to get value ...");
        }
        m_current = list->getNode(i);
        return value();
    }
};

示例代碼如下所示:

    SingleLinkedList<int> list;
    list<<1<<4<<5<<6<<8;
    SingleLinkedListIterator<int> it(list);
    cout<<"print:"<<endl;
    cout<<"list.length:"<<list.length()<<endl;
    while (it.hasNext())        // 通過迭代器讓時間復雜度為O(n)
        cout<<it.next()<<endl;
    cout<<endl;
    cout<<"moved:"<<endl;
    it.move(2);
    while (it.hasNext())        // 通過迭代器讓時間復雜度為O(n)
        cout<<it.next()<<endl;

打印如下所示:

總結

本篇文章就到這裡瞭，希望能夠給你帶來幫助，也希望您能夠多多關註WalkonNet的更多內容!    

推薦閱讀：