package core

You can search for identifiers within the package.

in-package search v0.2.0

Industrial strength alternative to OCaml's standard library

Install

Dune Dependency

github.com Changelog MIT License Edit opam file Versions (13)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.17.1.tar.gz

md5=743a141234e04210e295980f7a78a6d9

sha512=61b415f4fb12c78d30649fff1aabe3a475eea926ce6edb7774031f4dc7f37ea51f5d9337ead6ec73cd93da5fd1ed0f2738c210c71ebc8fe9d7f6135a06bd176f

doc/core/Core/Doubly_linked/index.html

Module `Core.Doubly_linked`Source

Sourcemodule type S = sig ... end

include S

Sourcemodule Elt : sig ... end

Sourcetype 'a t

include Ppx_compare_lib.Comparable.S1 with type 'a t := 'a t

Sourceval compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int

include Sexplib0.Sexpable.S1 with type 'a t := 'a t

Sourceval t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t

Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

Sourceval t_sexp_grammar : 'a Sexplib0.Sexp_grammar.t -> 'a t Sexplib0.Sexp_grammar.t

include Container.S1 with type 'a t := 'a t

Sourceval mem : 'a t -> 'a -> equal:('a -> 'a -> bool) -> bool

Checks whether the provided element is there, using equal.

Sourceval length : 'a t -> int

Sourceval is_empty : 'a t -> bool

Sourceval iter : 'a t -> f:('a -> unit) -> unit

Sourceval fold : 'a t -> init:'acc -> f:('acc -> 'a -> 'acc) -> 'acc

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t

Source

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.

Source

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

Sourceval exists : 'a t -> f:('a -> bool) -> bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

Sourceval for_all : 'a t -> f:('a -> bool) -> bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

Sourceval count : 'a t -> f:('a -> bool) -> int

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.

Source

val sum : 
  (module Base.Container.Summable with type t = 'sum) ->
  'a t ->
  f:('a -> 'sum) ->
  'sum

Sourceval find : 'a t -> f:('a -> bool) -> 'a option

Returns as an option the first element for which f evaluates to true.

Sourceval find_map : 'a t -> f:('a -> 'b option) -> 'b option

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

Sourceval to_list : 'a t -> 'a list

Sourceval to_array : 'a t -> 'a array

Sourceval min_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option

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.

Sourceval max_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option

include Base.Invariant.S1 with type 'a t := 'a t

Sourceval invariant : ('a -> unit) -> 'a t -> unit

Creating doubly-linked lists

Sourceval create : Base.Unit.t -> 'a t

Sourceval of_list : 'a Base.List.t -> 'a t

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).

Sourceval of_array : 'a Base.Array.t -> 'a t

Predicates

Sourceval equal : 'a t -> 'a t -> Base.Bool.t

pointer equality

Sourceval is_first : 'a t -> 'a Elt.t -> Base.Bool.t

Sourceval is_last : 'a t -> 'a Elt.t -> Base.Bool.t

Sourceval mem_elt : 'a t -> 'a Elt.t -> Base.Bool.t

Constant-time extraction of first and last elements

Sourceval first_elt : 'a t -> 'a Elt.t Base.Option.t

Sourceval last_elt : 'a t -> 'a Elt.t Base.Option.t

Sourceval first : 'a t -> 'a Base.Option.t

Sourceval last : 'a t -> 'a Base.Option.t

Sourceval first_exn : 'a t -> 'a

Sourceval last_exn : 'a t -> 'a

Constant-time retrieval of next or previous element

Sourceval next : 'a t -> 'a Elt.t -> 'a Elt.t Base.Option.t

Sourceval prev : 'a t -> 'a Elt.t -> 'a Elt.t Base.Option.t

Constant-time insertion of a new element

Sourceval insert_before : 'a t -> 'a Elt.t -> 'a -> 'a Elt.t

Sourceval insert_after : 'a t -> 'a Elt.t -> 'a -> 'a Elt.t

Sourceval insert_first : 'a t -> 'a -> 'a Elt.t

Sourceval insert_last : 'a t -> 'a -> 'a Elt.t

Constant-time move of an element from and to positions in the same list

An exception is raised if elt is equal to anchor.

Sourceval move_to_front : 'a t -> 'a Elt.t -> Base.Unit.t

Sourceval move_to_back : 'a t -> 'a Elt.t -> Base.Unit.t

Sourceval move_after : 'a t -> 'a Elt.t -> anchor:'a Elt.t -> Base.Unit.t

Sourceval move_before : 'a t -> 'a Elt.t -> anchor:'a Elt.t -> Base.Unit.t

Constant-time removal of an element

