ref: organize QuickSort comments #64
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexfertel
requested changes
Oct 22, 2023
There was a problem hiding this comment.
Hello! Thanks for your contribution.
I think the only applicable change here is the improvement on the comments. So if you revert the rest, I'm happy to merge the PR.
Also, please take a minute to read https://github.com/alexfertel/rust-algorithms/blob/main/CONTRIBUTING.md before opening any other PRs.
src/sorting/quick_sort.rs
Outdated
Comment on lines
1
to
15
| /// 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). |
There was a problem hiding this comment.
I like this change, it is an improvement 👍🏻
src/sorting/quick_sort.rs
Outdated
Comment on lines
63
to
92
| // Example module organization structure | ||
| mod sorting { | ||
| pub mod traits { | ||
| pub trait Sorter<T> { | ||
| fn sort_inplace(array: &mut [T]); | ||
| } | ||
| } | ||
|
|
||
| pub mod quicksort { | ||
| use super::traits::Sorter; | ||
|
|
||
| /// Sorts an array using the QuickSort algorithm. | ||
| pub fn quick_sort<T: Ord>(array: &mut [T]) { | ||
| // ... (QuickSort implementation) | ||
| } | ||
|
|
||
| /// QuickSort is a type that implements the `Sorter` trait for QuickSort. | ||
| pub struct QuickSort; | ||
|
|
||
| impl<T> Sorter<T> for QuickSort | ||
| where | ||
| T: Ord + Copy, | ||
| { | ||
| fn sort_inplace(array: &mut [T]) { | ||
| quick_sort(array); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
src/sorting/quick_sort.rs
Outdated
Comment on lines
60
to
63
| use crate::sorting::QuickSort; | ||
| use crate::sorting::quicksort::QuickSort; | ||
|
|
||
| sorting_tests!(QuickSort::sort, quick_sort); | ||
| sorting_tests!(QuickSort::sort_inplace, quick_sort, inplace); |
There was a problem hiding this comment.
Could we revert these changes?
alexfertel
changed the title
alexfertel
changed the title
added 2 commits
October 22, 2023 16:20
alexfertel
reviewed
Oct 22, 2023
alexfertel
reviewed
Oct 22, 2023
Comment on lines
-57
to
-64
| #[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); | ||
| } |
|
Closing for bookkeeping purposes! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.