A double-ended queue that can shrink and expand on both ends.
An index is assigned to an element when it enters the queue, and the index of an element is static (i.e., an index refers to a distinct element until that element is removed from the queue, no matter how many intervening push/pop operations occur).
One consequence of this is that the minimum index may be less than zero.
The "front" is the smallest valid index, while the "back" is the largest.
All operations are amortized O(1) with a small constant.
include Sexplib0 .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.tval t_sexp_grammar : 'a Sexplib0 .Sexp_grammar.t-> 'a t Sexplib0 .Sexp_grammar.tval binary_search : ('a t 'a , 'key ) Base__Binary_searchable_intf .binary_searchval binary_search_segmented :
('a t 'a ) Base__Binary_searchable_intf .binary_search_segmentedval mem : 'a t -> 'a -> equal :('a -> 'a -> -> val is_empty : 'a t -> val iter : 'a t -> f :('a -> -> val fold : 'a t -> init :'acc -> f :('acc -> 'a -> 'acc ) -> 'acc val fold_result :
'a t -> init :'acc -> f :('acc -> 'a -> ('acc , 'e ) Base__ .Result.t -> ('acc , 'e ) Base__ .Result.tval fold_until :
'a t -> init :'acc -> f :('acc -> 'a -> ('acc , 'final ) Base__Container_intf .Continue_or_stop.t -> finish :('acc -> 'final ) -> 'final val exists : 'a t -> f :('a -> -> val for_all : 'a t -> f :('a -> -> val count : 'a t -> f :('a -> -> val sum :
(module Base__Container_intf .Summable with type t = 'sum ) -> 'a t -> f :('a -> 'sum ) -> 'sum val find : 'a t -> f :('a -> -> 'a optionval find_map : 'a t -> f :('a -> 'b option -> 'b optionval to_list : 'a t -> 'a listval to_array : 'a t -> 'a arrayval min_elt : 'a t -> compare :('a -> 'a -> -> 'a optionval max_elt : 'a t -> compare :('a -> 'a -> -> 'a optionval create :
?initial_length :Base .Int.t -> ?never_shrink :Base .Bool.t -> Base .Unit.t -> _ t create ?initial_length ?never_shrink () creates a new t. initial_length is the initial length of the dequeue; it will be able to hold initial_length elements without resizing. It must be positive. If never_shrink is true, the physical array will never shrink, only expand. If initial_length is given without never_shrink, then never_shrink is presumed to be true, otherwise never_shrink defaults to false.
val of_array : 'a Base .Array.t-> 'a t of_array arr creates a dequeue containing the elements of arr. The first element of the array will be at the front of the dequeue.
val front_index : _ t -> Base .Int.t Base .Option.tfront_index t return the index of the front item in t.
val front_index_exn : _ t -> Base .Int.tfront_index_exn t throws an exception if t is empty, otherwise returns the index of the front item in t.
val back_index : _ t -> Base .Int.t Base .Option.tback_index t return the index of the back item in t.
val back_index_exn : _ t -> Base .Int.tback_index_exn t throws an exception if t is empty, otherwise returns the index of the back item in t.
val get_opt : 'a t -> Base .Int.t -> 'a Base .Option.tget_opt t i returns the element at index i. Return None if i is invalid.
val get : 'a t -> Base .Int.t -> 'a get t i returns the element at index i. Raise an exception if i is invalid.
val peek : 'a t -> [ `back | `front ] -> 'a Base .Option.tpeek t back_or_front returns the value at the back or front of the dequeue without removing it.
val peek_front : 'a t -> 'a Base .Option.tval peek_front_exn : 'a t -> 'a val peek_back : 'a t -> 'a Base .Option.tval peek_back_exn : 'a t -> 'a val set_exn : 'a t -> Base .Int.t -> 'a -> Base .Unit.tset_exn t i v mutates the element at i.
val iter' :
'a t -> [ `front_to_back | `back_to_front ] -> f :('a -> Base .Unit.t) -> Base .Unit.titer' t ~f iterates over the elements of t.
val iteri : 'a t -> f :(Base .Int.t -> 'a -> Base .Unit.t) -> Base .Unit.titeri t ~f iterates over the elements of t `front_to_back passing in the index.
val iteri' :
'a t -> [ `front_to_back | `back_to_front ] -> f :(Base .Int.t -> 'a -> Base .Unit.t) -> Base .Unit.titeri' t ~f is the same as iter', but also passes in the index of the current element.
val fold' :
'a t -> [ `front_to_back | `back_to_front ] -> init :'b -> f :('b -> 'a -> 'b ) -> 'b fold' t ~init ~f folds over the elements of t.
val foldi : 'a t -> init :'b -> f :(Base .Int.t -> 'b -> 'a -> 'b ) -> 'b foldi t ~init ~f is the same as fold, but also passes in the index of the current element to f.
val foldi' :
'a t -> [ `front_to_back | `back_to_front ] -> init :'b -> f :(Base .Int.t -> 'b -> 'a -> 'b ) -> 'b foldi' t ~init ~f is the same as fold', but also passes in the index of the current element to f.
val enqueue : 'a t -> [ `back | `front ] -> 'a -> Base .Unit.tenqueue t back_or_front v pushes v onto the back_or_front of t.
val enqueue_front : 'a t -> 'a -> Base .Unit.tval enqueue_back : 'a t -> 'a -> Base .Unit.tval clear : _ t -> Base .Unit.tclear t removes all elements from t.
val drop : ?n :Base .Int.t -> _ t -> [ `back | `front ] -> Base .Unit.tdrop ?n t back_or_front drops n elements (default 1) from the back_or_front of t. If t has fewer than n elements then it is cleared.
val drop_front : ?n :Base .Int.t -> _ t -> Base .Unit.tval drop_back : ?n :Base .Int.t -> _ t -> Base .Unit.tval dequeue : 'a t -> [ `back | `front ] -> 'a Base .Option.tdequeue t back_or_front removes and returns the back_or_front of t.
val dequeue_exn : 'a t -> [ `back | `front ] -> 'a val dequeue_front : 'a t -> 'a Base .Option.tval dequeue_front_exn : 'a t -> 'a val dequeue_back : 'a t -> 'a Base .Option.tval dequeue_back_exn : 'a t -> 'a