棧與隊列(一)

在這篇文章里,我們來實現自定義的鏈式棧。首先我們來看看鏈式棧的結構及操作定義。

鏈式棧結構定義

首先,新建兩個文件,分別為 mystack.hmystack.cpp。在 mystack.h 中給出鏈式棧的結構定義及接口聲明。

#ifndef _MYSTACK_H_
#define _MYSTACK_H_
#include <iostream>

using namespace std;

typedef char ELEMTYPE;
struct Node;

typedef struct Node *PNode;

struct Node {
    ELEMTYPE info;
    PNode link;
};

struct stStack {
    PNode top;
    size_t length;
};

typedef struct stStack *PLStack;

PLStack create();
bool destroy(PLStack *pstack);

bool print(PLStack pstack);
bool clear(PLStack pstack);

bool push(PLStack pstack, ELEMTYPE x);
bool pop(PLStack pstack);
bool top(PLStack pstack, ELEMTYPE *x);

bool isEmpty(PLStack pstack);
bool isFull(PLStack pstack);

#endif

從本次實驗開始,我們使用 C++語言 的標準輸入輸出流進行程序的輸入輸出操作。

要使用 C++語言的標準輸入輸出流,我們需要在 mystack.h 頭文件中加入如下語句:

#include <iostream>

using namespace std;

C++語言中頭文件均不需要加 .h 作為后綴。iostream 頭文件對C++語言的 I/O 流進行了定義及聲明。此外,C++語言還引入了 命名空間 的概念,其本質上就是定義一個新的作用域,在該作用域范圍內再定義類、變量及函數等,從而避免不同開發者因類、變量及函數命名同名而導致的沖突問題。

因為C++的標準輸入輸出流在 std 命名空間內進行定義,因此我們需要加入using namespace std;這條語句,以便引入 std 這個命名空間。

我們接下來解釋一下 mystack.h 頭文件中各數據結構及函數聲明的含義。

首先,我們定義了兩個結構體,分別是 struct Nodestruct stStack 。其中 Node 結構用于表示鏈式棧中的節點,其包含數據域 info 以及指針域 link。而 stStack 結構體表示鏈式棧對象,其包含指向鏈式棧棧頂的 top 指針,以及表示鏈式棧包含節點元素個數的 length 變量。

其次,對于鏈式棧,我們定義其所能進行的操作如下:

  • 創建棧 : create
  • 銷毀棧 : destroy
  • 清空棧 : clear
  • 打印棧元素 : print
  • 元素入棧 : push
  • 元素出棧 : pop
  • 取棧頂元素 : top
  • 判斷棧是否為空 : isEmpty
  • 判斷棧是否為滿 : isFull

當然對于鏈式棧而言,判滿操作應該返回 true。我們在本文中給出該操作只是為了兼容性的目的。

鏈式棧接口實現

接下來我們依次來實現鏈式棧的各個接口。首先實現 create、 destroy 操作。

創建棧-create接口

創建棧接口原型如下所示:

PLStack create();

接口返回值為 PLStack 類型,該類型是 struct stStack 結構體指針,因此我們需要在接口中動態分配該結構體空間,并初始化該結構體。

由于 struct stStack結構體包含兩個域:

  • top 為鏈式棧節點指針,指向鏈式棧棧頂節點;
  • length 為鏈式棧節點元素計數器,用于記錄鏈式棧中當前節點元素個數;

初始化時,top 指針直接賦值為 NULL 即可,而由于初始化鏈式棧時,棧內無元素,因此 length 計數器直接置為 0 即可。以下是 create 接口的實現:

PLStack create()
{
    PLStack pstack = (PLStack) malloc (sizeof(struct stStack));

    if (pstack != NULL)
    {
        pstack->top = NULL;
        pstack->length = 0;
        return pstack;
    }
    
    return NULL;
}

銷毀棧-destroy接口

接下來,我們來完成銷毀棧的操作。因為是鏈式棧,元素在入棧時均需要分配新的節點空間用于存儲棧元素。因此在銷毀棧時,需要將其中每個節點的空間都釋放掉。完成節點空間釋放操作后,還需要將棧結構體(struct stStack)分配的空間也一并釋放掉。

因此這兩步操作可以分解為:

  1. 釋放棧中所有節點(清空棧節點);
  2. 釋放棧結構體指針指向的內存空間;

