C# | Get object at the top of the Stack - Peek operation - GeeksforGeeks

01 Feb, 2019
Stack represents a last-in, first out collection of object. It is used when you need a last-in, first-out access to items. When you add an item in the list, it is called pushing the item and when you remove it, it is called popping the item. Stack<T>.Peek Method is used to returns the object at the top of the Stack<T> without removing it. This method is an O(1) operation.
Properties:
The capacity of a Stack is the number of elements the Stack can hold. As elements are added to a Stack, the capacity is automatically increased as required through reallocation.
If Count is less than the capacity of the stack, Push is an O(1) operation. If the capacity needs to be increased to accommodate the new element, Push becomes an O(n) operation, where n is Count. Pop is an O(1) operation.
Stack accepts null as a valid value and allows duplicate elements.
Syntax:
object Peek(); 

Return Value: The Peek() method returns the last (top-most) value from the Stack<T> of type System.Object.
Exception: Calling Peek() method on empty stack will throw InvalidOperationException. So always check for elements in the stack before retrieving elements using the Peek() method.
Below given are some examples to understand the implementation in a better way.
Example 1:
// C# code to Get object at// the top of the Stackusing System;using System.Collections.Generic;  class GFG {      // Driver code    public static void Main()    {          // Creating a Stack of strings        Stack<string> myStack = new Stack<string>();          // Inserting the elements into the Stack        myStack.Push("1st Element");        myStack.Push("2nd Element");        myStack.Push("3rd Element");        myStack.Push("4th Element");        myStack.Push("5th Element");        myStack.Push("6th Element");          // Displaying the count of elements        // contained in the Stack        Console.Write("Total number of elements in the Stack are : ");          Console.WriteLine(myStack.Count);          // Displaying the top element of Stack        // without removing it from the Stack        Console.WriteLine("Element at the top is : " + myStack.Peek());          // Displaying the top element of Stack        // without removing it from the Stack        Console.WriteLine("Element at the top is : " + myStack.Peek());          // Displaying the count of elements        // contained in the Stack        Console.Write("Total number of elements in the Stack are : ");          Console.WriteLine(myStack.Count);    }}
Output:
Total number of elements in the Stack are : 6
Element at the top is : 6th Element
Element at the top is : 6th Element
Total number of elements in the Stack are : 6

Example 2:
// C# code to Get object at// the top of the Stackusing System;using System.Collections.Generic;  class GFG {      // Driver code    public static void Main()    {          // Creating a Stack of Integers        Stack<int> myStack = new Stack<int>();          // Displaying the top element of Stack        // without removing it from the Stack        // Calling Peek() method on empty stack        // will throw InvalidOperationException.        Console.WriteLine("Element at the top is : " + myStack.Peek());    }}
Runtime Error:
Unhandled Exception:System.InvalidOperationException: Stack empty.
Reference:
https://docs.microsoft.com/en-us/dotnet/api/system.collections.stack.peek?view=netframework-4.7.2
CSharp-Collections-Namespace
CSharp-Generic-Namespace
CSharp-Generic-Stack
CSharp-method
C#
Writing code in comment?
Please use ide.geeksforgeeks.org,
generate link and share the link here.
Destructors in C#
Extension Method in C#
HashSet in C# with Examples
Top 50 C# Interview Questions & Answers
C# | How to insert an element in an Array?
Partial Classes in C#
C# | Inheritance
C# | List Class
Difference between Hashtable and Dictionary in C#
Lambda Expressions in C#