package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Nonempty_listSource

Sourcetype 'a t =
  1. | :: of 'a * 'a list

A 'a t represents a non-empty list, as evidenced by the fact that there is no [] variant. The sexp representation is as a regular list (i.e., the same as the Stable.V3 module below).

For operations on a locally allocated 'a t, see Local_nonempty_list.

include Ppx_compare_lib.Comparable.S1 with type 'a t := 'a t
Sourceval compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
include Ppx_compare_lib.Equal.S1 with type 'a t := 'a t
Sourceval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
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
include Ppx_hash_lib.Hashable.S1 with type 'a t := 'a t
Sourceval hash_fold_t : (Base.Hash.state -> 'a -> Base.Hash.state) -> Base.Hash.state -> 'a t -> Base.Hash.state
include Ppx_quickcheck_runtime.Quickcheckable.S1 with type 'a t := 'a t
include Typerep_lib.Typerepable.S1 with type 'a t := 'a t
include Core.Bin_prot.Binable.S1 with type 'a t := 'a t
Sourceval bin_size_t : ('a, 'a t) Bin_prot.Size.sizer1
Sourceval bin_write_t : ('a, 'a t) Bin_prot.Write.writer1
Sourceval bin_read_t : ('a, 'a t) Bin_prot.Read.reader1
Sourceval __bin_read_t__ : ('a, int -> 'a t) Bin_prot.Read.reader1
Sourceval bin_writer_t : ('a, 'a t) Bin_prot.Type_class.S1.writer
Sourceval bin_reader_t : ('a, 'a t) Bin_prot.Type_class.S1.reader
Sourceval bin_t : ('a, 'a t) Bin_prot.Type_class.S1.t
Sourceval globalize : ('a -> 'a) -> 'a t -> 'a t
include Core.Comparator.Derived with type 'a t := 'a t
Sourcetype !'cmp comparator_witness
include Core.Container.S1 with type 'a t := 'a t

Returns the sum of f i for all i in the container.

include Core.Invariant.S1 with type 'a t := 'a t
Sourceval invariant : ('a -> unit) -> 'a t -> unit
include Core.Monad.S_local with type 'a t := 'a t
Sourceval (>>=) : 'a t -> ('a -> 'b t) -> 'b t

t >>= f returns a computation that sequences the computations represented by two monad elements. The resulting computation first does t to yield a value v, and then runs the computation returned by f v.

Sourceval (>>|) : 'a t -> ('a -> 'b) -> 'b t

t >>| f is t >>= (fun a -> return (f a)).

Sourcemodule Monad_infix : sig ... end
Sourceval bind : 'a t -> f:('a -> 'b t) -> 'b t

bind t ~f = t >>= f

Sourceval return : 'a -> 'a t

return v returns the (trivial) computation that returns v.

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

map t ~f is t >>| f.

Sourceval join : 'a t t -> 'a t

join t is t >>= (fun t' -> t').

Sourceval ignore_m : 'a t -> unit t

ignore_m t is map t ~f:(fun _ -> ()). ignore_m used to be called ignore, but we decided that was a bad name, because it shadowed the widely used Stdlib.ignore. Some monads still do let ignore = ignore_m for historical reasons.

Sourceval all : 'a t list -> 'a list t
Sourceval all_unit : unit t list -> unit t

Like all, but ensures that every monadic value in the list produces a unit value, all of which are discarded rather than being collected into a list.

Sourcemodule Let_syntax : sig ... end

These are convenient to have in scope when programming with a monad:

include Core.Indexed_container.S1 with type 'a t := 'a t
include Base.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

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

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

Sourceval 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

These are all like their equivalents in Container except that an index starting at 0 is added as the first argument to f.

Sourceval foldi : 'a t -> init:_ -> f:(int -> _ -> 'a -> _) -> _
Sourceval existsi : 'a t -> f:(int -> 'a -> bool) -> bool
Sourceval for_alli : 'a t -> f:(int -> 'a -> bool) -> bool
Sourceval counti : 'a t -> f:(int -> 'a -> bool) -> int
Sourceval findi : 'a t -> f:(int -> 'a -> bool) -> (int * 'a) option
Sourceval find_mapi : 'a t -> f:(int -> 'a -> 'b option) -> 'b option
Sourceval create : 'a -> 'a list -> 'a t
Sourceval init : int -> f:(int -> 'a) -> 'a t
Sourceval of_list : 'a list -> 'a t option
Sourceval of_list_error : 'a list -> 'a t Core.Or_error.t
Sourceval of_list_exn : 'a list -> 'a t
Sourceval singleton : 'a -> 'a t
Sourceval cons : 'a -> 'a t -> 'a t
Sourceval hd : 'a t -> 'a
Sourceval tl : 'a t -> 'a list
Sourceval nth : 'a t -> int -> 'a option
Sourceval nth_exn : 'a t -> int -> 'a
Sourceval reduce : 'a t -> f:('a -> 'a -> 'a) -> 'a
Sourceval reverse : 'a t -> 'a t
Sourceval append : 'a t -> 'a list -> 'a t
Sourceval unzip : ('a * 'b) t -> 'a t * 'b t
Sourceval zip : 'a t -> 'b t -> ('a * 'b) t Core.List.Or_unequal_lengths.t
Sourceval zip_exn : 'a t -> 'b t -> ('a * 'b) t
Sourceval mapi : 'a t -> f:(int -> 'a -> 'b) -> 'b t
Sourceval map2 : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t Core.List.Or_unequal_lengths.t
Sourceval map2_exn : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
Sourceval filter : 'a t -> f:('a -> bool) -> 'a list
Sourceval filteri : 'a t -> f:(int -> 'a -> bool) -> 'a list
Sourceval filter_map : 'a t -> f:('a -> 'b option) -> 'b list
Sourceval filter_mapi : 'a t -> f:(int -> 'a -> 'b option) -> 'b list
Sourceval concat : 'a t t -> 'a t
Sourceval concat_map : 'a t -> f:('a -> 'b t) -> 'b t
Sourceval last : 'a t -> 'a
Sourceval drop_last : 'a t -> 'a list
Sourceval to_sequence : 'a t -> 'a Core.Sequence.t
Sourceval sort : 'a t -> compare:('a -> 'a -> int) -> 'a t
Sourceval stable_sort : 'a t -> compare:('a -> 'a -> int) -> 'a t
Sourceval dedup_and_sort : 'a t -> compare:('a -> 'a -> int) -> 'a t
Sourceval permute : ?random_state:Core.Random.State.t -> 'a t -> 'a t
Sourceval iteri : 'a t -> f:(int -> 'a -> unit) -> unit
Sourceval cartesian_product : 'a t -> 'b t -> ('a * 'b) t
Sourceval fold_nonempty : 'a t -> init:('a -> 'acc) -> f:('acc -> 'a -> 'acc) -> 'acc
Sourceval fold_right : 'a t -> init:'b -> f:('a -> 'b -> 'b) -> 'b
Sourceval folding_map : 'a t -> init:'b -> f:('b -> 'a -> 'b * 'c) -> 'c t
Sourceval fold_map : 'a t -> init:'acc -> f:('acc -> 'a -> 'acc * 'b) -> 'acc * 'b t
Sourceval min_elt' : 'a t -> compare:('a -> 'a -> int) -> 'a

min_elt' and max_elt' differ from min_elt and max_elt (included in Container.S1) in that they don't return options.

Sourceval max_elt' : 'a t -> compare:('a -> 'a -> int) -> 'a
Sourceval map_add_multi : ('k, 'v t, 'cmp) Core.Map.t -> key:'k -> data:'v -> ('k, 'v t, 'cmp) Core.Map.t

Like Map.add_multi, but comes with a guarantee that the range of the returned map is all nonempty lists.

Sourceval map_of_alist_multi : ('k * 'v) list -> comparator:('k, 'cmp) Core.Comparator.Module.t -> ('k, 'v t, 'cmp) Core.Map.t

Like Map.of_alist_multi, but comes with a guarantee that the range of the returned map is all nonempty lists.

Sourceval map_of_sequence_multi : ('k * 'v) Core.Sequence.t -> comparator:('k, 'cmp) Core.Comparator.Module.t -> ('k, 'v t, 'cmp) Core.Map.t

Like Map.of_sequence_multi, but comes with a guarantee that the range of the returned map is all nonempty lists.

Sourceval map_of_list_with_key_multi : 'v list -> comparator:('k, 'cmp) Core.Comparator.Module.t -> get_key:('v -> 'k) -> ('k, 'v t, 'cmp) Core.Map.t

Like Map.of_list_with_key_multi, but comes with a guarantee that the range of the returned map is all nonempty lists.

Sourceval combine_errors : ('ok, 'err) Core.Result.t t -> ('ok t, 'err t) Core.Result.t

Like Result.combine_errors but for non-empty lists

Sourceval combine_errors_unit : (unit, 'err) Core.Result.t t -> (unit, 'err t) Core.Result.t

Like Result.combine_errors_unit but for non-empty lists

Sourceval combine_or_errors : 'a Core.Or_error.t t -> 'a t Core.Or_error.t

Like Or_error.combine_errors but for non-empty lists

Sourceval combine_or_errors_unit : unit Core.Or_error.t t -> unit Core.Or_error.t

Like Or_error.combine_errors_unit but for non-empty lists

Sourceval validate_indexed : 'a Core.Validate.check -> 'a t Core.Validate.check

validates a list, naming each element by its position in the list (where the first position is 1, not 0).

Sourceval validate : name:('a -> string) -> 'a Core.Validate.check -> 'a t Core.Validate.check

validates a list, naming each element using a user-defined function for computing the name.

Sourceval flag : 'a Core.Command.Param.Arg_type.t -> 'a t Core.Command.Flag.t

Returns a flag that must be passed one or more times. See Command.Param.one_or_more_as_pair.

Sourceval comma_separated_argtype : ?key:'a t Core.Univ_map.Multi.Key.t -> ?strip_whitespace:bool -> ?unique_values:bool -> 'a Core.Command.Param.Arg_type.t -> 'a t Core.Command.Param.Arg_type.t

Accepts comma-separated lists of arguments parsed by t. See Command.Param.Arg_type.comma_separated.

Sourcetype 'a nonempty_list := 'a t
Sourcemodule Option : sig ... end

This module provides 0-alloc versions of to_list and of_list, via some and allowing you to match%optional on a list, respectively.

Sourcemodule Reversed : sig ... end

a non-empty version of Reversed_list.t

Sourceval rev' : 'a t -> 'a Reversed.t
Sourceval rev_append : 'a Reversed_list.t -> 'a t -> 'a t
Sourcemodule Unstable : sig ... end
Sourcemodule Stable : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct