Module Res.MakeArray

length ra

• Returns (virtual) length of resizable array ra excluding the reserved space.

lix ra

• Returns (virtual) last index of resizable array ra excluding the reserved space.

real_length ra

• Returns (real) length of resizable array ra including the reserved space.

real_lix ra

• Returns (real) last index of resizable array ra including the reserved space.

get ra n

• Returns the nth element of ra.
• Raises Invalid_argument: if index out of bounds.

set ra n sets the nth element of ra.

• Raises Invalid_argument: if index out of bounds.

sempty s

• Returns an empty resizable array using strategy s.

empty () same as sempty but uses default strategy.

screate s n el

• Returns a resizable array of length n containing element el only using strategy s.

create n el same as screate but uses default strategy.

smake s n el same as screate.

make n el same as create.

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.

init n f sames as sinit but uses default strategy.

get_strategy ra

• Returns the reallocation strategy used by resizable array ra.

set_strategy ra s sets the reallocation strategy of resizable array ra to s, possibly causing an immediate reallocation.

put_strategy ra s sets the reallocation strategy of resizable array ra to s. Reallocation is only done at later changes in size.

enforce_strategy ra forces a reallocation if necessary (e.g. after a put_strategy.

make_matrix sx sy el creates a (resizable) matrix of dimensions sx and sy containing element el only. Both dimensions are controlled by the default strategy.

copy ra

• Returns a copy of resizable array ra. The two arrays share the same strategy!

sub ra ofs len

• Returns a resizable subarray of length len from resizable array ra starting at offset ofs using the default strategy.
• Raises Invalid_argument: if parameters do not denote a correct subarray.

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.

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.

append ra1 ra2

• Returns a new resizable array using the default strategy and copying ra1 and ra2 in this order onto it.

concat l

• Returns a new resizable array using the default strategy and copying all resizable arrays in l in their respective order onto it.

add_one ra el adds element el to resizable array ra, possibly causing a reallocation.

remove_one ra removes the last element of resizable array ra, possibly causing a reallocation.

• Raises Failure: if the array is empty.

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.

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.

clear ra removes all elements from resizable array ra, possibly causing a reallocation.

swap ra n m swaps elements at indices n and m.

• Raises Invalid_argument: if any index is out of range.

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.

to_array ra converts a resizable array to a standard one.

sof_array s ar converts a standard array to a resizable one, using strategy s.

of_array ar converts a standard array to a resizable one using the default strategy.

to_list ra converts resizable array ra to a list.

sof_list s l creates a resizable array using strategy s and the elements in list l.

of_list l creates a resizable array using the default strategy and the elements in list l.

iter f ra applies the unit-function f to each element in resizable array ra.

map f ra

• Returns a resizable array using the strategy of ra and mapping each element in ra to its corresponding position in the new array using function f.

iteri f ra applies the unit-function f to each index and element in resizable array ra.

mapi f ra

• Returns a resizable array using the strategy of ra and mapping each element in ra to its corresponding position in the new array using function f and the index position.

fold_left f a ra left-folds values in resizable array ra using function f and start accumulator a.

fold_right f a ra right-folds values in resizable array ra using function f and start accumulator a.

for_all p ra

• Returns true if all elements in resizable array ra satisfy the predicate p, false otherwise.

exists p ra

• Returns true if at least one element in resizable array ra satisfies the predicate p, false otherwise.

mem el ra

• Returns true if element el is logically equal to any element in resizable array ra, false otherwise.

memq el ra

• Returns true if element el is physically equal to any element in resizable array ra, false otherwise.

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.

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.

find p ra

• Returns the first element in resizable array ra that satisfies predicate p.
• Raises Not_found: if there is no such element.

find_index p ra pos

• Returns the index of the first element that satisfies predicate p in resizable array ra, starting search at index pos.
• Raises Not_found: if there is no such element or if pos is larger than the highest index.
• Raises Invalid_argument: if pos is negative.

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.

find_all p ra is the same as filter

filter_in_place p ra as filter, but filters in place.

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.