ref: organize QuickSort comments

src/sorting/quick_sort.rs

@@ -1,4 +1,19 @@
+//! Sorts an array using the QuickSort algorithm.
+//!
+//! QuickSort is a Divide and Conquer algorithm. It picks an element as a pivot and partitions
+//! the given array around the picked pivot.
+//!
+//! # Parameters
+//!
+//! - `array`: A mutable reference to the array to be sorted.
+//!
+//! The key process in QuickSort is a partition. The target of partitions is, given an array and an
+//! element `x` of an array as the pivot, put `x` at its correct position in a sorted array and put
+//! all smaller elements (smaller than `x`) before `x`, and put all greater elements (greater than `x`)
+//! after `x. All this should be done in linear time.
+//!
+//! QuickSort's time complexity is O(n*logn).
 use crate::sorting::traits::Sorter;
 
 fn quick_sort<T: Ord>(array: &mut [T]) {
     match array.len() {
@@ -32,33 +47,4 @@
     let (left, right) = array.split_at_mut(left);
     quick_sort(left);
     quick_sort(&mut right[1..]);
-}
-
-/// QuickSort is a Divide and Conquer algorithm. It picks an element as
-/// a pivot and partitions the given array around the picked pivot.
-/// There are many different versions of quickSort that pick pivot in different ways.
-/// parameters takes an array
-/// The key process in quickSort is a partition().
-/// The target of partitions is, given an array and an element x of an array as the pivot,
-/// put x at its correct position in a sorted array and put all smaller elements (smaller than x) before x,
-/// and put all greater elements (greater than x) after x. All this should be done in linear time.
-/// Quicksort's  time complexity is O(n*logn) .
-pub struct QuickSort;
-
-impl<T> Sorter<T> for QuickSort
-where
-    T: Ord + Copy,
-{
-    fn sort_inplace(array: &mut [T]) {
-        quick_sort(array);
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use crate::sorting::traits::Sorter;
-    use crate::sorting::QuickSort;
-
-    sorting_tests!(QuickSort::sort, quick_sort);
-    sorting_tests!(QuickSort::sort_inplace, quick_sort, inplace);
-}
+}