Release coccinelle-0.2.0

[bpt/coccinelle.git] / commons / ocamlextra / enum.mli

(* \r
 * Enum - enumeration over abstract collection of elements.\r
 * Copyright (C) 2003 Nicolas Cannasse\r
 * \r
 * This library is free software; you can redistribute it and/or\r
 * modify it under the terms of the GNU Lesser General Public\r
 * License as published by the Free Software Foundation; either\r
 * version 2.1 of the License, or (at your option) any later version,\r
 * with the special exception on linking described in file LICENSE.\r
 *\r
 * This library is distributed in the hope that it will be useful,\r
 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\r
 * Lesser General Public License for more details.\r
 *\r
 * You should have received a copy of the GNU Lesser General Public\r
 * License along with this library; if not, write to the Free Software\r
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
 *)\r
\r
(** Enumeration over abstract collection of elements.\r
\r
 Enumerations are entirely functional and most of the operations do not\r
 actually require the allocation of data structures. Using enumerations\r
 to manipulate data is therefore efficient and simple. All data structures in\r
 ExtLib such as lists, arrays, etc. have support to convert from and to\r
 enumerations.\r
*)\r
\r
\r
type 'a t\r
\r
(** {6 Final functions}\r
\r
 These functions consume the enumeration until\r
 it ends or an exception is raised by the first\r
 argument function.\r
*)\r
\r
val iter : ('a -> unit) -> 'a t -> unit\r
(** [iter f e] calls the function [f] with each elements of [e] in turn. *)\r
\r
val iter2 : ('a -> 'b -> unit) -> 'a t -> 'b t -> unit\r
(** [iter2 f e1 e2] calls the function [f] with the next elements of [e] and\r
 [e2] repeatedly until one of the two enumerations ends. *)\r
\r
val fold : ('a -> 'b -> 'b) -> 'b -> 'a t -> 'b\r
(** [fold f v e] returns v if e is empty,\r
  otherwise [f (... (f (f v a1) a2) ...) aN] where a1..N are\r
  the elements of [e]. \r
*)\r
\r
val fold2 : ('a -> 'b -> 'c -> 'c) -> 'c -> 'a t -> 'b t -> 'c\r
(** [fold2] is similar to [fold] but will fold over two enumerations at the\r
 same time until one of the two enumerations ends. *)\r
\r
(** Indexed functions : these functions are similar to previous ones\r
 except that they call the function with one additional argument which\r
 is an index starting at 0 and incremented after each call to the function. *)\r
\r
val iteri : (int -> 'a -> unit) -> 'a t -> unit\r
\r
val iter2i : ( int -> 'a -> 'b -> unit) -> 'a t -> 'b t -> unit\r
\r
val foldi : (int -> 'a -> 'b -> 'b) -> 'b -> 'a t -> 'b\r
\r
val fold2i : (int -> 'a -> 'b -> 'c -> 'c) -> 'c -> 'a t -> 'b t -> 'c\r
\r
(** {6 Useful functions} *)\r
\r
val find : ('a -> bool) -> 'a t -> 'a\r
(** [find f e] returns the first element [x] of [e] such that [f x] returns\r
 [true], consuming the enumeration up to and including the\r
 found element, or, raises [Not_found] if no such element exists\r
 in the enumeration, consuming the whole enumeration in the search.\r
\r
 Since [find] consumes a prefix of the enumeration, it can be used several \r
 times on the same enumeration to find the next element. *)\r
\r
val is_empty : 'a t -> bool\r
(** [is_empty e] returns true if [e] does not contains any element. *)\r
\r
val peek : 'a t -> 'a option\r
(** [peek e] returns [None] if [e] is empty or [Some x] where [x] is\r
 the next element of [e]. The element is not removed from the enumeration. *)\r
\r
val get : 'a t -> 'a option\r
(** [get e] returns [None] if [e] is empty or [Some x] where [x] is\r
  the next element of [e], in which case the element is removed from the enumeration. *)\r
\r
val push : 'a t -> 'a -> unit\r
(** [push e x] will add [x] at the beginning of [e]. *)\r
\r
val junk : 'a t -> unit\r
(** [junk e] removes the first element from the enumeration, if any. *)\r
\r
val clone : 'a t -> 'a t\r
(** [clone e] creates a new enumeration that is copy of [e]. If [e]\r
 is consumed by later operations, the clone will not get affected. *)\r
\r
val force : 'a t -> unit\r
(** [force e] forces the application of all lazy functions and the\r
 enumeration of all elements, exhausting the enumeration. \r
 \r
  An efficient intermediate data structure\r
  of enumerated elements is constructed and [e] will now enumerate over\r
  that data structure. *)\r
\r
(** {6 Lazy constructors}\r
\r
 These functions are lazy which means that they will create a new modified\r
 enumeration without actually enumerating any element until they are asked\r
 to do so by the programmer (using one of the functions above).\r
 \r
 When the resulting enumerations of these functions are consumed, the\r
 underlying enumerations they were created from are also consumed. *)\r
\r
val map : ('a -> 'b) -> 'a t -> 'b t\r
(** [map f e] returns an enumeration over [(f a1, f a2, ... , f aN)] where\r
 a1...N are the elements of [e]. *)\r
\r
val mapi : (int -> 'a -> 'b) -> 'a t -> 'b t\r
(** [mapi] is similar to [map] except that [f] is passed one extra argument\r
 which is the index of the element in the enumeration, starting from 0. *)\r
\r
val filter : ('a -> bool) -> 'a t -> 'a t\r
(** [filter f e] returns an enumeration over all elements [x] of [e] such\r
 as [f x] returns [true]. *)\r
\r
val filter_map : ('a -> 'b option) -> 'a t -> 'b t\r
(** [filter_map f e] returns an enumeration over all elements [x] such as\r
 [f y] returns [Some x] , where [y] is an element of [e]. *)\r
\r
val append : 'a t -> 'a t -> 'a t\r
(** [append e1 e2] returns an enumeration that will enumerate over all\r
 elements of [e1] followed by all elements of [e2]. *)\r
\r
val concat : 'a t t -> 'a t\r
(** [concat e] returns an enumeration over all elements of all enumerations\r
 of [e]. *)\r
\r
(** {6 Constructors} \r
\r
 In this section the word {i shall} denotes a semantic\r
 requirement. The correct operation\r
 of the functions in this interface are conditional\r
 on the client meeting these requirements.\r
*)\r
\r
exception No_more_elements\r
(** This exception {i shall} be raised by the [next] function of [make] \r
  or [from] when no more elements can be enumerated, it {i shall not}\r
  be raised by any function which is an argument to any\r
  other function specified in the interface.\r
*)\r
\r
val empty : unit -> 'a t\r
(** The empty enumeration : contains no element *)\r
\r
val make : next:(unit -> 'a) -> count:(unit -> int) -> clone:(unit -> 'a t) -> 'a t\r
(** This function creates a fully defined enumeration.\r
	{ul {li the [next] function {i shall} return the next element of the\r
	enumeration or raise [No_more_elements] if the underlying data structure\r
	does not have any more elements to enumerate.}\r
	{li the [count] function {i shall} return the actual number of remaining\r
	elements in the enumeration.}\r
	{li the [clone] function {i shall} create a clone of the enumeration\r
	such as operations on the original enumeration will not affect the\r
	clone. }}\r
 \r
	For some samples on how to correctly use [make], you can have a look\r
		at implementation of [ExtList.enum]. \r
*)\r
\r
val from : (unit -> 'a) -> 'a t\r
(** [from next] creates an enumeration from the [next] function.\r
 [next] {i shall} return the next element of the enumeration or raise\r
 [No_more_elements] when no more elements can be enumerated. Since the\r
 enumeration definition is incomplete, a call to [clone] or [count] will\r
 result in a call to [force] that will enumerate all elements in order to\r
 return a correct value. *)\r
\r
val init : int -> (int -> 'a) -> 'a t\r
(** [init n f] creates a new enumeration over elements\r
  [f 0, f 1, ..., f (n-1)] *)\r
\r
(** {6 Counting} *)\r
\r
val count : 'a t -> int\r
(** [count e] returns the number of remaining elements in [e] without\r
  consuming the enumeration.\r
\r
Depending of the underlying data structure that is implementing the\r
enumeration functions, the count operation can be costly, and even sometimes\r
can cause a call to [force]. *)\r
\r
val fast_count : 'a t -> bool\r
(** For users worried about the speed of [count] you can call the [fast_count]\r
    function that will give an hint about [count] implementation. Basically, if\r
    the enumeration has been created with [make] or [init] or if [force] has\r
    been called on it, then [fast_count] will return true. *)\r