Module Core_kernel__.Fqueue
include Bin_prot.Binable.S1 with type 'a t := 'a t
val bin_shape_t : Bin_prot.Shape.t -> Bin_prot.Shape.t
val bin_size_t : ('a, 'a t) Bin_prot.Size.sizer1
val bin_write_t : ('a, 'a t) Bin_prot.Write.writer1
val bin_read_t : ('a, 'a t) Bin_prot.Read.reader1
val __bin_read_t__ : ('a, int -> 'a t) Bin_prot.Read.reader1
val bin_writer_t : ('a, 'a t) Bin_prot.Type_class.S1.writer
val bin_reader_t : ('a, 'a t) Bin_prot.Type_class.S1.reader
val bin_t : ('a, 'a t) Bin_prot.Type_class.S1.t
val compare : ('a -> 'a -> Core_kernel__.Import.int) -> 'a t -> 'a t -> Core_kernel__.Import.int
val hash_fold_t : (Base.Hash.state -> 'a -> Base.Hash.state) -> Base.Hash.state -> 'a t -> Base.Hash.state
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
include Core_kernel.Container.S1 with type 'a t := 'a t
val mem : 'a t -> 'a -> equal:('a -> 'a -> bool) -> bool
Checks whether the provided element is there, using
equal
.
val length : 'a t -> int
val is_empty : 'a t -> bool
val iter : 'a t -> f:('a -> unit) -> unit
val fold : 'a t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum
fold t ~init ~f
returnsf (... f (f (f init e1) e2) e3 ...) en
, wheree1..en
are the elements oft
val fold_result : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Base.Result.t) -> ('accum, 'e) Base.Result.t
fold_result t ~init ~f
is a short-circuiting version offold
that runs in theResult
monad. Iff
returns anError _
, that value is returned without any additional invocations off
.
val fold_until : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Base__.Container_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
fold_until t ~init ~f ~finish
is a short-circuiting version offold
. Iff
returnsStop _
the computation ceases and results in that value. Iff
returnsContinue _
, the fold will proceed. Iff
never returnsStop _
, the final result is computed byfinish
.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
val exists : 'a t -> f:('a -> bool) -> bool
Returns
true
if and only if there exists an element for which the provided function evaluates totrue
. This is a short-circuiting operation.
val for_all : 'a t -> f:('a -> bool) -> bool
Returns
true
if and only if the provided function evaluates totrue
for all elements. This is a short-circuiting operation.
val count : 'a t -> f:('a -> bool) -> int
Returns the number of elements for which the provided function evaluates to true.
val sum : (module Base__.Container_intf.Summable with type t = 'sum) -> 'a t -> f:('a -> 'sum) -> 'sum
Returns the sum of
f i
for alli
in the container.
val find : 'a t -> f:('a -> bool) -> 'a option
Returns as an
option
the first element for whichf
evaluates to true.
val find_map : 'a t -> f:('a -> 'b option) -> 'b option
Returns the first evaluation of
f
that returnsSome
, and returnsNone
if there is no such element.
val to_list : 'a t -> 'a list
val to_array : 'a t -> 'a array
val min_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option
Returns a minimum (resp maximum) element from the collection using the provided
compare
function, orNone
if the collection is empty. In case of a tie, the first element encountered while traversing the collection is returned. The implementation usesfold
so it has the same complexity asfold
.
val max_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option
include Core_kernel__.Import.Invariant.S1 with type 'a t := 'a t
val invariant : 'a Base__.Invariant_intf.inv -> 'a t Base__.Invariant_intf.inv
include Core_kernel__.Import.Monad.S with type 'a t := 'a t
include Base__.Monad_intf.S_without_syntax with type 'a t := 'a t
module Monad_infix : Base__.Monad_intf.Infix with type 'a t := 'a t
val return : 'a -> 'a t
return v
returns the (trivial) computation that returns v.
val empty : 'a t
The empty queue.
val enqueue : 'a t -> 'a -> 'a t
enqueue t x
returns a queue with addsx
to the end oft
. Complexity: O(1).
val enqueue_top : 'a t -> 'a -> 'a t
Enqueues a single element on the *top* of the queue. Complexity: amortized O(1)
enqueue_top
is deprecated, useFdeque.t
instead.
val bot_exn : 'a t -> 'a
Returns the bottom (most recently enqueued) element. Raises
Empty
if no element is found. Complexity: O(1).bot_exn
is deprecated, useFdeque.t
instead.
val bot : 'a t -> 'a Core_kernel__.Import.option
Like
bot_exn
, but returns its result optionally, without exception. Complexity: O(1).bot
is deprecated, useFdeque.t
instead.
val top_exn : 'a t -> 'a
Like
bot_exn
, except returns top (least recently enqueued) element. Complexity: O(1).
val top : 'a t -> 'a Core_kernel__.Import.option
Like
top_exn
, but returns its result optionally, without exception, Complexity: O(1).
val dequeue_exn : 'a t -> 'a * 'a t
dequeue_exn t
removes and returns the front oft
, raisingEmpty
ift
is empty. Complexity: amortized O(1)
val dequeue : 'a t -> ('a * 'a t) Core_kernel__.Import.option
Like
dequeue_exn
, but returns result optionally, without exception. Complexity: amortized O(1)
val discard_exn : 'a t -> 'a t
Returns version of queue with top element removed. Complexity: amortized O(1).
val to_list : 'a t -> 'a Core_kernel__.Import.list
to_list t
returns a list of the elements int
in order from least-recently-added (at the head) to most-recently-added (at the tail). Complexity: O(n).
val of_list : 'a Core_kernel__.Import.list -> 'a t
of_list
is the inverse ofto_list
. Complexity: O(n).
val to_sequence : 'a t -> 'a Core_kernel.Sequence.t
to_sequence
returns aSequence.t
of the elements int
in order from from least-recently-added (at the head) to most-recently-added (at the tail). Complexity (if the sequence is fully traversed): O(n).to_list t = Sequence.to_list (to_sequence t)
val of_sequence : 'a Core_kernel.Sequence.t -> 'a t
of_sequence
is the inverse ofto_sequence
. Complexity (if the sequence is fully traversed): O(n).
val length : 'a t -> Core_kernel__.Import.int
Complexity: O(1).
val is_empty : 'a t -> Core_kernel__.Import.bool
Complexity: O(1).
val singleton : 'a -> 'a t
module Stable : sig ... end