mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
wip: fix retrocompat issues in cclist
This commit is contained in:
parent
ef8d19ac65
commit
6a90cb25e7
4 changed files with 6 additions and 14 deletions
|
|
@ -110,12 +110,10 @@ val reverse_in_place : 'a t -> unit
|
|||
(** [reverse_in_place a] reverses the array [a] in place. *)
|
||||
|
||||
val sorted : ('a -> 'a -> int) -> 'a t -> 'a array
|
||||
(* FIXME: better label this ~cmp ?? *)
|
||||
(** [sorted f a] makes a copy of [a] and sorts it with [f].
|
||||
@since 1.0 *)
|
||||
|
||||
val sort_indices : ('a -> 'a -> int) -> 'a t -> int array
|
||||
(* FIXME: better label this ~cmp ?? *)
|
||||
(** [sort_indices f a] returns a new array [b], with the same length as [a],
|
||||
such that [b.(i)] is the index at which the [i]-th element of [sorted f a]
|
||||
appears in [a]. [a] is not modified.
|
||||
|
|
@ -125,7 +123,6 @@ val sort_indices : ('a -> 'a -> int) -> 'a t -> int array
|
|||
@since 1.0 *)
|
||||
|
||||
val sort_ranking : ('a -> 'a -> int) -> 'a t -> int array
|
||||
(* FIXME: better label this ~cmp ?? *)
|
||||
(** [sort_ranking f a] returns a new array [b], with the same length as [a],
|
||||
such that [b.(i)] is the index at which the [i]-th element of [a] appears
|
||||
in [sorted f a]. [a] is not modified.
|
||||
|
|
|
|||
|
|
@ -108,12 +108,10 @@ val reverse_in_place : 'a t -> unit
|
|||
(** [reverse_in_place a] reverses the array [a] in place. *)
|
||||
|
||||
val sorted : f:('a -> 'a -> int) -> 'a t -> 'a array
|
||||
(* FIXME: better label this ~cmp ?? *)
|
||||
(** [sorted ~f a] makes a copy of [a] and sorts it with [~f].
|
||||
@since 1.0 *)
|
||||
|
||||
val sort_indices : f:('a -> 'a -> int) -> 'a t -> int array
|
||||
(* FIXME: better label this ~cmp ?? *)
|
||||
(** [sort_indices ~f a] returns a new array [b], with the same length as [a],
|
||||
such that [b.(i)] is the index at which the [i]-th element of [sorted ~f a]
|
||||
appears in [a]. [a] is not modified.
|
||||
|
|
@ -123,7 +121,6 @@ val sort_indices : f:('a -> 'a -> int) -> 'a t -> int array
|
|||
@since 1.0 *)
|
||||
|
||||
val sort_ranking : f:('a -> 'a -> int) -> 'a t -> int array
|
||||
(* FIXME: better label this ~cmp ?? *)
|
||||
(** [sort_ranking ~f a] returns a new array [b], with the same length as [a],
|
||||
such that [b.(i)] is the index at which the [i]-th element of [a] appears
|
||||
in [sorted ~f a]. [a] is not modified.
|
||||
|
|
|
|||
|
|
@ -377,9 +377,9 @@ val find_idx : ('a -> bool) -> 'a t -> (int * 'a) option
|
|||
(** [find_idx p x] returns [Some (i,x)] where [x] is the [i]-th element of [l],
|
||||
and [p x] holds. Otherwise returns [None]. *)
|
||||
|
||||
val remove : eq:('a -> 'a -> bool) -> 'a -> 'a t -> 'a t
|
||||
val remove : eq:('a -> 'a -> bool) -> key:'a -> 'a t -> 'a t
|
||||
(* FIXME: the original CCList.mli uses ~x instead of ~key !! *)
|
||||
(** [remove key l] removes every instance of [key] from [l]. Tail-recursive.
|
||||
(** [remove ~key l] removes every instance of [key] from [l]. Tail-recursive.
|
||||
@param eq equality function.
|
||||
@since 0.11 *)
|
||||
|
||||
|
|
@ -589,9 +589,8 @@ module Assoc : sig
|
|||
@since 0.16 *)
|
||||
|
||||
val update :
|
||||
eq:('a->'a->bool) -> ('b option -> 'b option) -> 'a -> ('a,'b) t -> ('a,'b) t
|
||||
(* FIXME: the original no labels mli kept the ~f label ! *)
|
||||
(** [update k f l] updates [l] on the key [k], by calling [f (get l k)]
|
||||
eq:('a->'a->bool) -> f:('b option -> 'b option) -> 'a -> ('a,'b) t -> ('a,'b) t
|
||||
(** [update k ~f l] updates [l] on the key [k], by calling [f (get l k)]
|
||||
and removing [k] if it returns [None], mapping [k] to [v'] if it
|
||||
returns [Some v'].
|
||||
@since 0.16 *)
|
||||
|
|
|
|||
|
|
@ -375,7 +375,7 @@ val find_idx : f:('a -> bool) -> 'a t -> (int * 'a) option
|
|||
(** [find_idx p x] returns [Some (i,x)] where [x] is the [i]-th element of [l],
|
||||
and [p x] holds. Otherwise returns [None]. *)
|
||||
|
||||
val remove : eq:(('a -> 'a -> bool) [@keep_label]) -> key:'a -> 'a t -> 'a t
|
||||
val remove : eq:(('a -> 'a -> bool) [@keep_label]) -> key:('a [@keep_label]) -> 'a t -> 'a t
|
||||
(* FIXME: the original CCList.mli uses ~x instead of ~key !! *)
|
||||
(** [remove ~key l] removes every instance of [key] from [l]. Tail-recursive.
|
||||
@param eq equality function.
|
||||
|
|
@ -587,8 +587,7 @@ module Assoc : sig
|
|||
@since 0.16 *)
|
||||
|
||||
val update :
|
||||
eq:(('a->'a->bool) [@keep_label]) -> f:('b option -> 'b option) -> 'a -> ('a,'b) t -> ('a,'b) t
|
||||
(* FIXME: the original no labels mli kept the ~f label ! *)
|
||||
eq:(('a->'a->bool) [@keep_label]) -> f:(('b option -> 'b option) [@keep_label]) -> 'a -> ('a,'b) t -> ('a,'b) t
|
||||
(** [update k ~f l] updates [l] on the key [k], by calling [f (get l k)]
|
||||
and removing [k] if it returns [None], mapping [k] to [v'] if it
|
||||
returns [Some v'].
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue