Core_queue

#

type 'a t = 'a Core_queue.t

#

val mem : ?equal:('a -> 'a -> bool) -> 'a t -> 'a -> bool

Checks whether the provided element is there, using polymorphic compare if equal is not provided

#

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 returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t

#

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

#

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

#

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

Returns the number of elements for which the provided function evaluates to true.

#

val sum : (module Commutative_group.S with type t = 'sum) -> 'a t -> f:('a -> 'sum) -> 'sum

Returns the sum of f i for i in the container

#

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

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

#

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

#

val to_list : 'a t -> 'a list

#

val to_array : 'a t -> 'a array

#

val min_elt : 'a t -> cmp:('a -> 'a -> int) -> 'a option

Returns a minimum (resp maximum) element from the collection using the provided cmp 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.

#

val max_elt : 'a t -> cmp:('a -> 'a -> int) -> 'a option

#

val invariant : 'a Invariant_intf.inv -> 'a t Invariant_intf.inv

#

val binary_search : ?pos:int -> ?len:int -> 'a t -> compare:('a -> 'a -> int) -> [

| `First_equal_to

| `First_greater_than_or_equal_to

| `First_strictly_greater_than

| `Last_equal_to

| `Last_less_than_or_equal_to

| `Last_strictly_less_than

] -> 'a -> int option

#

val binary_search_segmented : ?pos:int -> ?len:int -> 'a t -> segment_of:('a -> [

| `Left

| `Right

]) -> [

| `First_on_right

| `Last_on_left

] -> int option

#

val create : ?capacity:int -> unit -> 'a t

Create an empty queue.

#

val singleton : 'a -> 'a t

#

val enqueue : 'a t -> 'a -> unit

#

val dequeue : 'a t -> 'a option

#

val dequeue_exn : 'a t -> 'a

#

val peek : 'a t -> 'a option

#

val peek_exn : 'a t -> 'a

#

val clear : 'a t -> unit

#

val copy : 'a t -> 'a t

#

val blit_transfer : src:'a t -> dst:'a t -> ?len:int -> unit -> unit

Transfers up to len elements from the front of src to the end of dst, removing them from src. It is an error if len < 0.

Aside from a call to set_capacity dst if needed, runs in O(len) time

#

val of_list : 'a list -> 'a t

of_list list returns a queue t with the elements of list in the same order as the elements of list (i.e. the first element of t is the first element of the list).

#

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

#

val concat_map : 'a t -> f:('a -> 'b list) -> 'b t

creates a new queue with elements equal to List.concat_map ~f (to_list t).

#

val filter_map : 'a t -> f:('a -> 'b option) -> 'b t

filter_map creates a new queue with elements equal to List.filter_map ~f (to_list t).

#

val filter : 'a t -> f:('a -> bool) -> 'a t

filter is like filter_map, except with List.filter.

#

val filter_inplace : 'a t -> f:('a -> bool) -> unit

filter_inplace t ~f removes all elements of t that don't satisfy f. If f raises, t is unchanged. This is inplace in that it modifies t; however, it uses space linear in the final length of t.

#

val of_array : 'a array -> 'a t

#

val get : 'a t -> int -> 'a

get t i returns the i'th element in t, where the 0'th element is at the front of t and the length t - 1 element is at the back.

#

val set : 'a t -> int -> 'a -> unit

#

val capacity : 'a t -> int

Returns the current length of the backing array.

#

val set_capacity : 'a t -> int -> unit

set_capacity t capacity sets the capacity of t's backing array to at least max capacity (length t). If the capacity changes, then this involves allocating a new backing array and copying the queue elements over.

#

val t_of_sexp : (Sexplib.Sexp.t -> 'a) -> Sexplib.Sexp.t -> 'a t

#

val sexp_of_t : ('a -> Sexplib.Sexp.t) -> 'a t -> Sexplib.Sexp.t

#

val bin_t : 'a Bin_prot.Type_class.t -> 'a t Bin_prot.Type_class.t

#

val bin_read_t : 'a Bin_prot.Read.reader -> 'a t Bin_prot.Read.reader

#

val __bin_read_t__ : 'a Bin_prot.Read.reader -> (int -> 'a t) Bin_prot.Read.reader

#

val bin_reader_t : 'a Bin_prot.Type_class.reader -> 'a t Bin_prot.Type_class.reader

#

val bin_size_t : 'a Bin_prot.Size.sizer -> 'a t Bin_prot.Size.sizer

#

val bin_write_t : 'a Bin_prot.Write.writer -> 'a t Bin_prot.Write.writer

#

val bin_writer_t : 'a Bin_prot.Type_class.writer -> 'a t Bin_prot.Type_class.writer

module Core_queue_debug