Module Mina_stdlib.Nonempty_list

A non-empty list that is safe by construction.

module Stable : sig ... end
type 'a t = 'a Stable.Latest.t
val to_yojson : ( 'a -> Yojson.Safe.t ) -> 'a t -> Yojson.Safe.t
include Ppx_sexp_conv_lib.Sexpable.S1 with type 'a t := 'a t
val t_of_sexp : ( Sexplib0__.Sexp.t -> 'a ) -> Sexplib0__.Sexp.t -> 'a t
val sexp_of_t : ( 'a -> Sexplib0__.Sexp.t ) -> 'a t -> Sexplib0__.Sexp.t
val compare : ( 'a -> 'a -> int ) -> 'a t -> 'a t -> int
val equal : ( 'a -> 'a -> bool ) -> 'a t -> 'a t -> bool
val hash_fold_t : ( Ppx_hash_lib.Std.Hash.state -> 'a -> Ppx_hash_lib.Std.Hash.state ) -> Ppx_hash_lib.Std.Hash.state -> 'a t -> Ppx_hash_lib.Std.Hash.state
val init : 'a -> 'a list -> 'a t

Create a non-empty list by proving you have a head element

val singleton : 'a -> 'a t

Create a non-empty list with a single element

val uncons : 'a t -> 'a * 'a list

Deconstruct a non-empty list into the head and tail

val cons : 'a -> 'a t -> 'a t

Prepend a new element

val head : 'a t -> 'a

The first element of the container

val tail : 'a t -> 'a list

The zero or more tail elements of the container

val last : 'a t -> 'a
val rev : 'a t -> 'a t

The reverse ordered list

val of_list_opt : 'a list -> 'a t option

Convert a list into a non-empty-list, returning None if the list is * empty

val tail_opt : 'a t -> 'a t option

Get the tail as a non-empty-list

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

Apply a function to each element of the non empty list

val find : 'a t -> f:( 'a -> bool ) -> 'a option
val find_map : 'a t -> f:( 'a -> 'b option ) -> 'b option
val fold : 'a t -> init:'accum -> f:( 'accum -> 'a -> 'accum ) -> 'accum
val iter : 'a t -> f:( 'a -> unit ) -> unit
val length : 'a t -> int
val to_list : 'a t -> 'a list

Note: This is O(1) not O(n) like on most container

val append : 'a t -> 'a t -> 'a t
val take : 'a t -> int -> 'a t option
val min_elt : compare:( 'a -> 'a -> int ) -> 'a t -> 'a
val max_elt : compare:( 'a -> 'a -> int ) -> 'a t -> 'a
val iter_deferred : 'a t -> f:( 'a -> unit Async_kernel.Deferred.t ) -> unit Async_kernel.Deferred.t