Module BatVect.Make

The type of a polymorphic vect.

Raised when an operation violates the bounds of the vect.

Maximum length of the vect. No function detect when one tries to add more elements than the container can hold. They create broken structures which may cause other functions of this module to raise exceptions when operating on them.

The empty vect.

Returns a vect of length 1 holding only the given element.

of_container s returns a vect corresponding to the container s. Operates in O(n) time.

to_container r returns a container corresponding to the vect r.

of_array s returns a vect corresponding to the array s. Operates in O(n) time.

to_array r returns an array corresponding to the vect r.

Returns a list with the elements contained in the vect.

make i c returns a vect of length i whose elements are all equal to c; it is similar to Array.make

init n f returns a fresh vect of length n, with element number i initialized to the result of f i. In other terms, init n f tabulates the results of f applied to the integers 0 to n-1.

• raises Invalid_argument

  if n < 0 or n > max_length.

Returns whether the vect is empty or not.

Returns the height (depth) of the vect.

Returns the length of the vect (O(1)).

balance r returns a balanced copy of the r vect. Note that vects are automatically rebalanced when their height exceeds a given threshold, but balance allows to invoke that operation explicitly.

concat r u concatenates the r and u vects. In general, it operates in O(log(min n1 n2)) amortized time. Small vects are treated specially and can be appended/prepended in amortized O(1) time.

append c r returns a new vect with the c element at the end in amortized O(1) time.

prepend c r returns a new vect with the c character at the beginning in amortized O(1) time.

get v n returns the (n+1)th element from the vect v; i.e. get v 0 returns the first element. Operates in worst-case O(log size) time.

• raises Out_of_bounds

  if a character out of bounds is requested.

as get

set v n c returns a copy of the v vect where the (n+1)th element (see also get) has been set to c. Operates in worst-case O(log size) time.

modify v n f is equivalent to set v n (f (get v n)), but more efficient. Operates in worst-case O(log size) time.

destructive_set v n c sets the element of index n in the v vect to c. This operation is destructive, and will also affect vects sharing the modified leaf with v. Use with caution.

sub r m n returns a sub-vect of r containing all the elements whose indexes range from m to m + n - 1 (included).

• raises Out_of_bounds

  in the same cases as Array.sub. Operates in worst-case O(log size) time.

insert n r u returns a copy of the u vect where r has been inserted between the elements with index n and n + 1 in the original vect. The length of the new vect is length u + length r. Operates in amortized O(log(size r) + log(size u)) time.

remove m n r returns the vect resulting from deleting the elements with indexes ranging from m to m + n - 1 (included) from the original vect r. The length of the new vect is length r - n. Operates in amortized O(log(size r)) time.

Returns an enumeration of the elements of the vector. Behavior of the enumeration is undefined if the contents of the vector changes afterwards.

Build a vector from an enumeration.

Returns an enumeration of the elements of a vector, from last to first. Behavior of the enumeration is undefined if the contents of the vector changes afterwards.

Build a vector from an enumeration, from last to first.

iter f r applies f to all the elements in the r vect, in order.

Operates like iter, but also passes the index of the character to the given function.

rangeiter f m n r applies f to all the elements whose indices k satisfy m <= k < m + n. It is thus equivalent to iter f (sub m n r), but does not create an intermediary vect. rangeiter operates in worst-case O(n + log m) time, which improves on the O(n log m) bound from an explicit loop using get.

• raises Out_of_bounds

  in the same cases as sub.

fold_left f a r computes f (... (f (f a r0) r1)...) rN-1 where rn = Vect.get n r and N = length r.

An alias for fold_left

as fold_left, but no initial value - just applies reducing function to elements from left to right.

fold_right f r a computes f (r0 ... (f rN-2 (f rN-1 a)) ...)) where rn = Vect.get n r and N = length r.

As fold, but with the position of each value passed to the folding function

map f v returns a vect isomorphic to v where each element of index i equals f (get v i). Therefore, the height of the returned vect is the same as that of the original one. Operates in O(n) time.

Same as map, but the function is applied to the index of the element as first argument, and the element itself as second argument.

for_all p [a0; a1; ...; an] checks if all elements of the vect satisfy the predicate p. That is, it returns (p a0) && (p a1) && ... && (p an).

exists p [a0; a1; ...; an] checks if at least one element of the vect satisfies the predicate p. That is, it returns (p a0) || (p a1) || ... || (p an).

find p a returns the first element of vect a that satisfies the predicate p.

• raises Not_found

  if there is no value that satisfies p in the vect a.

find_opt p a returns Some x, where x is the first element of vect a that satisfies the predicate p, or None if no such element exists.

• since 2.7.0

mem m a is true if and only if m is equal to an element of a.

Same as Vect.mem but uses physical equality instead of structural equality to compare vect elements.

findi p a returns the index of the first element of vect a that satisfies the predicate p.

• raises Not_found

  if there is no value that satisfies p in the vect a.

filter f v returns a vect with the elements x from v such that f x returns true. Operates in O(n) time.

filter_map f e returns a vect consisting of all elements x such that f y returns Some x , where y is an element of e.

find_all is another name for Vect.filter.

partition p v returns a pair of vects (v1, v2), where v1 is the vect of all the elements of v that satisfy the predicate p, and v2 is the vect of all the elements of v that do not satisfy p. The order of the elements in the input vect is preserved.

These return the first and last values in the vector

Return the first element of a vector and its last n-1 elements.

Return the last element of a vector and its first n-1 elements.

Operations on BatVect with labels.