Users Online
· Members Online: 0
· Total Members: 188
· Newest Member: meenachowdary055
Forum Threads
Latest Articles
Articles Hierarchy
Non-Generic Queue Collection Class in C# with Examples
Non-Generic Queue Collection Class in C# with Examples
In this article, I am going to discuss the Non-Generic Queue Collection Class in C# with Examples. Please read our previous article where we discussed the Non-Generic Stack Collection Class in C# with Examples. The Non-Generic Queue Collection Class in C# represents a First-In, First-Out collection of objects. That means we need to use this collection when we need First-In, First-Out access to items of a collection. The Queue Collection Class belongs to the System.Collections namespace. At the end of this article, you will understand the following pointers.
- What is a Queue in C#?
- Methods, Properties, and Constructor of Non-Generic Queue Collection Class in C#
- How to Create a Queue in C#?
- How to Add Elements into a Queue in C#?
- How to Remove Elements from the Queue in C#?
- How to get the first element of the queue in C#?
- How to check whether an element exists or not in the Queue in C#?
- How to Clone the Non-Generic Queue Collection in C#?
- How to Copy a Queue to an Existing Array in C#?
What is a Queue and How Does the Queue Collection Work in C#?
The Non-Generic Queue Collection Class in C# works in the FIFO(First-In-First-Out) principle. So, we need to use the Non-Generic Queue Collection class in C#, when we need First-In-First-Out access to the items of a collection. That means the item which is added first will be removed first from the collection. When we add an item to the queue, then it is called enqueuing an item. Similarly, when we remove an item from the queue then it is called dequeuing an item.
In order to understand Queue collection, first, we need to understand the FIFO Principle as Queue works on the FIFO Principle. Let us understand the FIFO principle with an example. Imagine a queue of people waiting for a ticket in a cinema hall. Normally, the first person who enters the queue will be the first person to get the ticket from the counter. Similarly, the last person who enters the queue will be the last person to get the ticket from the counter. For a better understanding, please have a look at the following image.
In C#, the Non-Generic Queue Collection also works in the same way. Elements are added to the queue in a sequential manner. When we add an item to the queue, then it is called Enqueueing an item. The process of adding an element to the Queue is called Enqueue operation. Similarly, when we remove an item from the queue then it is called Dequeuing an item. This operation is known as Dequeue. For a better understanding, please have a look at the below image.
Note: Queue is defined as both Generic and Non-Generic types of Collections in C#. The Generic Queue Collection is defined in System.Collections.Generic namespace whereas Non-Generic Queue Collection is defined under System.Collections namespace. Here in this article, we will be discussing the Non-Generic Queue Collection Class in C# with Examples.
Characteristics of Non-Generic Queue Collection Class in C#:
- The Enqueue method adds an element to the end of the Queue.
- The Dequeue method removes the oldest element from the start of the Queue.
- The Peek method returns the oldest element that is at the start of the Queue but does not remove it from the Queue.
- The capacity of a Queue is the number of elements the queue can hold. As we add elements to a queue, the capacity of the queue is automatically increased.
- The Non-Generic Queue Collection allows both null and duplicate values.
Methods, Properties, and Constructor of Non-Generic Queue Collection Class in C#:
If you go to the definition of Queue Collection Class in C#, then you will see the following signature. Here, you can see that the Non-Generic Queue Collection class implements the IEnumerable, ICollection, and ICloneable interfaces.
How to create a Queue in C#?
The non-generic Queue collection class in C# has provided four constructors which we can use to create a queue. The constructors are as follows:
- Queue(): It is used to initialize a new instance of the Queue class that is empty and has the default initial capacity, and uses the default growth factor.
- Queue(ICollection col): It is used to initialize a new instance of the Queue class that contains elements copied from the specified collection and has the same initial capacity as the number of elements copied and uses the default growth factor. Here, the parameters col specifies the System.Collections.ICollection to copy elements from.
- Queue(int capacity): It is used to initialize a new instance of the Queue class that is empty, has the specified initial capacity, and uses the default growth factor. Here, the parameter capacity specifies the initial number of elements that the Queue can contain.
- Queue(int capacity, float growFactor): It is used to initialize a new instance of the Queue class that is empty, has the specified initial capacity, and uses the specified growth factor. Here, the parameter capacity specifies the initial number of elements that the Queue can contain and the parameter growFactor specifies the factor by which the capacity of the Queue is expanded.
Let’s see how to create a queue using the Queue() constructor in C#:
Step1:
As the Queue collection class belongs to System.Collections namespace, so first, we need to include System.Collections namespace in our program with the help of the “using” keyword as follows:
using System.Collections;
Step2:
Next, we need to create an instance of the Queue class using the Queue() constructor as follows:
Queue queue = new Queue();
How to Add Elements into a Queue in C#?
If we want to add elements to a queue, then we need to use the Enqueue() method of the Queue class.
- Enqueue(object obj): This method is used to add an object to the end of the Queue. Here, the parameter obj specifies the object to add to the Queue. The value can be null
Example to Understand How to Create a Queue and Add Elements in C#:
For a better understanding of how to create a queue and how to add elements to a queue in C#, please have a look at the below example.
Output:
How to Remove Elements from the Queue Collection in C#?
In Queue, you are allowed to remove elements from the beginning of the Queue. If you want to remove elements from the queue, then you need to use the following two methods provided by the Non-Generic Collection Queue class.
- Dequeue(): This method is used to remove and return the object at the beginning of the Queue. It returns the object that is removed from the beginning of the Queue.
- Clear(): This method is used to remove all objects from the queue.
Let us see an example to understand the Dequeue() and Clear() methods of the Queue Collection Class in C#. Please have a look at the below example which shows the use of the Dequeue and Clear methods.
Output:
How to get the First Element of the Queue Collection in C#?
The Non-Generic Queue Collection class in C# provides the following two methods to get the first element of the queue collection
- Dequeue(): The Dequeue() method of the Queue class is used to Remove and return the object from the beginning of the Queue. If there is no object (or element) present in the Queue and if we are trying to remove an item or object from the Queue using the pop() method then it will throw an exception i.e. System.InvalidOperationException
- Peek(): The peek() method of the Queue class is used to return the oldest object i.e. the object present at the start of the Queue without removing it. If there is no object (or element) present in the Queue and if we are trying to return an item (object) from the Queue using the peek() method then it will throw an exception i.e. System.InvalidOperationException
For a better understanding, please have a look at the below example which shows how to get the first element from the queue using both Dequeue and Peek Methods.
Output:
Note: If you want to remove and return the first element from the queue, then use the Dequeue method and if you only want to return the first element from the queue without removing it, then use the Peek method and this is the only difference between these two methods of Queue Collection Class in C#.
How to Check Whether an Element Exists or not in the Queue Collection in C#?
If you want to check whether an element exists or not in the queue collection, then you need to use the following Contains() method of the Queue Collection Class in C#. You can also use this Contains() method to search for an element in the given queue.
- Contains(object obj): This method is used to determine whether an element is in the Queue. Here, the parameter obj specifies the object or element to locate in the Queue. The value can be null. It returns true if obj is found in the queue; otherwise, false.
Let us understand this with an example. The following example shows how to use the Contains() method of the Queue class in C#.
Output:
Note: The Contains(object obj) method of the Non-Generic Collection Queue Class in C# takes O(n) time to check if the element exists in the queue. This should be taken into consideration while using this method.
How to Clone the Non-Generic Queue Collection in C#?
If you want to clone the Non-Generic Queue collection in C#, then you need to use the following Clone() method provided by the Queue Collection Class.
- Clone(): This method is used to create and return a shallow copy of a Queue object.
For a better understanding, please have a look at the below example.
Output:
How to copy a queue to an existing array in C#?
In order to copy a queue to an existing array in C#, we need to use the following CopyTo method of the Non-Generic Queue Collection Class.
- CopyTo(Array array, int index): The CopyTo method of the Non-Generic Queue Collection Class in C# is used to copy the System.Collections.Queue elements to an existing one-dimensional System.Array, starting at the specified array index. Here, the parameter array specifies the one-dimensional Array that is the destination of the elements copied from Queue. The Array must have zero-based indexing. The index parameter specifies the zero-based index in the array at which copying begins. If the parameter array is null, then it will throw ArgumentNullException. If the parameter index is less than zero, then it will throw ArgumentOutOfRangeException.
This method works on one-dimensional arrays and does not change the state of the queue. The elements are ordered in the array in the same way as the order of the elements from the start of the queue to the end. Let us see an example for a better understanding.
Output:
Properties of Queue Class in C#
- Count: It gets the number of elements contained in the Queue.
- IsSynchronized: It gets a value indicating whether access to the Queue is synchronized (thread-safe). It returns true if access to the queue is synchronized (thread-safe); otherwise, false. The default is false.
- SyncRoot: It gets an object that can be used to synchronize access to the Queue. It returns an object that can be used to synchronize access to the queue.
Non-Generic Queue Collection Class in C# Overview
The following are some important points that you need to remember while working with Queue Collection.
- In C#, Queues are used to store a collection of objects in a FIFO (First in, First out) style, i.e., the element which is added first will remove first.
- By using Enqueue() method, we can add elements at the end of the queue.
- The Dequeue() method will remove and return the first element from the queue.
- The queue Peek() method will always return the first element of the queue, and it won’t delete elements from the queue.
In the next article, I am going to discuss the Non-Generic SortedList Collection Class in C# with Examples. Here, in this article, I try to explain the Non-Generic Queue Collection Class in C# with Examples. I hope this Non-Generic Queue Collection Class in C# with Examples article will help you with your needs. I would like to have your feedback. Please post your feedback, question, or comments about this article.