Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: adding median of three technique and module interface to QuickSortRecursive.js and its test file #1686

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 65 additions & 18 deletions Sorts/QuickSortRecursive.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,36 @@
*/

/**
* Partition in place QuickSort.
* @param {number[]} inputList list of values.
* @param {number} low lower index for partition.
* @param {number} high higher index for partition.
* Sorts the input list using the quicksort algorithm.
*
* @param {Array} inputList - the list to be sorted
* @return {Array} the sorted list
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we mutate the array anyways, it's unnecessary to return it, and IMO cleaner not to.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are absolutely right ,thanks for reminding me .

*/
const quickSort = (inputList, low, high) => {
// encapsulate the main function to to be the interface of our module
const quickSort = (inputList) => {
if (!Array.isArray(inputList)) {
throw new TypeError('Please input a valid list or array.')
}
if (inputList.length <= 1) {
return inputList
}
return quickSortHelper(inputList, 0, inputList.length - 1)
}

/**
* Recursively sorts the input list using the quicksort algorithm.
*
* @param {number[]} inputList - the list to be sorted
* @param {number} low - the lower index of the current partition
* @param {number} high - the higher index of the current partition
* @return {number[]} the sorted list
*/

const quickSortHelper = (inputList, low, high) => {
if (low < high) {
// get the partition index.
const pIndex = partition(inputList, low, high)
// recursively call the quickSort method again.
quickSort(inputList, low, pIndex - 1)
quickSort(inputList, pIndex + 1, high)
const pIndex = partition(inputList, low, high) // Partition the array
quickSortHelper(inputList, low, pIndex - 1) // Sort left subarray
quickSortHelper(inputList, pIndex + 1, high) // Sort right subarray
}
return inputList
}
Expand All @@ -43,23 +58,55 @@ const quickSort = (inputList, low, high) => {
* @returns {number} `pIndex` pivot index value.
*/
const partition = (partitionList, low, high) => {
const pivot = partitionList[high]
const mid = Math.floor((low + high) / 2)
// get the median of three is good technique for partitioning to be sure that the 2 sub-arrays will be almost equal or nearly equal in size
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is phrased a bit poorly and also misleading: Nothing is guaranteed here. It's just a heuristic. It can still be horribly wrong if the arrays are crafted to be worst case.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am with you that nothing guaranteed but trying to improve something worth it.

const pivot = medianOfThree(partitionList, low, mid, high) // Find the pivot element

// Move pivot to the end
let pivotIndex = partitionList.indexOf(pivot)
;[partitionList[pivotIndex], partitionList[high]] = [
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rename some variables to make this less verbose.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok that will be better

partitionList[high],
partitionList[pivotIndex]
]

let pIndex = low
for (let index = low; index <= high - 1; index++) {
if (partitionList[index] < pivot) {
// swap variables using array destructuring
;[partitionList[index], partitionList[pIndex]] = [

// Perform the partitioning
for (let i = low; i < high; i++) {
if (partitionList[i] < pivot) {
;[partitionList[i], partitionList[pIndex]] = [
partitionList[pIndex],
partitionList[index]
partitionList[i]
]
pIndex += 1
pIndex++
}
}
// Swap the pivot element back to its correct position
;[partitionList[pIndex], partitionList[high]] = [
partitionList[high],
partitionList[pIndex]
]
return pIndex

return pIndex // Return the partition index
}
/**
* Returns the median value of three elements in an array.
*
* @param {number[]} arr - the input array
* @param {number} low - the index of the first element
* @param {number} mid - the index of the second element
* @param {number} high - the index of the third element
* @return {number} the median value of the three elements
*/

const medianOfThree = (partitionList, low, mid, high) => {
const a = partitionList[low]
const b = partitionList[mid]
const c = partitionList[high]

if (a > b !== a > c) return a
else if (b > a !== b > c) return b
else return c
}

export { quickSort }
18 changes: 5 additions & 13 deletions Sorts/test/QuickSortRecursive.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,22 @@ import { quickSort } from '../QuickSortRecursive'

describe('QuickSortRecursive | Partition In Place Method', () => {
it('Expectedly, throw some error if we pass a non-array input', () => {
expect(() => quickSort('xyz', 0, 2)).toThrow(
'Please input a valid list or array.'
)
expect(() => quickSort(null, 0, 4)).toThrow(
'Please input a valid list or array.'
)
expect(() => quickSort(55, 0, 2)).toThrow(
expect(() => quickSort('xyz')).toThrow(
'Please input a valid list or array.'
)
expect(() => quickSort(null)).toThrow('Please input a valid list or array.')
expect(() => quickSort(55)).toThrow('Please input a valid list or array.')
})

it('Expectedly, the quickSort method will sort the unsorted list in ascending order', () => {
const unSortArray = [5, 9, 3, 4, 6, 2, 0, 1, 7, 8]
const sortedExpectedArray = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
expect(quickSort(unSortArray, 0, unSortArray.length - 1)).toEqual(
sortedExpectedArray
)
expect(quickSort(unSortArray)).toEqual(sortedExpectedArray)
})

it('Expectedly, the quickSort method will arrange the list of character values in dictionary order.', () => {
const unSortList = ['d', 'e', 'c', 'a', 'f', 'b']
const sortedExpectedList = ['a', 'b', 'c', 'd', 'e', 'f']
expect(quickSort(unSortList, 0, unSortList.length - 1)).toEqual(
sortedExpectedList
)
expect(quickSort(unSortList)).toEqual(sortedExpectedList)
})
})