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

Linked list in C++

A linked list is a versatile data structure. In this structure, values are linked to one another with the help of addresses. I have written in an earlier post about how to create a linked list in C.  C++ has a library - standard template library which has list, stack, queue etc. data structures. But if you were to implement these data structures yourself in C++, how will you implement? If you just use new, delete, cout and cin, and then claim it is your c++ program, you are not conforming to OOPS concept. Remember you have to "keep it together". Keep all the functions and variables together - in a class. You have to have class called linked list in which there are methods - append, delete, display, insert, find, find_last. And there will also be a data - head. Defining node We need a structure for all these nodes. A struct can be used for this purpose, just like C. struct node { int val; struct node * next; }; Next we need to define our class. W
Post a Comment
Read more

Swap nodes of a linked list

Qn: Write a function to swap the adjacent nodes of a singly linked list.i.e. If the list has nodes as 1,2,3,4,5,6,7,8, after swapping, the list should be 2,1,4,3,6,5,8,7 Image from: https://tekmarathon.com Though the question looks simple enough, it is tricky because you don't just swap the pointers. You need to take care of links as well. So let us try to understand how to go about it. Take two adjacent nodes p1 and p2 Let prevnode be previous node of p1 Now link prevnode to p2 Link p2 to p1 Link p1 to next node of p2 So the code will be prevnode -> next = p2; p1 -> next = p2 -> next; p2 -> next = p1; But what about the start node or head? head node does not have previous node If we swap head with second node, modified head should be sent back to caller  To take care of swapping first and second nodes, we can write p1 = head; p2 = head -> next; p1 -> next = p2 -> next; p2 -> next = p1; head = p2;  Now we are read
Post a Comment
Read more

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 (root -> v
Post a Comment
Read more