Module CCArray

module CCArray: sig .. end

Array utils



type 'a sequence = ('a -> unit) -> unit 
type 'a klist = unit -> [ `Cons of 'a * 'a klist | `Nil ] 
type 'a gen = unit -> 'a option 
type 'a equal = 'a -> 'a -> bool 
type 'a ord = 'a -> 'a -> int 
type 'a random_gen = Random.State.t -> 'a 
type 'a printer = Format.formatter -> 'a -> unit 

Arrays


include Array
type 'a t = 'a array 
val empty : 'a t
val equal : 'a equal -> 'a t equal
val compare : 'a ord -> 'a t ord
val swap : 'a t -> int -> int -> unit
swap arr i j swaps elements at indices i and j.
Since NEXT_RELEASE
val get : 'a t -> int -> 'a
val get_safe : 'a t -> int -> 'a option
get_safe a i returns Some a.(i) if i is a valid index
Since 0.18
val set : 'a t -> int -> 'a -> unit
val length : 'a t -> int
val fold : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a
val foldi : ('a -> int -> 'b -> 'a) -> 'a -> 'b t -> 'a
Fold left on array, with index
val fold_while : ('a -> 'b -> 'a * [ `Continue | `Stop ]) -> 'a -> 'b t -> 'a
Fold left on array until a stop condition via ('a, `Stop) is indicated by the accumulator
Since 0.8
val fold_map : ('acc -> 'a -> 'acc * 'b) -> 'acc -> 'a t -> 'acc * 'b t
fold_map f acc a is a fold_left-like function, but it also maps the array to another array.
Since 1.2
val scan_left : ('acc -> 'a -> 'acc) -> 'acc -> 'a t -> 'acc t
scan_left f acc a returns the array [|acc; f acc x0; f (f acc a.(0)) a.(1); …|]
Since 1.2
val iter : ('a -> unit) -> 'a t -> unit
val iteri : (int -> 'a -> unit) -> 'a t -> unit
val blit : 'a t -> int -> 'a t -> int -> int -> unit
blit from i into j len copies len elements from the first array to the second. See Array.blit.
val reverse_in_place : 'a t -> unit
Reverse the array in place
val sorted : ('a -> 'a -> int) -> 'a t -> 'a array
sorted cmp a makes a copy of a and sorts it with cmp.
Since 1.0
val sort_indices : ('a -> 'a -> int) -> 'a t -> int array
sort_indices cmp a returns a new array b, with the same length as a, such that b.(i) is the index at which the i-th element of sorted cmp a appears in a. a is not modified.

In other words, map (fun i -> a.(i)) (sort_indices cmp a) = sorted cmp a. sort_indices yields the inverse permutation of CCArray.sort_ranking.
Since 1.0

val sort_ranking : ('a -> 'a -> int) -> 'a t -> int array
sort_ranking cmp a returns a new array b, with the same length as a, such that b.(i) is the index at which the i-the element of a appears in sorted cmp a. a is not modified.

In other words, map (fun i -> (sorted cmp a).(i)) (sort_ranking cmp a) = a. sort_ranking yields the inverse permutation of CCArray.sort_indices.

In the absence of duplicate elements in a, we also have lookup_exn a.(i) (sorted a) = (sorted_ranking a).(i)
Since 1.0

val find_map : ('a -> 'b option) -> 'a t -> 'b option
find_map f a returns Some y if there is an element x such that f x = Some y, else it returns None
Since 1.3
val find : ('a -> 'b option) -> 'a t -> 'b option
Deprecated.since 1.3
Alias to CCArray.find_map
val find_map_i : (int -> 'a -> 'b option) -> 'a t -> 'b option
Like CCArray.find_map, but also pass the index to the predicate function.
Since 1.3
val findi : (int -> 'a -> 'b option) -> 'a t -> 'b option
Deprecated.since 1.3
Alias to CCArray.find_map_i
Since 0.3.4
val find_idx : ('a -> bool) -> 'a t -> (int * 'a) option
find_idx p x returns Some (i,x) where x is the i-th element of l, and p x holds. Otherwise returns None
Since 0.3.4
val lookup : ?cmp:'a ord -> 'a -> 'a t -> int option
Lookup the index of some value in a sorted array.
Returns None if the key is not present, or Some i (i the index of the key) otherwise
val lookup_exn : ?cmp:'a ord -> 'a -> 'a t -> int
Same as CCArray.lookup, but
Raises Not_found if the key is not present
val bsearch : ?cmp:('a -> 'a -> int) ->
'a ->
'a t ->
[ `All_bigger | `All_lower | `At of int | `Empty | `Just_after of int ]
bsearch ?cmp x arr finds the index of the object x in the array arr, provided arr is sorted using cmp. If the array is not sorted, the result is not specified (may raise Invalid_argument).

Complexity: O(log n) where n is the length of the array (dichotomic search).
Since 0.13
Raises Invalid_argument if the array is found to be unsorted w.r.t cmp
Returns - `At i if cmp arr.(i) x = 0 (for some i)


val for_all : ('a -> bool) -> 'a t -> bool
val for_all2 : ('a -> 'b -> bool) -> 'a t -> 'b t -> bool
Forall on pairs of arrays.
Since 0.20
Raises Invalid_argument if they have distinct lengths allow different types
val exists : ('a -> bool) -> 'a t -> bool
val exists2 : ('a -> 'b -> bool) -> 'a t -> 'b t -> bool
Exists on pairs of arrays.
Since 0.20
Raises Invalid_argument if they have distinct lengths allow different types
val fold2 : ('acc -> 'a -> 'b -> 'acc) -> 'acc -> 'a t -> 'b t -> 'acc
Fold on two arrays stepwise.
Since 0.20
Raises Invalid_argument if they have distinct lengths
val iter2 : ('a -> 'b -> unit) -> 'a t -> 'b t -> unit
Iterate on two arrays stepwise.
Since 0.20
Raises Invalid_argument if they have distinct lengths
val shuffle : 'a t -> unit
Shuffle randomly the array, in place
val shuffle_with : Random.State.t -> 'a t -> unit
Like shuffle but using a specialized random state
val random_choose : 'a t -> 'a random_gen
Choose an element randomly.
Raises Not_found if the array/slice is empty
val to_seq : 'a t -> 'a sequence
val to_gen : 'a t -> 'a gen
val to_klist : 'a t -> 'a klist

IO


val pp : ?sep:string -> 'a printer -> 'a t printer
Print an array of items with printing function
val pp_i : ?sep:string -> (int -> 'a printer) -> 'a t printer
Print an array, giving the printing function both index and item
val map : ('a -> 'b) -> 'a t -> 'b t
val map2 : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t
Map on two arrays stepwise.
Since 0.20
Raises Invalid_argument if they have distinct lengths
val rev : 'a t -> 'a t
Copy + reverse in place
Since 0.20
val filter : ('a -> bool) -> 'a t -> 'a t
Filter elements out of the array. Only the elements satisfying the given predicate will be kept.
val filter_map : ('a -> 'b option) -> 'a t -> 'b t
Map each element into another value, or discard it
val flat_map : ('a -> 'b t) -> 'a t -> 'b array
Transform each element into an array, then flatten
val (>>=) : 'a t -> ('a -> 'b t) -> 'b t
Infix version of CCArray.flat_map
val (>>|) : 'a t -> ('a -> 'b) -> 'b t
Infix version of CCArray.map
Since 0.8
val (>|=) : 'a t -> ('a -> 'b) -> 'b t
Infix version of CCArray.map
Since 0.8
val except_idx : 'a t -> int -> 'a list
Remove given index, obtaining the list of the other elements
val (--) : int -> int -> int t
Range array
val (--^) : int -> int -> int t
Range array, excluding right bound
Since 0.17
val random : 'a random_gen -> 'a t random_gen
val random_non_empty : 'a random_gen -> 'a t random_gen
val random_len : int -> 'a random_gen -> 'a t random_gen

Generic Functions


module type MONO_ARRAY = sig .. end
val sort_generic : (module CCArray.MONO_ARRAY with type elt = 'elt and type t = 'arr) ->
?cmp:('elt -> 'elt -> int) -> 'arr -> unit
Sort the array, without allocating (eats stack space though). Performance might be lower than Array.sort.
Since 0.14