mirror of
https://github.com/c-cube/sidekick.git
synced 2025-12-06 11:15:43 -05:00
80 lines
2.5 KiB
OCaml
80 lines
2.5 KiB
OCaml
(* This file is free software. See file "license" for more details. *)
|
|
|
|
type 'a t = private 'a array
|
|
(** Array of values of type 'a. The underlying type really is
|
|
an array, but it will never be modified.
|
|
|
|
It should be covariant but OCaml will not accept it. *)
|
|
|
|
val empty : 'a t
|
|
val is_empty : _ t -> bool
|
|
val length : _ t -> int
|
|
val sub : 'a t -> int -> int -> 'a t
|
|
val singleton : 'a -> 'a t
|
|
val doubleton : 'a -> 'a -> 'a t
|
|
|
|
val make : int -> 'a -> 'a t
|
|
(** [make n x] makes an array of [n] times [x] *)
|
|
|
|
val init : int -> (int -> 'a) -> 'a t
|
|
(** [init n f] makes the array [[| f 0; f 1; ... ; f (n-1) |]].
|
|
@raise Invalid_argument if [n < 0] *)
|
|
|
|
val get : 'a t -> int -> 'a
|
|
(** Access the element *)
|
|
|
|
val unsafe_get : 'a t -> int -> 'a
|
|
(** Unsafe access, not bound-checked. Use with caution *)
|
|
|
|
val set : 'a t -> int -> 'a -> 'a t
|
|
(** Copy the array and modify its copy *)
|
|
|
|
val map : ('a -> 'b) -> 'a t -> 'b t
|
|
val mapi : (int -> 'a -> 'b) -> 'a t -> 'b t
|
|
val append : 'a t -> 'a t -> 'a t
|
|
val iter : ('a -> unit) -> 'a t -> unit
|
|
val iteri : (int -> 'a -> unit) -> 'a t -> unit
|
|
val foldi : ('a -> int -> 'b -> 'a) -> 'a -> 'b t -> 'a
|
|
val fold : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a
|
|
val for_all : ('a -> bool) -> 'a t -> bool
|
|
val exists : ('a -> bool) -> 'a t -> bool
|
|
|
|
(** {2 Conversions} *)
|
|
|
|
type 'a iter = ('a -> unit) -> unit
|
|
type 'a gen = unit -> 'a option
|
|
|
|
val of_list : 'a list -> 'a t
|
|
val to_list : 'a t -> 'a list
|
|
val of_list_map : ('a -> 'b) -> 'a list -> 'b t
|
|
val to_list_map : ('a -> 'b) -> 'a t -> 'b list
|
|
val of_array_map : ('a -> 'b) -> 'a array -> 'b t
|
|
val to_array_map : ('a -> 'b) -> 'a t -> 'b array
|
|
|
|
val of_array_unsafe : 'a array -> 'a t
|
|
(** Take ownership of the given array. Careful, the array must {b NOT}
|
|
be modified afterwards! *)
|
|
|
|
val to_iter : 'a t -> 'a iter
|
|
val to_iter_sub : 'a t -> int -> int -> 'a iter
|
|
val of_iter : 'a iter -> 'a t
|
|
val of_gen : 'a gen -> 'a t
|
|
val to_gen : 'a t -> 'a gen
|
|
|
|
(** {2 IO} *)
|
|
|
|
type 'a printer = Format.formatter -> 'a -> unit
|
|
|
|
val print :
|
|
?start:string -> ?stop:string -> ?sep:string -> 'a printer -> 'a t printer
|
|
|
|
(** {2 Binary} *)
|
|
|
|
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
|
|
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
|
|
val for_all2 : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
|
|
val exists2 : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
|
|
val map2 : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t
|
|
val fold2 : ('acc -> 'a -> 'b -> 'acc) -> 'acc -> 'a t -> 'b t -> 'acc
|
|
val iteri2 : (int -> 'a -> 'b -> unit) -> 'a t -> 'b t -> unit
|
|
val iter2 : ('a -> 'b -> unit) -> 'a t -> 'b t -> unit
|