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

Introduction to AVL tree

AVL tree is a balanced binary search tree where the difference between heights of two sub trees is maximum 1. Why balanced tree A binary tree is good data structure because search operation here is of the order of O(logn). But this is true if the tree is balanced - which means the left and right subtrees are almost equal in height. If not balanced, search operation will take longer.  In worst case, if the tree has only one branch, then search is of the order O(n). Look at this example.  Here all nodes have only right children.  To search a value in this tree, we need upto 7 iterations, which is O(n). So this tree is very very inefficient. One way of making the tree efficient is to, balance the tree and make sure that height of two branches of each node are almost equal. Height of a node Height of a node is the distance between the node and its extreme child.  In the above a diagram, height of 37 is 3 and height of left child of 37 is 0 and right child of 37 is 2. Bal...
Post a Comment
Read more

Balanced brackets

Have you observed something? When ever you are writing code using any IDE, if you write mismatched brackets, immediately an error is shown by IDE. So how does IDE  know if an expression is having balanced brackets? For that, the expression must have equal number of opening and closing brackets of matching types and also they must be in correct order. Let us look at some examples (a+b)*c+d*{e+(f*g)}   - balanced (p+q*[r+u )] - unbalanced (p+q+r+s) ) - unbalanced (m+n*[p+q]+{g+h}) - balanced So we do we write a program to check if an expression is having balanced brackets? We do need to make use of stack to store the brackets. The algorithm is as follows Scan a character - ch from the expression If the character is opening bracket, push it to stack If the character is closing bracket pop a character from stack If popped opening bracket and ch are not of same type ( ( and ) or [ and ] ) stop the function and return false Repeat steps 2 and 3 till all characters are scanned. On...
2 comments
Read more

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