Added documentation (#802)

* Added documentation

* Added breif comments on functions

* modified comment block

* further improved comment blocks
This commit is contained in:
Ayaan Khan 2020-05-27 18:54:19 +05:30 committed by GitHub
parent d86ff19d44
commit c2cde125dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 70 deletions

View File

@ -1,67 +0,0 @@
/* C implementation QuickSort */
#include <iostream>
using namespace std;
int partition(int arr[], int low, int high)
{
int pivot = arr[high]; // pivot
int i = (low - 1); // Index of smaller element
for (int j = low; j < high; j++)
{
// If current element is smaller than or
// equal to pivot
if (arr[j] <= pivot)
{
i++; // increment index of smaller element
int temp = arr[i];
arr[i] = arr[j];
arr[j] = temp;
}
}
int temp = arr[i + 1];
arr[i + 1] = arr[high];
arr[high] = temp;
return (i + 1);
}
void quickSort(int arr[], int low, int high)
{
if (low < high)
{
int p = partition(arr, low, high);
quickSort(arr, low, p - 1);
quickSort(arr, p + 1, high);
}
}
void show(int arr[], int size)
{
for (int i = 0; i < size; i++)
cout << arr[i] << "\n";
}
// Driver program to test above functions
int main()
{
int size;
cout << "\nEnter the number of elements : ";
cin >> size;
int arr[size];
cout << "\nEnter the unsorted elements : ";
for (int i = 0; i < size; ++i)
{
cout << "\n";
cin >> arr[i];
}
quickSort(arr, 0, size);
cout << "Sorted array\n";
show(arr, size);
return 0;
}

View File

@ -1,16 +1,42 @@
/* /**
* *
* copyright The Algorithms * copyright The Algorithms
* Author - * Author -
* Correction - ayaankhan98 * Correction - ayaankhan98
* *
* Implementation Details -
* Quick Sort is a divide and conquer algorithm. It picks and element as
* pivot and partition the given array around the picked pivot. There
* are many different versions of quickSort that pick pivot in different
* ways.
*
* 1. Always pick the first element as pivot
* 2. Always pick the last element as pivot (implemented below)
* 3. Pick a random element as pivot
* 4. Pick median as pivot
*
* The key process in quickSort is partition(). Target of partition is,
* given an array and an element x(say) of array as pivot, put x at it's
* correct position in sorted array and put all smaller elements (samller
* than x) before x, and put all greater elements (greater than x) after
* x. All this should be done in linear time
*
*/ */
#include <cstdlib> #include <cstdlib>
#include <iostream> #include <iostream>
/**
* This function takes last element as pivot, places
* the pivot element at its correct position in sorted
* array, and places all smaller (smaller than pivot)
* to left of pivot and all greater elements to right
* of pivot
*
*/
int partition(int arr[], int low, int high) { int partition(int arr[], int low, int high) {
int pivot = arr[high]; // pivot int pivot = arr[high]; // taking the last element as pivot
int i = (low - 1); // Index of smaller element int i = (low - 1); // Index of smaller element
for (int j = low; j < high; j++) { for (int j = low; j < high; j++) {
@ -29,6 +55,12 @@ int partition(int arr[], int low, int high) {
return (i + 1); return (i + 1);
} }
/**
* The main function that implements QuickSort
* arr[] --> Array to be sorted,
* low --> Starting index,
* high --> Ending index
*/
void quickSort(int arr[], int low, int high) { void quickSort(int arr[], int low, int high) {
if (low < high) { if (low < high) {
int p = partition(arr, low, high); int p = partition(arr, low, high);
@ -37,6 +69,7 @@ void quickSort(int arr[], int low, int high) {
} }
} }
// prints the array after sorting
void show(int arr[], int size) { void show(int arr[], int size) {
for (int i = 0; i < size; i++) for (int i = 0; i < size; i++)
std::cout << arr[i] << " "; std::cout << arr[i] << " ";
@ -44,7 +77,6 @@ void show(int arr[], int size) {
} }
// Driver program to test above functions // Driver program to test above functions
int main() { int main() {
int size; int size;
std::cout << "\nEnter the number of elements : "; std::cout << "\nEnter the number of elements : ";