diff --git a/dev/containers/CCList/index.html b/dev/containers/CCList/index.html index 52ee3172..9e07e3d2 100644 --- a/dev/containers/CCList/index.html +++ b/dev/containers/CCList/index.html @@ -75,7 +75,7 @@ return @@ x * x;; val square_even : int list -> int list = <fun> # square_even [1;2;4;3;5;2];; -- : int list = [4; 16; 4]
val return : 'a -> 'a treturn x is x.
take_drop n l returns l1, l2 such that l1 @ l2 = l and length l1 = min (length l) n.
take_while f l returns the longest prefix of l for which f is true.
drop_while f l drops the longest prefix of l for which f is true.
take_drop_while p l = take_while p l, drop_while p l.
last n l takes the last n elements of l (or less if l doesn't have that many elements).
val head_opt : 'a t -> 'a optionhead_opt l returns Some x (the first element of the list l) or None if the list l is empty.
tail_opt l returns Some l' (the given list l without its first element) or None if the list l is empty.
val last_opt : 'a t -> 'a optionlast_opt l returns Some x (the last element of l) or None if the list l is empty.
val find_pred : ('a -> bool) -> 'a t -> 'a optionfind_pred p l finds the first element of l that satisfies p, or returns None if no element satisfies p.
val find_map : ('a -> 'b option) -> 'a t -> 'b optionfind_map f l traverses l, applying f to each element. If for some element x, f x = Some y, then Some y is returned. Otherwise the call returns None.
val find_mapi : (int -> 'a -> 'b option) -> 'a t -> 'b optionfind_mapi f l is like find_map, but also pass the index to the predicate function.
val find_idx : ('a -> bool) -> 'a t -> (int * 'a) optionfind_idx p x returns Some (i,x) where x is the i-th element of l, and p x holds. Otherwise returns None.
remove ~eq ~key l removes every instance of key from l. Tail-recursive.
filter_map f l is the sublist of l containing only elements for which f returns Some e. Map and remove elements at the same time.
keep_some l retains only elements of the form Some x. Like filter_map CCFun.id.
all_some l returns Some l' if all elements of l are of the form Some x, or None otherwise.
all_ok l returns Ok l' if all elements of l are of the form Ok x, or Error e otherwise (with the first error met).
sorted_mem ~cmp x l and mem x l give the same result for any sorted list l, but potentially more efficiently.
sorted_merge ~cmp l1 l2 merges elements from both sorted list using the given comparison function cmp.
sorted_diff ~cmp l1 l2 returns the elements in l1 that are not in l2. Both lists are assumed to be sorted with respect to cmp and duplicate elements in the input lists are treated individually; for example, sorted_diff ~cmp [1;1;1;2;2;3] [1;2;2] would be [1;1;3]. It is the left inverse of sorted_merge; that is, sorted_diff ~cmp (sorted_merge ~cmp l1 l2) l2 is always equal to l1 for sorted lists l1 and l2.
sort_uniq ~cmp l sorts the list l using the given comparison function cmp and remove duplicate elements.
sorted_merge_uniq ~cmp l1 l2 merges the sorted lists l1 and l2 and removes duplicates.
sorted_diff_uniq ~cmp l1 l2 collects the elements in l1 that are not in l2 and then remove duplicates. Both lists are assumed to be sorted with respect to cmp and duplicate elements in the input lists are treated individually; for example, sorted_diff_uniq ~cmp [1;1;1;2;2] [1;2;2;2] would be [1]. sorted_diff_uniq ~cmp l1 l2 and uniq_succ ~eq (sorted_diff ~cmp l1 l2) always give the same result for sorted l1 and l2 and compatible cmp and eq.
is_sorted ~cmp l returns true iff l is sorted (according to given order).
val return : 'a -> 'a treturn x is x.
take_drop n l returns l1, l2 such that l1 @ l2 = l and length l1 = min (length l) n.
take_while f l returns the longest prefix of l for which f is true.
drop_while f l drops the longest prefix of l for which f is true.
take_drop_while p l = take_while p l, drop_while p l.
last n l takes the last n elements of l (or less if l doesn't have that many elements).
val head_opt : 'a t -> 'a optionhead_opt l returns Some x (the first element of the list l) or None if the list l is empty.
tail_opt l returns Some l' (the given list l without its first element) or None if the list l is empty.
val last_opt : 'a t -> 'a optionlast_opt l returns Some x (the last element of l) or None if the list l is empty.
val find_pred : ('a -> bool) -> 'a t -> 'a optionfind_pred p l finds the first element of l that satisfies p, or returns None if no element satisfies p.
val find_map : ('a -> 'b option) -> 'a t -> 'b optionfind_map f l traverses l, applying f to each element. If for some element x, f x = Some y, then Some y is returned. Otherwise the call returns None.
val find_mapi : (int -> 'a -> 'b option) -> 'a t -> 'b optionfind_mapi f l is like find_map, but also pass the index to the predicate function.
val find_idx : ('a -> bool) -> 'a t -> (int * 'a) optionfind_idx p x returns Some (i,x) where x is the i-th element of l, and p x holds. Otherwise returns None.
remove ~eq ~key l removes every instance of key from l. Tail-recursive.
filter_map f l is the sublist of l containing only elements for which f returns Some e. Map and remove elements at the same time.
keep_some l retains only elements of the form Some x. Like filter_map CCFun.id.
all_some l returns Some l' if all elements of l are of the form Some x, or None otherwise.
all_ok l returns Ok l' if all elements of l are of the form Ok x, or Error e otherwise (with the first error met).
sorted_mem ~cmp x l and mem x l give the same result for any sorted list l, but potentially more efficiently.
sorted_merge ~cmp l1 l2 merges elements from both sorted list using the given comparison function cmp.
sorted_diff ~cmp l1 l2 returns the elements in l1 that are not in l2. Both lists are assumed to be sorted with respect to cmp and duplicate elements in the input lists are treated individually; for example, sorted_diff ~cmp [1;1;1;2;2;3] [1;2;2] would be [1;1;3]. It is the left inverse of sorted_merge; that is, sorted_diff ~cmp (sorted_merge ~cmp l1 l2) l2 is always equal to l1 for sorted lists l1 and l2.
sort_uniq ~cmp l sorts the list l using the given comparison function cmp and remove duplicate elements.
sorted_merge_uniq ~cmp l1 l2 merges the sorted lists l1 and l2 and removes duplicates.
sorted_diff_uniq ~cmp l1 l2 collects the elements in l1 that are not in l2 and then remove duplicates. Both lists are assumed to be sorted with respect to cmp and duplicate elements in the input lists are treated individually; for example, sorted_diff_uniq ~cmp [1;1;1;2;2] [1;2;2;2] would be [1]. sorted_diff_uniq ~cmp l1 l2 and uniq_succ ~eq (sorted_diff ~cmp l1 l2) always give the same result for sorted l1 and l2 and compatible cmp and eq.
is_sorted ~cmp l returns true iff l is sorted (according to given order).
val sorted_insert :
cmp:('a -> 'a -> int) ->
?uniq:bool ->
'a ->
diff --git a/dev/containers/CCListLabels/index.html b/dev/containers/CCListLabels/index.html
index 4bc33309..da5ae8d9 100644
--- a/dev/containers/CCListLabels/index.html
+++ b/dev/containers/CCListLabels/index.html
@@ -97,7 +97,7 @@
return @@ x * x;;
val square_even : int list -> int list = <fun>
# square_even [1;2;4;3;5;2];;
-- : int list = [4; 16; 4]val return : 'a -> 'a treturn x is x.
take_drop n l returns l1, l2 such that l1 @ l2 = l and length l1 = min (length l) n.
take_while ~f l returns the longest prefix of l for which f is true.
drop_while ~f l drops the longest prefix of l for which f is true.
take_drop_while ~f l = take_while ~f l, drop_while ~f l.
last n l takes the last n elements of l (or less if l doesn't have that many elements).
val head_opt : 'a t -> 'a optionhead_opt l returns Some x (the first element of the list l) or None if the list l is empty.
tail_opt l returns Some l' (the given list l without its first element) or None if the list l is empty.
val last_opt : 'a t -> 'a optionlast_opt l returns Some x (the last element of l) or None if the list l is empty.
val find_pred : f:('a -> bool) -> 'a t -> 'a optionfind_pred ~f l finds the first element of l that satisfies f, or returns None if no element satisfies f.
val find_pred_exn : f:('a -> bool) -> 'a t -> 'afind_pred_exn ~f l is the unsafe version of find_pred.
val find_map : f:('a -> 'b option) -> 'a t -> 'b optionfind_map ~f l traverses l, applying f to each element. If for some element x, f x = Some y, then Some y is returned. Otherwise the call returns None.
val find_mapi : f:(int -> 'a -> 'b option) -> 'a t -> 'b optionfind_mapi ~f l is like find_map, but also pass the index to the predicate function.
val find_idx : f:('a -> bool) -> 'a t -> (int * 'a) optionfind_idx ~f x returns Some (i,x) where x is the i-th element of l, and f x holds. Otherwise returns None.
remove ~eq ~key l removes every instance of key from l. Tail-recursive.
filter_map ~f l is the sublist of l containing only elements for which f returns Some e. Map and remove elements at the same time.
keep_some l retains only elements of the form Some x. Like filter_map CCFun.id.
all_some l returns Some l' if all elements of l are of the form Some x, or None otherwise.
all_ok l returns Ok l' if all elements of l are of the form Ok x, or Error e otherwise (with the first error met).
sorted_mem ~cmp x l and mem x l give the same result for any sorted list l, but potentially more efficiently.
sorted_merge ~cmp l1 l2 merges elements from both sorted list using the given comparison function cmp.
sorted_diff ~cmp l1 l2 returns the elements in l1 that are not in l2. Both lists are assumed to be sorted with respect to cmp and duplicate elements in the input lists are treated individually; for example, sorted_diff ~cmp [1;1;1;2;2;3] [1;2;2] would be [1;1;3]. It is the left inverse of sorted_merge; that is, sorted_diff ~cmp (sorted_merge ~cmp l1 l2) l2 is always equal to l1 for sorted lists l1 and l2.
sort_uniq ~cmp l sorts the list l using the given comparison function cmp and remove duplicate elements.
sorted_merge_uniq ~cmp l1 l2 merges the sorted lists l1 and l2 and removes duplicates.
sorted_diff_uniq ~cmp l1 l2 collects the elements in l1 that are not in l2 and then remove duplicates. Both lists are assumed to be sorted with respect to cmp and duplicate elements in the input lists are treated individually; for example, sorted_diff_uniq ~cmp [1;1;1;2;2] [1;2;2;2] would be [1]. sorted_diff_uniq ~cmp l1 l2 and uniq_succ ~eq (sorted_diff ~cmp l1 l2) always give the same result for sorted l1 and l2 and compatible cmp and eq.
is_sorted ~cmp l returns true iff l is sorted (according to given order).
val return : 'a -> 'a treturn x is x.
take_drop n l returns l1, l2 such that l1 @ l2 = l and length l1 = min (length l) n.
take_while ~f l returns the longest prefix of l for which f is true.
drop_while ~f l drops the longest prefix of l for which f is true.
take_drop_while ~f l = take_while ~f l, drop_while ~f l.
last n l takes the last n elements of l (or less if l doesn't have that many elements).
val head_opt : 'a t -> 'a optionhead_opt l returns Some x (the first element of the list l) or None if the list l is empty.
tail_opt l returns Some l' (the given list l without its first element) or None if the list l is empty.
val last_opt : 'a t -> 'a optionlast_opt l returns Some x (the last element of l) or None if the list l is empty.
val find_pred : f:('a -> bool) -> 'a t -> 'a optionfind_pred ~f l finds the first element of l that satisfies f, or returns None if no element satisfies f.
val find_pred_exn : f:('a -> bool) -> 'a t -> 'afind_pred_exn ~f l is the unsafe version of find_pred.
val find_map : f:('a -> 'b option) -> 'a t -> 'b optionfind_map ~f l traverses l, applying f to each element. If for some element x, f x = Some y, then Some y is returned. Otherwise the call returns None.
val find_mapi : f:(int -> 'a -> 'b option) -> 'a t -> 'b optionfind_mapi ~f l is like find_map, but also pass the index to the predicate function.
val find_idx : f:('a -> bool) -> 'a t -> (int * 'a) optionfind_idx ~f x returns Some (i,x) where x is the i-th element of l, and f x holds. Otherwise returns None.
remove ~eq ~key l removes every instance of key from l. Tail-recursive.
filter_map ~f l is the sublist of l containing only elements for which f returns Some e. Map and remove elements at the same time.
keep_some l retains only elements of the form Some x. Like filter_map CCFun.id.
all_some l returns Some l' if all elements of l are of the form Some x, or None otherwise.
all_ok l returns Ok l' if all elements of l are of the form Ok x, or Error e otherwise (with the first error met).
sorted_mem ~cmp x l and mem x l give the same result for any sorted list l, but potentially more efficiently.
sorted_merge ~cmp l1 l2 merges elements from both sorted list using the given comparison function cmp.
sorted_diff ~cmp l1 l2 returns the elements in l1 that are not in l2. Both lists are assumed to be sorted with respect to cmp and duplicate elements in the input lists are treated individually; for example, sorted_diff ~cmp [1;1;1;2;2;3] [1;2;2] would be [1;1;3]. It is the left inverse of sorted_merge; that is, sorted_diff ~cmp (sorted_merge ~cmp l1 l2) l2 is always equal to l1 for sorted lists l1 and l2.
sort_uniq ~cmp l sorts the list l using the given comparison function cmp and remove duplicate elements.
sorted_merge_uniq ~cmp l1 l2 merges the sorted lists l1 and l2 and removes duplicates.
sorted_diff_uniq ~cmp l1 l2 collects the elements in l1 that are not in l2 and then remove duplicates. Both lists are assumed to be sorted with respect to cmp and duplicate elements in the input lists are treated individually; for example, sorted_diff_uniq ~cmp [1;1;1;2;2] [1;2;2;2] would be [1]. sorted_diff_uniq ~cmp l1 l2 and uniq_succ ~eq (sorted_diff ~cmp l1 l2) always give the same result for sorted l1 and l2 and compatible cmp and eq.
is_sorted ~cmp l returns true iff l is sorted (according to given order).