diff options
Diffstat (limited to 'stdlib/sort.mli')
| -rw-r--r-- | stdlib/sort.mli | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/stdlib/sort.mli b/stdlib/sort.mli index ce137b8bb0..1b7797fce6 100644 --- a/stdlib/sort.mli +++ b/stdlib/sort.mli @@ -12,28 +12,29 @@ (* $Id$ *) -(* Module [Sort]: sorting and merging lists *) +(** Sorting and merging lists. -(* This module is obsolete and exists only for backward compatibility. - The sorting functions in [Array] and [List] should be used instead. + @deprecated This module is obsolete and exists only for backward compatibility. + The sorting functions in {!Array} and {!List} should be used instead. The new functions are faster and use less memory. *) +(** Sort a list in increasing order according to an ordering predicate. + The predicate should return [true] if its first argument is + less than or equal to its second argument. *) val list : ('a -> 'a -> bool) -> 'a list -> 'a list - (* Sort a list in increasing order according to an ordering predicate. - The predicate should return [true] if its first argument is - less than or equal to its second argument. *) +(** Sort an array in increasing order according to an + ordering predicate. + The predicate should return [true] if its first argument is + less than or equal to its second argument. + The array is sorted in place. *) val array : ('a -> 'a -> bool) -> 'a array -> unit - (* Sort an array in increasing order according to an - ordering predicate. - The predicate should return [true] if its first argument is - less than or equal to its second argument. - The array is sorted in place. *) +(** Merge two lists according to the given predicate. + Assuming the two argument lists are sorted according to the + predicate, [merge] returns a sorted list containing the elements + from the two lists. The behavior is undefined if the two + argument lists were not sorted. *) val merge : ('a -> 'a -> bool) -> 'a list -> 'a list -> 'a list - (* Merge two lists according to the given predicate. - Assuming the two argument lists are sorted according to the - predicate, [merge] returns a sorted list containing the elements - from the two lists. The behavior is undefined if the two - argument lists were not sorted. *) + |