其中第一步操作可以利用我們后續將實現的 clear 操作來完成,而釋放棧結構體指針這直接使用 free 函數即可。以下給出銷毀棧的接口實現:

bool destroy(PLStack pstack)
{
    if (pstack == NULL)
    {
        return false;
    }
    
    clear(pstack);
    free(pstack);

    return true;
}

在銷毀棧時,我們首先判斷 pstack 指針是否為空,如果為空則不做任何操作。否則調用 clear 接口清空該棧,接著調用 free 函數釋放 pstack 指針指向的內存空間。

我們在之前的文章中講過,盡快使項目的原型運行起來,不要試圖將所有代碼編寫完成后再進行編譯。目前我們實現了 createdestroy兩個接口,但由于在 destroy 接口中還調用了 clear 接口,因此我們先實現 clear 接口后再進行編譯工作。

清空棧-clear接口

清空棧操作,需要依次將元素從棧頂逐個彈出(元素出棧,pop),直到棧為空為止(isEmpty)。可見,在 clear 接口中我們還需要調用pop、isEmpty接口。以下給出 clear 接口的實現:

bool clear(PLStack pstack)
{
    if (pstack == NULL)
    {
        return false;
    }
    
    while (!isEmpty(pstack))
    {
        pop(pstack);
    }
    
    return true;
}

判斷棧是否為空-isEmpty接口

既然清空棧 clear 接口使用到了判斷棧是否為空操作,我們接著實現 isEmptyisFull 兩個接口。

判斷棧是否為空,可以根據以下兩個情況:

  1. top 指針指向為空;
  2. length 計數器為 0;

以上兩種情況均可用于判斷棧是否為空。以下給出 isEmpty 接口的實現:

bool isEmpty(PLStack pstack)
{
    if (pstack == NULL)
    {
        return true;
    }

    return (pstack->length == 0);
}

判斷棧是否為滿-isFull接口

判斷棧是否未滿,只有在順序棧中才具有實際意義。鏈式棧因其節點均是在元素入棧時進行內存空間動態分配的。因此,此處給出的判滿接口僅僅為了兼容性的需求。

bool isFull(PLStack pstack)
{
    if (pstack == NULL)
    {
        return true;
    }
    
    return true;
}

元素出棧-pop接口

鏈式棧進行 pop 操作的示意圖如下:

元素出棧

首先判斷棧是否為空,若不為空則更新棧頂 top 指針,其次釋放原棧頂元素內存空間(由 tmp 指針指向),最后更新 length 計數器。

以下我們給出鏈式棧元素出棧操作的實現:

bool pop(PLStack pstack)
{
    PNode p;

    if (pstack == NULL)
    {
        return false;
    }
    
    if (!isEmpty(pstack))
    { 
        return false;
    }
    
    p = pstack->top;
    pstack->top = pstack->top->link;
    pstack->length = pstack->length - 1;
    free (p);
    
    return true;
}

元素入棧-push接口

鏈式棧進行 push 操作的示意圖如下:

元素入棧

首先嘗試分配新節點空間用于新入棧元素,其次更新 top 指針指向新棧頂元素,最后更新 length 計數器。

據此,我們給出鏈式棧 push 操作接口的實現:

bool push(PLStack pstack, ELEMTYPE x)
{
    if (pstack == NULL)
    {
        return false;
    }
    
    PNode p = (PNode) malloc (sizeof(struct Node));
    if (p != NULL)
    {
        p->info = x;
        p->link = pstack->top;
        pstack->top = p;
        pstack->length = pstack->length + 1;
        return true;
    }

    return false;
}

注:push 接口中,我們還應該考慮判斷棧是否為滿的情況(該情況在順序棧中需要進行考慮)。

取棧頂元素-top操作

獲取棧頂元素時,需要首先判斷棧是否為空,只有棧不為空時才可獲取棧頂元素,否則應返回操作失敗。以下是 top 操作的函數聲明:

bool top(PLStack pstack, ELEMTYPE *x);

需要引起我們注意的是,top 操作返回值為bool類型,也就是說棧頂元素并不通過函數返回值獲取,而是通過參數 ELEMTYPE 指針類型返回。這樣設計的原因很簡單,因為當棧為空時,當然無法取得棧頂,從而通過 top 操作的返回值即可知道操作是否成功。

