module type T = sig .. end
Signatures and types
module Strategy: Strat.T
Module implementing the reallocation strategy
type Strategy.t
Type of reallocation strategy
type 'a t
Type of parameterized resizable arrays
val length : 'a t -> int
length ra
Returns (virtual) length of resizable array ra
excluding the reserved space.
val lix : 'a t -> int
lix ra
Returns (virtual) last index of resizable array ra
excluding the reserved space.
val real_length : 'a t -> int
real_length ra
Returns (real) length of resizable array ra
including the reserved space.
val real_lix : 'a t -> int
real_lix ra
Returns (real) last index of resizable array ra
including the reserved space.
Getting, setting and checking
val get : 'a t -> int -> 'a option
get ra n
Raises Invalid_argument if index out of bounds.
Returns the nth element of ra.
val get_copy : 'a t -> int -> 'a option
get_copy ra n see documentation of module Weak in the standard
distribution.
val check : 'a t -> int -> bool
check ra n
Returns true if the
nth cell of
ra is
full,
false if it is empty. Note that even if
check ar n
returns
true, a subsequent
Weak_intf.T.get ar n can return
None.
val set : 'a t -> int -> 'a option -> unit
set ra n sets the nth element of ra.
Raises Invalid_argument if index out of bounds.
Creation of resizable arrays
val sempty : strategy -> 'a t
sempty s
Returns an empty resizable array using strategy s.
val empty : unit -> 'a t
empty () same as sempty but uses default strategy.
val screate : strategy -> int -> 'a t
screate s n el
Returns a resizable array of length n
using strategy s.
val create : int -> 'a t
create n same as screate but uses default strategy.
val sinit : strategy -> int -> (int -> 'a option) -> 'a t
sinit s n f
Returns an array of length n containing
elements that were created by applying function f to the index,
using strategy s.
val init : int -> (int -> 'a option) -> 'a t
init n f sames as sinit but uses default strategy.
Strategy handling
val get_strategy : 'a t -> strategy
get_strategy ra
Returns the reallocation strategy used by
resizable array ra.
val set_strategy : 'a t -> strategy -> unit
set_strategy ra s sets the reallocation strategy of
resizable array ra to s, possibly causing an immediate
reallocation.
val put_strategy : 'a t -> strategy -> unit
put_strategy ra s sets the reallocation strategy of
resizable array ra to s. Reallocation is only done at later
changes in size.
val enforce_strategy : 'a t -> unit
enforce_strategy ra forces a reallocation if necessary
(e.g. after a put_strategy.
Copying, blitting and range extraction
val copy : 'a t -> 'a t
copy ra
Returns a copy of resizable array ra. The two
arrays share the same strategy!
val sub : 'a t -> int -> int -> 'a t
sub ra ofs len
Raises Invalid_argument if parameters do not denote a correct
subarray.
Returns a resizable subarray of length len
from resizable array ra starting at offset ofs using the
default strategy.
val fill : 'a t -> int -> int -> 'a option -> unit
fill ra ofs len el fills resizable array ra from offset
ofs with len elements el, possibly adding elements at the
end. Raises Invalid_argument if offset ofs is larger than the
length of the array.
val blit : 'a t -> int -> 'a t -> int -> int -> unit
blit ra1 ofs1 ra2 ofs2 len blits resizable array ra1 onto
ra2 reading len elements from offset ofs1 and writing them
to ofs2, possibly adding elements at the end of ra2. Raises
Invalid_argument if ofs1 and len do not designate a valid
subarray of ra1 or if ofs2 is larger than the length of
ra2.
Combining resizable arrays
val append : 'a t -> 'a t -> 'a t
append ra1 ra2
Returns a new resizable array using the
default strategy and copying ra1 and ra2 in this order onto
it.
val concat : 'a t list -> 'a t
concat l
Returns a new resizable array using the default
strategy and copying all resizable arrays in l in their respective
order onto it.
Adding and removing elements
val add_one : 'a t -> 'a option -> unit
add_one ra el adds element el to resizable array ra,
possibly causing a reallocation.
val remove_one : 'a t -> unit
remove_one ra removes the last element of resizable array
ra, possibly causing a reallocation.
Raises Failure if the array is empty.
val remove_n : 'a t -> int -> unit
remove_n ra n removes the last n elements of resizable
array ra, possibly causing a reallocation.
Raises Invalid_arg if there are not enough elements or n < 0.
val remove_range : 'a t -> int -> int -> unit
remove_range ra ofs len removes len elements from resizable
array ra starting at ofs and possibly causing a
reallocation.
Raises Invalid_argument if range is invalid.
val clear : 'a t -> unit
clear ra removes all elements from resizable array ra,
possibly causing a reallocation.
Swapping
val swap : 'a t -> int -> int -> unit
swap ra n m swaps elements at indices n and m.
Raises Invalid_argument if any index is out of range.
val swap_in_last : 'a t -> int -> unit
swap_in_last ra n swaps the last element with the one at
position n.
Raises Invalid_argument if index n is out of range.
Standard conversions
val to_std : 'a t -> 'a Weak.t
to_std ra converts a resizable weak array to a standard one.
val sof_std : strategy -> 'a Weak.t -> 'a t
sof_std s ar converts a standard weak array to a resizable
one, using strategy s.
val of_std : 'a Weak.t -> 'a t
of_std ar converts a standard weak array to a resizable one
using the default strategy.
List conversions
val to_list : 'a t -> 'a option list
to_list ra converts resizable array ra to a list.
val of_list : 'a option list -> 'a t
of_list l creates a resizable array using the default
strategy and the elements in list l.
Iterators
val iter : ('a option -> unit) -> 'a t -> unit
iter f ra applies the unit-function f to each element in
resizable array ra.
val iteri : (int -> 'a option -> unit) -> 'a t -> unit
iteri f ra applies the unit-function f to each index and
element in resizable array ra.
val fold_left : ('b -> 'a option -> 'b) -> 'b -> 'a t -> 'b
fold_left f a ra left-folds values in resizable array ra
using function f and start accumulator a.
val fold_right : ('a option -> 'b -> 'b) -> 'a t -> 'b -> 'b
fold_right f a ra right-folds values in resizable array ra
using function f and start accumulator a.
Scanning of resizable arrays
val for_all : ('a option -> bool) -> 'a t -> bool
for_all p ra
Returns true if all elements in resizable
array ra satisfy the predicate p, false otherwise.
val exists : ('a option -> bool) -> 'a t -> bool
exists p ra
Returns true if at least one element in
resizable array ra satisfies the predicate p, false
otherwise.
val mem : 'a option -> 'a t -> bool
mem el ra
Returns true if element el is logically equal
to any element in resizable array ra, false otherwise.
val memq : 'a option -> 'a t -> bool
memq el ra
Returns true if element el is physically equal
to any element in resizable array ra, false otherwise.
val pos : 'a option -> 'a t -> int option
pos el ra
Returns Some index if el is logically
equal to the element at index in ra, None otherwise. index
is the index of the first element that matches.
val posq : 'a option -> 'a t -> int option
posq el ra
Returns Some index if el is physically
equal to the element at index in ra, None otherwise. index
is the index of the first element that matches.
Searching of resizable arrays
val find : ('a option -> bool) -> 'a t -> 'a option
find p ra
Raises Not_found if there is no such element.
Returns the first element in resizable array ra
that satisfies predicate p.
val find_index : ('a option -> bool) -> 'a t -> int -> int
find_index p ra pos
RaisesNot_found if there is no such element or if pos is larger
than the highest index.Invalid_argument if pos is negative.
Returns the index of the first element
that satisfies predicate
p in resizable array
ra, starting
search at index
pos.
val filter : ('a option -> bool) -> 'a t -> 'a t
filter p ra
Returns a new resizable array by filtering
out all elements in ra that satisfy predicate p using the same
strategy as ra.
val find_all : ('a option -> bool) -> 'a t -> 'a t
find_all p ra is the same as filter
val filter_in_place : ('a option -> bool) -> 'a t -> unit
filter_in_place p ra as filter, but filters in place.
val partition : ('a option -> bool) ->
'a t -> 'a t * 'a t
partition p ra
Returns a pair of resizable arrays, the
left part containing only elements of ra that satisfy predicate
p, the right one only those that do not satisfy it. Both returned
arrays are created using the strategy of ra.
UNSAFE STUFF - USE WITH CAUTION!
val unsafe_get : 'a t -> int -> 'a option
val unsafe_set : 'a t -> int -> 'a option -> unit
val unsafe_sub : 'a t -> int -> int -> 'a t
val unsafe_fill : 'a t -> int -> int -> 'a option -> unit
val unsafe_blit : 'a t -> int -> 'a t -> int -> int -> unit
val unsafe_remove_one : 'a t -> unit
val unsafe_remove_n : 'a t -> int -> unit
val unsafe_swap : 'a t -> int -> int -> unit
val unsafe_swap_in_last : 'a t -> int -> unit