Python数据结构篇（一）—— 顺序栈和链栈的实现

一、前言

如果是研究算法的小伙伴，可能会经常用到栈、队列、单链表、双链表等数据结构，而Python语言中本身是没有这些数据结构的，不像C/C++可以直接调用STL库。在这里笔者将会通过几篇博客详细介绍在Python中实现上述常用的数据结构，因此本文主要面向初学Python算法和数据结构的小伙伴们。

二、顺序栈的实现

虽然在Python中没有栈这一数据结构，但是Python有更强大的列表list。list其实是Python内嵌数据结构中使用最多的，它功能十分强大。我们通常所说的栈其实指的是顺序栈，这里将通过list来实现顺序栈。主要的实现代码如下：

	class Stack:
	    """
	    Sequential Stack implement
	    """
	
	    def __init__(self):
	        """
	        initialize an empty Stack, __stack means it's a private member
	        """
	        self.__stack = []
	
	    def top(self):
	        """
	        get the top element of Stack
	        :return: if Stack is empty return None, else return the top element
	        """
	        return None if self.isEmpty() else self.__stack[-1]
	
	    def push(self, obj):
	        """
	        push an element into Stack
	        :param obj: object to be pushed
	        """
	        self.__stack.append(obj)
	
	    def pop(self):
	        """
	        pop the top element from Stack
	        :return: if Stack is empty return None, else return the popped element
	        """
	        return None if self.isEmpty() else self.__stack.pop()
	
	    def clear(self):
	        """
	        clear the whole Stack
	        """
	        self.__stack.clear()
	
	    def isEmpty(self):
	        """
	        judge the Stack is empty or not
	        :return: bool value
	        """
	        return self.length() == 0
	
	    def length(self):
	        """
	        get the length of Stack
	        :return:
	        """
	        return len(self.__stack)

上面各个函数的功能都有注释，也不用多说了，值得注意的有两点：

1. 在取栈顶元素（top方法）和出栈操作（pop方法）的时候，一定要处理栈为空的情况，不然会抛出索引越界的错误。
2. 对比C/C++、Java语言中的类实现，可以发现类的数据成员通常分为public、protected、private三种，虽然在Python中没有这三个修饰符，但是Python同样可以为数据成员定义访问权限。
   （1）如果要设定公有的成员，无需其他操作，直接self加上数据成员即可，比如self.stack；
   （2）如果要设定受保护的成员，需在数据成员之前添加单个下划线 _ ，比如self._stack；
   （3）如果要设定私有的成员，需在数据成员之前添加两个下划线 __ ，如上面初始化函数中所示的self.__stack。

三、链栈的实现

要实现链式栈，首先需要定义链式节点，链式节点需要两个属性：一个是用于存储当前节点的值，另一个是指向下一个节点的指针。链式节点的定义如下：

	class LinkNode:
	    """
	    Link Node definition
	    """
	
	    def __init__(self):
	        self.data = None
	        self.next = None

有了上述链式节点的定义，那么我们就能够很好地实现链式栈了，具体的实现代码如下所示。关于链式栈的方法也有注释进行说明，相信大家都能看懂，需要注意的也在前面说明了。

	class LinkStack:
	    """
	    Link Stack implement
	    """
	
	    def __init__(self):
	        """
	        initialize an empty Link Stack
	        """
	        self.__link_stack = LinkNode()
	
	    def top(self):
	        """
	        get the top element of Link Stack
	        :return: if Link Stack is empty return None, else return the top element
	        """
	        return None if self.isEmpty() else self.__link_stack.next.data
	
	    def push(self, obj):
	        """
	        push an element into Link Stack
	        :param obj: object to be pushed
	        """
	        node = LinkNode()
	        node.data = obj
	        node.next = self.__link_stack.next
	        self.__link_stack.next = node
	
	    def pop(self):
	        """
	        pop the top element from Link Stack
	        :return: if Link Stack is empty return None, else return the popped element
	        """
	        if self.isEmpty():
	            return None
	        else:
	            next_node = self.__link_stack.next
	            self.__link_stack.next = next_node.next
	            return next_node.data
	
	    def clear(self):
	        """
	        clear the whole Link Stack
	        """
	        self.__link_stack = LinkNode()
	
	    def isEmpty(self):
	        """
	        judge the Link Stack is empty or not
	        :return: bool value
	        """
	        return self.__link_stack.next is None
	
	    def length(self):
	        """
	        get the length of Link Stack
	        :return:
	        """
	        count = 0
	        curr_node = self.__link_stack.next
	        while curr_node:
	            count += 1
	            curr_node = curr_node.next
	        return count

四、其他数据结构实现

关于其他常用数据结构的实现，可参考下面的链接：

1. Python数据结构篇（二）—— 顺序队列和优先队列的实现
2. Python数据结构篇（三）—— 链表的实现（待更新）
3. Python数据结构篇（四）—— 二叉树的实现（待更新）