top 操作返回為true時,可以直接通過 ELEMTYPE *x獲取到棧頂元素;但當 top 操作返回為false時,ELEMTYPE *x指針指向無意義的內存空間。

打印棧當前元素-print接口

在完成了鏈式棧的所有核心操作后,我們來完成幫助函數 print 接口的實現。 print 接口主要用于打印棧當前的所有元素,以便我們對棧的狀態有所了解。它可以在建棧后、元素入棧、元素出棧、清空棧等操作前后進行調用,以方便我們通過輸出結果觀察、判斷這些操作的業務邏輯是否正確。

如何實現 print 接口以及該接口需要輸出什么信息,取決于你需要觀察的棧狀態信息。以鏈式棧為例,我除了需要知道當前棧中所有元素以及其在棧中的位置外,我還希望知道每個棧元素的內存地址。以下給出 print 接口的實現:

bool print(PLStack pstack)
{
    PNode p;
    size_t i;
    char buffer[255];

    if (pstack == NULL)
    {
        return false;
    }
    
    p = pstack->top;
    i = length(pstack);

    #ifdef DEBUG
    cout << "---------  STACK   ----------" << endl;
    sprintf(buffer, "-------  %ld ELEMENTS ---------", i);
    cout << buffer << endl;
    #endif
    
    while (p != NULL)
    {
        sprintf(buffer, "%ld [%p] : %c", i, p, p->info);
        cout << buffer << endl;
        i--;
        p = p->link;
    }

    #ifdef DEBUG
    cout << endl;
    #endif
    
    return true;
}

print 接口中,我們通過一個 while 循環依次遍歷從棧頂到棧底的所有元素,并將每個棧元素在棧中的 節點序號 、 節點結構體內存地址節點數據域均打印輸出。

此外,在 print 接口中通過條件編譯語句#ifdef#endif語句用于在調試模式下額外輸出更多信息。

測試鏈式棧各操作接口

在講解 create、destroy 兩個操作接口的過程中,我們將鏈式棧的剩余操作接口的實現思路及過程都做了詳細的講解。

與我們之前所說的 盡可能早的讓程序跑起來 不同的事,這次實驗過程中,我們依據每個接口的實現及嵌套調用關系依次實現了所有的接口。不過這并不影響我們后續的測試工作。

以下我們給出測試主文件 main.cpp的代碼:

#include <iostream>
#include "mystack.h"

using namespace std;

int main ()
{
    PLStack pstack;
    ELEMTYPE x;

    pstack = create();

    push(pstack, 'a');
    push(pstack, 'b');
    push(pstack, 'c');

    print(pstack);

    while (!isEmpty(pstack))
    {
        top(pstack, &x);
        cout << "stack top element: " << x << endl;
        pop(pstack);
    }

    print(pstack);
    destroy(pstack);

    return 0;
}

main.cpp 中,我們對鏈式棧的絕大多數接口進行了測試,且 clear 接口在 destroy 接口中被調用。我們來看看編譯后的運行結果:

[localhost@lab02:stack xgqin]$ ls
a.out       main.cpp    mystack.cpp mystack.h
[localhost@lab02:stack xgqin]$ vim mystack.cpp 
[localhost@lab02:stack xgqin]$ g++ -DDEBUG main.cpp mystack.cpp 
[localhost@lab02:stack xgqin]$ ./a.out 
---------  STACK   ----------
-------  3 ELEMENTS ---------
3 [0x7fc6ded00030] : c
2 [0x7fc6ded00020] : b
1 [0x7fc6ded00010] : a

stack top element: c
stack top element: b
stack top element: a
---------  STACK   ----------
-------  0 ELEMENTS ---------

從運行結果結合 main.cpp 文件源碼來看,鏈式棧的各操作接口均正常,但這并不能說明我們編寫的代碼沒有問題,你可以嘗試編寫幾個額外的測試用例對接口進行測試。

總結

在本文中,我們首先給出了鏈式棧結構的定義,并給出了需要實現的接口聲明形式;其次,在各個不同接口中,我們通過嵌套調用等形式復用了不少接口,這需要大家對棧的邏輯結構保持清晰的概念;最后,我們通過一段測試代碼,對所編寫的程序進行了測試。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容