package core
Install
Dune Dependency
Authors
Maintainers
Sources
md5=743a141234e04210e295980f7a78a6d9
sha512=61b415f4fb12c78d30649fff1aabe3a475eea926ce6edb7774031f4dc7f37ea51f5d9337ead6ec73cd93da5fd1ed0f2738c210c71ebc8fe9d7f6135a06bd176f
doc/core/Core/Doubly_linked/index.html
Module Core.Doubly_linked
Source
include S
include Container.S1 with type 'a t := 'a t
Checks whether the provided element is there, using equal
.
fold t ~init ~f
returns f (... f (f (f init e1) e2) e3 ...) en
, where e1..en
are the elements of t
val fold_result :
'a t ->
init:'acc ->
f:('acc -> 'a -> ('acc, 'e) Base.Result.t) ->
('acc, 'e) Base.Result.t
fold_result t ~init ~f
is a short-circuiting version of fold
that runs in the Result
monad. If f
returns an Error _
, that value is returned without any additional invocations of f
.
val fold_until :
'a t ->
init:'acc ->
f:('acc -> 'a -> ('acc, 'final) Base.Container.Continue_or_stop.t) ->
finish:('acc -> 'final) ->
'final
fold_until t ~init ~f ~finish
is a short-circuiting version of fold
. If f
returns Stop _
the computation ceases and results in that value. If f
returns Continue _
, the fold will proceed. If f
never returns Stop _
, the final result is computed by finish
.
Example:
type maybe_negative =
| Found_negative of int
| All_nonnegative of { sum : int }
(** [first_neg_or_sum list] returns the first negative number in [list], if any,
otherwise returns the sum of the list. *)
let first_neg_or_sum =
List.fold_until ~init:0
~f:(fun sum x ->
if x < 0
then Stop (Found_negative x)
else Continue (sum + x))
~finish:(fun sum -> All_nonnegative { sum })
;;
let x = first_neg_or_sum [1; 2; 3; 4; 5]
val x : maybe_negative = All_nonnegative {sum = 15}
let y = first_neg_or_sum [1; 2; -3; 4; 5]
val y : maybe_negative = Found_negative -3
Returns true
if and only if there exists an element for which the provided function evaluates to true
. This is a short-circuiting operation.
Returns true
if and only if the provided function evaluates to true
for all elements. This is a short-circuiting operation.
Returns the number of elements for which the provided function evaluates to true.
Returns the sum of f i
for all i
in the container.
val sum :
(module Base.Container.Summable with type t = 'sum) ->
'a t ->
f:('a -> 'sum) ->
'sum
Returns as an option
the first element for which f
evaluates to true.
Returns the first evaluation of f
that returns Some
, and returns None
if there is no such element.
Returns a minimum (resp maximum) element from the collection using the provided compare
function, or None
if the collection is empty. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold
so it has the same complexity as fold
.
include Base.Invariant.S1 with type 'a t := 'a t
Creating doubly-linked lists
of_list l
returns a doubly-linked list t
with the same elements as l
and in the same order (i.e., the first element of l
is the first element of t
). It is always the case that l = to_list (of_list l)
.
Predicates
pointer equality
Constant-time extraction of first and last elements
Constant-time retrieval of next or previous element
Constant-time insertion of a new element
Constant-time move of an element from and to positions in the same list
An exception is raised if elt
is equal to anchor
.
Constant-time removal of an element
fold_elt t ~init ~f
is the same as fold, except f
is called with the 'a Elt.t
's from the list instead of the contained 'a
values.
Note that like other iteration functions, it is an error to mutate t
inside the fold. If you'd like to call remove
on any of the 'a Elt.t
's, use filter_inplace
.
find_elt t ~f
finds the first element in t
that satisfies f
, by testing each of element of t
in turn until f
succeeds.
val findi_elt :
'a t ->
f:(Base.Int.t -> 'a -> Base.Bool.t) ->
(Base.Int.t * 'a Elt.t) Base.Option.t
clear t
removes all elements from the list in constant time.
transfer ~src ~dst
has the same behavior as iter src ~f:(insert_last dst); clear src
except that it runs in constant time.
If s = to_list src
and d = to_list dst
, then after transfer ~src ~dst
:
to_list src = []
to_list dst = d @ s
Linear-time mapping of lists (creates a new list)
Linear-time partition of lists (creates two new lists)
Linear-time in-place mapping of lists
map_inplace t ~f
replaces all values v
with f v
filter_inplace t ~f
removes all elements of t
that don't satisfy f
.
If f
returns None
, the element is removed, else the value is replaced with the contents of the Some
unchecked_iter t ~f
behaves like iter t ~f
except that f
is allowed to modify t
. Adding or removing elements before the element currently being visited has no effect on the traversal. Elements added after the element currently being visited will be traversed. Elements deleted after the element currently being visited will not be traversed. Deleting the element currently being visited is an error that is not detected (presumably leading to an infinite loop).
A sequence of values from the doubly-linked list. It makes an intermediate copy of the list so that the returned sequence is immune to any subsequent mutation of the original list.