Batteries user guide : BatEnum

`sig type 'a t module type Enumerable = sig type 'a enumerable val enum : 'a BatEnum.Enumerable.enumerable -> 'a BatEnum.t val of_enum : 'a BatEnum.t -> 'a BatEnum.Enumerable.enumerable end type 'a enumerable = 'a t type 'a mappable = 'a t val iter : ('a -> unit) -> 'a BatEnum.t -> unit val iter2 : ('a -> 'b -> unit) -> 'a BatEnum.t -> 'b BatEnum.t -> unit val exists : ('a -> bool) -> 'a BatEnum.t -> bool val for_all : ('a -> bool) -> 'a BatEnum.t -> bool val fold : ('b -> 'a -> 'b) -> 'b -> 'a BatEnum.t -> 'b val reduce : ('a -> 'a -> 'a) -> 'a BatEnum.t -> 'a val sum : int BatEnum.t -> int val fsum : float BatEnum.t -> float val kahan_sum : float BatEnum.t -> float val fold2 : ('a -> 'b -> 'c -> 'c) -> 'c -> 'a BatEnum.t -> 'b BatEnum.t -> 'c val scanl : ('b -> 'a -> 'b) -> 'b -> 'a BatEnum.t -> 'b BatEnum.t val scan : ('a -> 'a -> 'a) -> 'a BatEnum.t -> 'a BatEnum.t val iteri : (int -> 'a -> unit) -> 'a BatEnum.t -> unit val iter2i : (int -> 'a -> 'b -> unit) -> 'a BatEnum.t -> 'b BatEnum.t -> unit val foldi : (int -> 'a -> 'b -> 'b) -> 'b -> 'a BatEnum.t -> 'b val fold2i : (int -> 'a -> 'b -> 'c -> 'c) -> 'c -> 'a BatEnum.t -> 'b BatEnum.t -> 'c val find : ('a -> bool) -> 'a BatEnum.t -> 'a val find_map : ('a -> 'b option) -> 'a BatEnum.t -> 'b val is_empty : 'a BatEnum.t -> bool val peek : 'a BatEnum.t -> 'a option val get : 'a BatEnum.t -> 'a option val get_exn : 'a BatEnum.t -> 'a val push : 'a BatEnum.t -> 'a -> unit val junk : 'a BatEnum.t -> unit val clone : 'a BatEnum.t -> 'a BatEnum.t val force : 'a BatEnum.t -> unit val take : int -> 'a BatEnum.t -> 'a BatEnum.t val drop : int -> 'a BatEnum.t -> unit val skip : int -> 'a BatEnum.t -> 'a BatEnum.t val take_while : ('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t val drop_while : ('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t val span : ('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t * 'a BatEnum.t val break : ('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t * 'a BatEnum.t val group : ('a -> 'b) -> 'a BatEnum.t -> 'a BatEnum.t BatEnum.t val group_by : ('a -> 'a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t BatEnum.t val clump : int -> ('a -> unit) -> (unit -> 'b) -> 'a BatEnum.t -> 'b BatEnum.t val cartesian_product : 'a BatEnum.t -> 'b BatEnum.t -> ('a * 'b) BatEnum.t val map : ('a -> 'b) -> 'a BatEnum.t -> 'b BatEnum.t val mapi : (int -> 'a -> 'b) -> 'a BatEnum.t -> 'b BatEnum.t val filter : ('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t val filter_map : ('a -> 'b option) -> 'a BatEnum.t -> 'b BatEnum.t val append : 'a BatEnum.t -> 'a BatEnum.t -> 'a BatEnum.t val prefix_action : (unit -> unit) -> 'a BatEnum.t -> 'a BatEnum.t val suffix_action : (unit -> unit) -> 'a BatEnum.t -> 'a BatEnum.t val concat : 'a BatEnum.t BatEnum.t -> 'a BatEnum.t val flatten : 'a BatEnum.t BatEnum.t -> 'a BatEnum.t val concat_map : ('a -> 'b BatEnum.t) -> 'a BatEnum.t -> 'b BatEnum.t exception No_more_elements exception Infinite_enum val empty : unit -> 'a BatEnum.t val make : next:(unit -> 'a) -> count:(unit -> int) -> clone:(unit -> 'a BatEnum.t) -> 'a BatEnum.t val from : (unit -> 'a) -> 'a BatEnum.t val from_while : (unit -> 'a option) -> 'a BatEnum.t val from_loop : 'b -> ('b -> 'a * 'b) -> 'a BatEnum.t val seq : 'a -> ('a -> 'a) -> ('a -> bool) -> 'a BatEnum.t val unfold : 'b -> ('b -> ('a * 'b) option) -> 'a BatEnum.t val init : int -> (int -> 'a) -> 'a BatEnum.t val singleton : 'a -> 'a BatEnum.t val repeat : ?times:int -> 'a -> 'a BatEnum.t val cycle : ?times:int -> 'a BatEnum.t -> 'a BatEnum.t val delay : (unit -> 'a BatEnum.t) -> 'a BatEnum.t val to_object : 'a BatEnum.t -> (< clone : 'b; count : int; next : 'a > as 'b) val of_object : (< clone : 'b; count : int; next : 'a > as 'b) -> 'a BatEnum.t val enum : 'a BatEnum.t -> 'a BatEnum.t val of_enum : 'a BatEnum.t -> 'a BatEnum.t val count : 'a BatEnum.t -> int val fast_count : 'a BatEnum.t -> bool val hard_count : 'a BatEnum.t -> int val range : ?until:int -> int -> int BatEnum.t val dup : 'a BatEnum.t -> 'a BatEnum.t * 'a BatEnum.t val combine : 'a BatEnum.t * 'b BatEnum.t -> ('a * 'b) BatEnum.t val uncombine : ('a * 'b) BatEnum.t -> 'a BatEnum.t * 'b BatEnum.t val merge : ('a -> 'a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t -> 'a BatEnum.t val interleave : 'a BatEnum.t array -> 'a BatEnum.t val uniq : 'a BatEnum.t -> 'a BatEnum.t val uniqq : 'a BatEnum.t -> 'a BatEnum.t val uniq_by : ('a -> 'a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t val switch : ('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t * 'a BatEnum.t val partition : ('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t * 'a BatEnum.t val arg_min : ('a -> 'b) -> 'a BatEnum.t -> 'a val arg_max : ('a -> 'b) -> 'a BatEnum.t -> 'a val while_do : ('a -> bool) -> ('a BatEnum.t -> 'a BatEnum.t) -> 'a BatEnum.t -> 'a BatEnum.t module Infix : sig val ( -- ) : int -> int -> int BatEnum.t val ( --^ ) : int -> int -> int BatEnum.t val ( --. ) : float * float -> float -> float BatEnum.t val ( --- ) : int -> int -> int BatEnum.t val ( --~ ) : char -> char -> char BatEnum.t val ( // ) : 'a BatEnum.t -> ('a -> bool) -> 'a BatEnum.t val ( /@ ) : 'a BatEnum.t -> ('a -> 'b) -> 'b BatEnum.t val ( @/ ) : ('a -> 'b) -> 'a BatEnum.t -> 'b BatEnum.t val ( //@ ) : 'a BatEnum.t -> ('a -> 'b option) -> 'b BatEnum.t val ( @// ) : ('a -> 'b option) -> 'a BatEnum.t -> 'b BatEnum.t end val ( -- ) : int -> int -> int BatEnum.t val ( --^ ) : int -> int -> int BatEnum.t val ( --. ) : float * float -> float -> float BatEnum.t val ( --- ) : int -> int -> int BatEnum.t val ( --~ ) : char -> char -> char BatEnum.t val ( // ) : 'a BatEnum.t -> ('a -> bool) -> 'a BatEnum.t val ( /@ ) : 'a BatEnum.t -> ('a -> 'b) -> 'b BatEnum.t val ( @/ ) : ('a -> 'b) -> 'a BatEnum.t -> 'b BatEnum.t val ( //@ ) : 'a BatEnum.t -> ('a -> 'b option) -> 'b BatEnum.t val ( @// ) : ('a -> 'b option) -> 'a BatEnum.t -> 'b BatEnum.t module WithMonad : functor (Mon : BatInterfaces.Monad) -> sig type 'a m = 'a Mon.m val sequence : 'a BatEnum.WithMonad.m BatEnum.t -> 'a BatEnum.t BatEnum.WithMonad.m val fold_monad : ('a -> 'b -> 'a BatEnum.WithMonad.m) -> 'a -> 'b BatEnum.t -> 'a BatEnum.WithMonad.m end module Monad : sig type 'a m = 'a BatEnum.t val return : 'a -> 'a BatEnum.Monad.m val bind : 'a BatEnum.Monad.m -> ('a -> 'b BatEnum.Monad.m) -> 'b BatEnum.Monad.m end val print : ?first:string -> ?last:string -> ?sep:string -> ('a BatInnerIO.output -> 'b -> unit) -> 'a BatInnerIO.output -> 'b BatEnum.t -> unit val print_at_most : ?first:string -> ?last:string -> ?sep:string -> limit:int -> ('a BatInnerIO.output -> 'b -> unit) -> 'a BatInnerIO.output -> 'b BatEnum.t -> unit val compare : ('a -> 'a -> int) -> 'a BatEnum.t -> 'a BatEnum.t -> int val ord : ('a -> 'a -> BatOrd.order) -> 'a BatEnum.t -> 'a BatEnum.t -> BatOrd.order val equal : ('a -> 'a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t -> bool module Exceptionless : sig val find : ('a -> bool) -> 'a BatEnum.t -> 'a option end module Labels : sig val iter : f:('a -> unit) -> 'a BatEnum.t -> unit val iter2 : f:('a -> 'b -> unit) -> 'a BatEnum.t -> 'b BatEnum.t -> unit val exists : f:('a -> bool) -> 'a BatEnum.t -> bool val for_all : f:('a -> bool) -> 'a BatEnum.t -> bool val fold : f:('b -> 'a -> 'b) -> init:'b -> 'a BatEnum.t -> 'b val fold2 : f:('a -> 'b -> 'c -> 'c) -> init:'c -> 'a BatEnum.t -> 'b BatEnum.t -> 'c val iteri : f:(int -> 'a -> unit) -> 'a BatEnum.t -> unit val iter2i : f:(int -> 'a -> 'b -> unit) -> 'a BatEnum.t -> 'b BatEnum.t -> unit val foldi : f:(int -> 'a -> 'b -> 'b) -> init:'b -> 'a BatEnum.t -> 'b val fold2i : f:(int -> 'a -> 'b -> 'c -> 'c) -> init:'c -> 'a BatEnum.t -> 'b BatEnum.t -> 'c val find : f:('a -> bool) -> 'a BatEnum.t -> 'a val take_while : f:('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t val drop_while : f:('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t val map : f:('a -> 'b) -> 'a BatEnum.t -> 'b BatEnum.t val mapi : f:(int -> 'a -> 'b) -> 'a BatEnum.t -> 'b BatEnum.t val filter : f:('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t val filter_map : f:('a -> 'b option) -> 'a BatEnum.t -> 'b BatEnum.t val from : f:(unit -> 'a) -> 'a BatEnum.t val from_while : f:(unit -> 'a option) -> 'a BatEnum.t val from_loop : init:'b -> f:('b -> 'a * 'b) -> 'a BatEnum.t val seq : init:'a -> f:('a -> 'a) -> cnd:('a -> bool) -> 'a BatEnum.t val unfold : init:'b -> f:('b -> ('a * 'b) option) -> 'a BatEnum.t val init : int -> f:(int -> 'a) -> 'a BatEnum.t val switch : f:('a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t * 'a BatEnum.t val compare : ?cmp:('a -> 'a -> int) -> 'a BatEnum.t -> 'a BatEnum.t -> int val uniq : ?cmp:('a -> 'a -> bool) -> 'a BatEnum.t -> 'a BatEnum.t module LExceptionless : sig val find : f:('a -> bool) -> 'a BatEnum.t -> 'a option end end val iapp : 'a BatEnum.t -> 'a BatEnum.t -> 'a BatEnum.t val icons : 'a -> 'a BatEnum.t -> 'a BatEnum.t val ising : 'a -> 'a BatEnum.t val lapp : (unit -> 'a BatEnum.t) -> 'a BatEnum.t -> 'a BatEnum.t val lcons : (unit -> 'a) -> 'a BatEnum.t -> 'a BatEnum.t val lsing : (unit -> 'a) -> 'a BatEnum.t val slazy : (unit -> 'a BatEnum.t) -> 'a BatEnum.t end`