Sourceval remove : 'a t -> 'a Elt.t -> Base.Unit.t

Sourceval remove_first : 'a t -> 'a Base.Option.t

Sourceval remove_last : 'a t -> 'a Base.Option.t

Sourceval iteri : 'a t -> f:(Base.Int.t -> 'a -> Base.Unit.t) -> Base.Unit.t

Sourceval foldi : 'a t -> init:'acc -> f:(Base.Int.t -> 'acc -> 'a -> 'acc) -> 'acc

Sourceval fold_elt : 'a t -> init:'acc -> f:('acc -> 'a Elt.t -> 'acc) -> 'acc

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.

Source

val foldi_elt : 
  'a t ->
  init:'acc ->
  f:(Base.Int.t -> 'acc -> 'a Elt.t -> 'acc) ->
  'acc

Sourceval iter_elt : 'a t -> f:('a Elt.t -> Base.Unit.t) -> Base.Unit.t

Source

val iteri_elt : 
  'a t ->
  f:(Base.Int.t -> 'a Elt.t -> Base.Unit.t) ->
  Base.Unit.t

Sourceval fold_right : 'a t -> init:'acc -> f:('a -> 'acc -> 'acc) -> 'acc

Sourceval fold_right_elt : 'a t -> init:'acc -> f:('a Elt.t -> 'acc -> 'acc) -> 'acc

Sourceval find_elt : 'a t -> f:('a -> Base.Bool.t) -> 'a Elt.t Base.Option.t

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.

Source

val findi_elt : 
  'a t ->
  f:(Base.Int.t -> 'a -> Base.Bool.t) ->
  (Base.Int.t * 'a Elt.t) Base.Option.t

Sourceval clear : 'a t -> Base.Unit.t

clear t removes all elements from the list in constant time.

Sourceval copy : 'a t -> 'a t

Sourceval transfer : src:'a t -> dst:'a t -> Base.Unit.t

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)

Sourceval map : 'a t -> f:('a -> 'b) -> 'b t

Sourceval mapi : 'a t -> f:(Base.Int.t -> 'a -> 'b) -> 'b t

Sourceval filter : 'a t -> f:('a -> Base.Bool.t) -> 'a t

Sourceval filteri : 'a t -> f:(Base.Int.t -> 'a -> Base.Bool.t) -> 'a t

Sourceval filter_map : 'a t -> f:('a -> 'b Base.Option.t) -> 'b t

Sourceval filter_mapi : 'a t -> f:(Base.Int.t -> 'a -> 'b Base.Option.t) -> 'b t

Linear-time partition of lists (creates two new lists)

Sourceval partition_tf : 'a t -> f:('a -> Base.Bool.t) -> 'a t * 'a t

Sourceval partitioni_tf : 'a t -> f:(Base.Int.t -> 'a -> Base.Bool.t) -> 'a t * 'a t

Sourceval partition_map : 'a t -> f:('a -> ('b, 'c) Either.t) -> 'b t * 'c t

Source

val partition_mapi : 
  'a t ->
  f:(Base.Int.t -> 'a -> ('b, 'c) Either.t) ->
  'b t * 'c t

Linear-time in-place mapping of lists

Sourceval map_inplace : 'a t -> f:('a -> 'a) -> Base.Unit.t

map_inplace t ~f replaces all values v with f v

Sourceval mapi_inplace : 'a t -> f:(Base.Int.t -> 'a -> 'a) -> Base.Unit.t

Sourceval filter_inplace : 'a t -> f:('a -> Base.Bool.t) -> Base.Unit.t

filter_inplace t ~f removes all elements of t that don't satisfy f.

Source

val filteri_inplace : 
  'a t ->
  f:(Base.Int.t -> 'a -> Base.Bool.t) ->
  Base.Unit.t

Sourceval filter_map_inplace : 'a t -> f:('a -> 'a Base.Option.t) -> Base.Unit.t

If f returns None, the element is removed, else the value is replaced with the contents of the Some

Source

val filter_mapi_inplace : 
  'a t ->
  f:(Base.Int.t -> 'a -> 'a Base.Option.t) ->
  Base.Unit.t

Sourceval unchecked_iter : 'a t -> f:('a -> Base.Unit.t) -> Base.Unit.t

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).

Sourceval to_sequence : 'a t -> 'a Sequence.t

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.

package core

Install

Dune Dependency

Authors

Maintainers

Sources

doc/core/Core/Doubly_linked/index.html

Module Core.Doubly_linkedSource

Creating doubly-linked lists

Predicates

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

Constant-time removal of an element

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

Module `Core.Doubly_linked`Source