Up  Next

Module type CCArray.S

module type S = sig .. end
type 'a t
Array, or sub-array, containing elements of type 'a
val empty : 'a t
val equal : 'a CCArray.equal -> 'a t CCArray.equal
val compare : 'a CCArray.ord -> 'a t CCArray.ord
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 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 0.21
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 of the i-th element of a in sort cmp a. In other words, map (fun i -> a.(i)) (sort_indices a) = sorted cmp a. a is not modified.
Since 0.21
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 position in sorted cmp a of the i-th element of a. a is not modified.

In other words, map (fun i -> (sorted cmp a).(i)) (sort_ranking cmp a) = a.

Without duplicates, we also have lookup_exn a.(i) (sorted a) = (sorted_ranking a).(i)
Since 0.21

val find : ('a -> 'b option) -> 'a t -> 'b option
find f a returns Some y if there is an element x such that f x = Some y, else it returns None
val findi : (int -> 'a -> 'b option) -> 'a t -> 'b option
Like CCArray.S.find, but also pass the index to the predicate function.
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 CCArray.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 CCArray.ord -> 'a -> 'a t -> int
Same as CCArray.S.lookup_exn, 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 CCArray.random_gen
Choose an element randomly.
Raises Not_found if the array/slice is empty
val to_seq : 'a t -> 'a CCArray.sequence
val to_gen : 'a t -> 'a CCArray.gen
val to_klist : 'a t -> 'a CCArray.klist

IO


val pp : ?sep:string -> (Buffer.t -> 'a -> unit) -> Buffer.t -> 'a t -> unit
Print an array of items with printing function
val pp_i : ?sep:string ->
       (Buffer.t -> int -> 'a -> unit) -> Buffer.t -> 'a t -> unit
Print an array, giving the printing function both index and item
val print : ?sep:string ->
       (Format.formatter -> 'a -> unit) ->
       Format.formatter -> 'a t -> unit
Print an array of items with printing function