add docs for quickSelect
#276443
add docs for quickSelect
#276443
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds JSDoc documentation to the quickSelect function in the arrays utility module, improving code discoverability and understanding for developers using this algorithm.
- Added comprehensive JSDoc comment block explaining the quickselect algorithm and its parameters
| * @param data The unsorted array | ||
| * @param compare A comparator function that defines the sort order | ||
| * @returns The nth smallest element | ||
| * @throws TypeError if nth is >= data.length |
There was a problem hiding this comment.
The @throws documentation is incomplete. The function also needs to handle the case where nth is negative. Looking at line 124, nth = nth | 0; will convert negative values to negative integers, which when compared at line 126 with nth >= data.length won't throw an error, but will likely cause incorrect behavior in the recursive calls. The documentation should clarify the valid range for nth (i.e., 0 <= nth < data.length) or the function should validate negative values.
See below for a potential fix:
* @throws TypeError if nth is negative or nth is >= data.length
*/
export function quickSelect<T>(nth: number, data: T[], compare: Compare<T>): T {
nth = nth | 0;
if (nth < 0 || nth >= data.length) {
No description provided.