Added a module of immutable arrays. Not as full as CArray, but should

be soon.

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/coq/trunk@16391 85f007b7-540e-0410-9357-904b9bb8a0f7

1 files changed, 46 insertions, 0 deletions

diff --git a/lib/iArray.mli b/lib/iArray.mli
new file mode 100644
index 000000000..911de4062
--- /dev/null
+++ b/lib/iArray.mli
@@ -0,0 +1,46 @@
+(***********************************************************************)
+(*  v      *   The Coq Proof Assistant  /  The Coq Development Team    *)
+(* <O___,, *        INRIA-Rocquencourt  &  LRI-CNRS-Orsay              *)
+(*   \VV/  *************************************************************)
+(*    //   *      This file is distributed under the terms of the      *)
+(*         *       GNU Lesser General Public License Version 2.1       *)
+(***********************************************************************)
+
+type +'a t
+(** Immutable arrays containing elements of type ['a]. *)
+
+(** {5 Operations inherited from [Array]}
+
+  Refer to the documentation of [CArray] for greater detail.
+
+*)
+
+val length : 'a t -> int
+val make : int -> 'a -> 'a t
+val init : int -> (int -> 'a) -> 'a t
+val append : 'a t -> 'a t -> 'a t
+val concat : 'a t list -> 'a t
+val sub : 'a t -> int -> int -> 'a t
+val of_list : 'a list -> 'a t
+val to_list : 'a t -> 'a list
+val iter : ('a -> unit) -> 'a t -> unit
+val iteri : (int -> 'a -> unit) -> 'a t -> unit
+val map : ('a -> 'b) -> 'a t -> 'b t
+val mapi : (int -> 'a -> 'b) -> 'a t -> 'b t
+val fold_right : ('a -> 'b -> 'b) -> 'b -> 'a t -> 'b
+val fold_left : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a
+
+(** {5 Unsafe operations} *)
+
+module Unsafe :
+sig
+  val get : 'a t -> int -> 'a
+  (** Get a value, does not do bound checking. *)
+
+  val of_array : 'a array -> 'a t
+  (** Cast a mutable array into an immutable one. Essentially identity. *)
+
+  val to_array : 'a t -> 'a array
+  (** Cast an immutable array into a mutable one. Essentially identity. *)
+end
+(** Unsafe operations. Use with caution! *)