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);
      }
}

Comments

Popular posts from this blog

Delete a node from doubly linked list

Deletion operation in DLL is simpler when compared to SLL. Because we don't have to go in search of previous node of to-be-deleted node.  Here is how you delete a node Link previous node of node of to-be-deleted to next node. Link next node of node of to-be-deleted to previous node. Free the memory of node of to-be-deleted Simple, isn't it. The code can go like this. prevnode = delnode->prev; nextnode = delnode->next; prevnode->next = nextnode; nextnode->prev = prevnode; free(delnode); And that is it. The node delnode is deleted. But we should always consider boundary conditions. What happens if we are trying to delete the first node or last node? If first node is to be deleted, its previous node is NULL. Hence step 3 should not be used.  And also, once head is deleted, nextnode becomes head . Similarly if last node is to be deleted, nextnode is NULL. Hence step 4 is as strict NO NO. And we should set prevnode to tail. After we put these things together, we have...

Binary tree deletion - non-recursive

In the previous post we have seen how to delete a node of a binary search tree using recursion. Today we will see how to delete a node of BST using a non-recursive function. Let us revisit the 3 scenarios here Deleting a node with no children just link the parent to NULL Deleting a node with one child link the parent to  non-null child of node to be deleted Deleting a node with both children select the successor of node to be deleted copy successor's value into this node delete the successor In order to start, we need a function to search for a node in binary search tree. Did you know that searching in  a BST is very fast, and is of the order O(logn). To search Start with root Repeat until value is found or node is NULL If the search value is greater than node branch to right If the search value is lesser than node branch to left.  Here is the function NODEPTR find_node (NODEPTR root,NODEPTR * parent, int delval) { NODEPTR nd = root; NODEPTR pa = root; if (ro...

Function to sort an array using bubble sort

Quick and dirty way of sorting an array is bubble sort. It is very easy to write and follow. But please keep in mind that it is not at all effecient. #include<iostream> using std::cin; using std::cout; void readArray(int arr[],int sz); void printArray(int arr[],int sz); void sortArray(int arr[],int sz); void swap(int &a,int &b); int main() {    int sz;    cout<<"Size of the array=";    cin>>sz;    int arr[sz];    readArray(arr,sz);     sortArray(arr,sz);   cout<<"Sorted array is ";   printArray(arr,sz); } void readArray(int arr[],int sz) {  for(int i=0;i<sz;i++)    {       cout<<"arr["<<i<<"]=";       cin>>arr[i];   } } void printArray(int arr[],int sz) {  for(int i=0;i<sz;i++)    {       cout<<"arr["<<i<<"]=";    ...