# Module BatRefList

    module BatRefList: sig .. end

Reference on lists.

RefList is a extended set of functions that manipulate list references.
Author(s): Nicolas Cannasse, David Teller (Boilerplate code)

    exception Empty_list

    type 'a t

The type of an empty ref list

    val empty : unit -> 'a t

Returns a new empty ref list

    val is_empty : 'a t -> bool

Return `true` if a ref list is empty

    val clear : 'a t -> unit

Removes all elements

    val length : 'a t -> int

Returns the number of elements - O(n)

    val copy : dst:'a t -> src:'a t -> unit

Makes a copy of a ref list - O(1)

    val copy_list : dst:'a t -> src:'a list -> unit

Makes a copy of a list - O(1)

    val copy_enum : dst:'a t -> src:'a BatEnum.t -> unit

Makes a copy of a enum.
`dst` : A reflist, whose contents will be forgotten.

    val of_list : 'a list -> 'a t

Creates a ref list from a list - O(1)

    val to_list : 'a t -> 'a list

Returns the current elements as a list - O(1)

    val of_enum : 'a BatEnum.t -> 'a t

Creates a ref list from an enumeration

    val enum : 'a t -> 'a BatEnum.t

Returns an enumeration of current elements in the ref list

    val of_backwards : 'a BatEnum.t -> 'a t

Creates a ref list from an enumeration, going from last to first

    val backwards : 'a t -> 'a BatEnum.t

Returns an enumeration of current elements in the ref list, going from last to first

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

Adds an element at the end - O(n)

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

Adds an element at the head - O(1)

    val add_sort : cmp:('a -> 'a -> int) -> 'a t -> 'a -> unit

Adds an element in a sorted list, using the given comparator.

    val first : 'a t -> 'a

Returns the first element or raises `Empty_list` if the ref list is empty

    val last : 'a t -> 'a

Returns the last element - O(n) or raises `Empty_list` if the ref list is empty

    val pop : 'a t -> 'a

Removes and returns the first element or raises `Empty_list` if the ref list is empty

    val npop : 'a t -> int -> 'a list

Removes and returns the n first elements or raises `Empty_list` if the ref list does not contain enough elements

    val hd : 'a t -> 'a

same as `first`

    val tl : 'a t -> 'a t

Returns a ref list containing the same elements but without the first one or raises `Empty_list` if the ref list is empty

    val rev : 'a t -> unit

Reverses the ref list - O(n)

###### Functional Operations

    val fold_left : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a

`List.fold_left f a (ref [b0; b1; ...; bn])` is `f (... (f (f a b0) b1) ...) bn`.

    val fold_right : ('a -> 'b -> 'b) -> 'a t -> 'b -> 'b

`List.fold_right f (ref [a0; a1; ...; an]) b` is `f a0 (f a1 (... (f an b) ...))`. Tail-recursive.

    val iter : ('a -> unit) -> 'a t -> unit

Apply the given function to all elements of the ref list, in respect with the order of the list

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

Find the first element matching the specified predicate raise `Not_found` if no element is found

    val rfind : ('a -> bool) -> 'a t -> 'a

Find the first element in the reversed ref list matching the specified predicate raise `Not_found` if no element is found

    val find_exc : ('a -> bool) -> exn -> 'a t -> 'a

Same as find but takes an exception to be raised when no element is found as additional parameter

    val exists : ('a -> bool) -> 'a t -> bool

Return `true` if an element matches the specified predicate

    val for_all : ('a -> bool) -> 'a t -> bool

Return `true` if all elements match the specified predicate

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

Apply a function to all elements and return the ref list constructed with the function returned values

    val transform : ('a -> 'a) -> 'a t -> unit

transform all elements in the ref list using a function.

    val map_list : ('a -> 'b) -> 'a t -> 'b list

Apply a function to all elements and return the list constructed with the function returned values

    val sort : cmp:('a -> 'a -> int) -> 'a t -> unit

Sort elements using the specified comparator

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

Remove all elements that do not match the specified predicate

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

Remove an element from the ref list raise `Not_found` if the element is not found

    val remove_if : ('a -> bool) -> 'a t -> unit

Remove the first element matching the specified predicate raise `Not_found` if no element has been removed

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

Remove all elements equal to the specified element from the ref list

###### Boilerplate code

    module Index: sig .. end

Functions that operate on the element at index `i` in a list (with indices starting from 0).