Skip to main content

Stack implementation in C++

Stack is a versatile data structure used in situations that need LIFO - last in first out. For an introduction to stack, read this post

 Data members

To implement a stack using an array, we will need an array and an index to the top of the stack. 

We can have a static array or a dynamic array. Dynamic array has the advantage that size of array can be given at run time. 

So let us have a dynamic array and also a data member called size.

class stack
{
    int max;
    int *arr;
    int top;
public:
    stack(int n);
    void push(int n);
    int pop();
    bool is_empty();
    bool is_full();
    int peek();
    ~stack();
    stack(stack&other);
};

Methods

In the constructor of this class we must initialize the data. We need to set top to -1, because we do not have any value in the stack currently. And as we are using dynamic array, we should allocate memory to array in the constructor.

We need to also write a destructor to release this memory. 

stack::stack(int size=10):max(size)
{
   top = -1;
   arr = new int[max];
}

stack::~stack()
{
    delete []arr;
}

What are the other methods needed for stack class? We know these. pop(), push(), peek(),isempty(), isfull().

push()

A push function should add a value to stack after making sure that stack is not full. After pushing the value top must be incremented.  So we need a statement of the type arr[++top]=value.   

void stack::push(int n)
{
     if(is_full())
       cout<<"Stack overflow.";
     else
 {
    arr[++top]=n;
        }
}
bool stack::is_full()
{
      return top>=max;
}

And we are using the function is_full(). The stack will be full if top == size of the array.

pop()

pop function should remove an element from the top of the stack and then decrement top. We need a statement of the type return arr[top--].

But the function should check if the stack is empty before popping.

int stack::pop()
{
    if(is_empty())
       cout<<"Stack empty";
     else
 return arr[top--];
}
bool stack::is_empty()
{
     return top==-1;
}

peek()

peek() must return the value at the top of stack without actually removing it. 

int stack::peek()
{
   return arr[top];
}

Now we are ready with all the necessary functions of the class.

Well, almost. Because now the class when used will crash your program. Why?

Because of dynamic allocation and lack of copy constructor.  If we use this class as a value parameter to any function, it will copied to a temporary object.

This copy is done using the default copy constructor provided by compiler which does not allocate memory for the array of new object. The temporary copy parameter and the original object use the same dynamic array. When the function exits, the temporary copy is destroyed using destructor. Its memory is deleted.

That leaves the original object with a dangling pointer and deleting it at the end of program gives run time error.

So we need one extra method for the class - not part of stack ADT and that is the copy constructor. This copy constructor should allocate memory for the new object and copy all the elements.

Copy constructor

stack::stack(stack&other)
{
    this->max = other.max;
    this->top = other.top;
    this->arr  = new int[max];//allocate memory
    for(int i=0;i<max;i++)//copy elements
 arr[i]=other.arr[i];
}

Let us write a program to test the class. You can download this program from here.


#include<iostream>
using  std::cin;
using std::cout;
class stack
{
    int max;
    int *arr;
    int top;
public:
    stack(int n);
    void push(int n);
    int pop();
    bool is_empty();
    bool is_full();
    int peek();
    ~stack();
    stack(stack&other);
};

stack::stack(int size=10):max(size)
{
   top = -1;
   arr = new int[max];
}

stack::~stack()
{
    delete []arr;
}
stack::stack(stack&other)
{
    this->max = other.max;
    this->top = other.top;
    this->arr  = new int[max];
    for(int i=0;i<max;i++)
 arr[i]=other.arr[i];
}

void stack::push(int n)
{
     if(is_full())
       cout<<"Stack overflow.";
     else
 {
    arr[++top]=n;
        }
}
int stack::pop()
{
    if(is_empty())
       cout<<"Stack empty";
     else
 return arr[top--];
}
bool stack::is_empty()
{
     return top==-1;
}
bool stack::is_full()
{
      return top>=max;
}
int stack::peek()
{
   return arr[top];
}
void process(stack &s,int n)
{
   int m;
   switch(n)
   {
 case 1:cout<<"Number to push"; 
        cin>>m;
        s.push(m);
  break;
 case 2: if(!s.isempty()){
   m = s.pop(); 
  cout<<"value popped is"<<m<<"\n";
  }else
     cout<<"Stack empty";
  break;
 case 3:  m = s.peek(); 
  cout<<"value at the top of stack is"<<m<<"\n";
  break;
     }
} 
    
int main()
{
     stack s1;
     while(true)
     {
 int n;
        cout<<"Enter 1 to push 2 to pop 3 to peek 4 to quit";
        cin>>n;
        if(n==4)
    break;
        process(s1,n);
      }
}
Labels:

Comments

Post a Comment

Popular posts from this blog

Program to delete a node from linked list

How do you remove a node from a linked list? If you have to delete a node, first you need to search the node. Then you should find its previous node. Then you should link the previous node to the next node. If node containing 8 has to be deleted, then n1 should be pointing to n2. Looks quite simple. Isn't it? But there are at least two special cases you have to consider. Of course, when the node is not found. If the node is first node of the list viz head. If the node to be deleted is head node, then if you delete, the list would be lost. You should avoid that and make the second node as the head node. So it becomes mandatory that you return the changed head node from the function.   Now let us have a look at the code. #include<stdio.h> #include<stdlib.h> struct node { int data; struct node * next; }; typedef struct node * NODEPTR; NODEPTR create_node ( int value) { NODEPTR temp = (NODEPTR) malloc( size...
3 comments
Read more

Program to create a Linked List in C

An array is a commonly used data structure in most of the languages. Because it is simple, it needs O(1) time for accessing elements. It is also compact. But an array has a serious drawback - it can not grow or shrink. You need to estimate the array size and define it during compile time. This drawback is not present a linked list. A linked list is a data structure which can grow or shrink dynamically.  A linked list has nodes each of which contain  contain  data and a link to next node . These nodes are dynamically allocated structures. If you need more nodes, you just need to allocate memory for these and link these nodes to the existing list. The nodes of a linked list have to be defined as self-referential structures in C. That is structures with data members and one member which is a pointer to the structure of same type.  This pointer will work as a link to next node. struct node { int data; struct node * next; //pointer to another node }...
1 comment
Read more

Function to add a node to binary search tree

Binary search tree (BST) is an ordered tree where each node has smaller values on the left sub tree and larger values on the right subtree. This is similar to binary search algorithm. And another useful fact is if you traverse the node in in-order method, the values of the tree will be in ascending order. Binary Search Tree with root as 50 Now as you can see from the diagram on the left child and their children of root (which in this case is 50), values are 40, 20 and 45. All are less than 50. On the other hand, on the right sub tree 50, the values are 60, 55 and 78 - larger than 50. And this rule follows for each and every node, not just root. Now if we have to  add a node - let us 43, where shall we add it, in such a way that the tree will still remain as BST. The new node must be a leaf node (i.e. the node with no child nodes) Let us traverse from root and find out where this new node fits. 43 is smaller than 50. Hence we must branch to left of 50. Now we get 40. 4...
Post a Comment
Read more