Module PvectorSource

include module type of struct include Vector end
Sourcetype 'a t = 'a Vector.t

The polymorphic type of vectors. This is a mutable data type.

Operations proper to vectors, or with a different type and/or semantics than those of module Array

Sourceval make : int -> dummy:'a -> 'a t

Vector.make n dummy returns a fresh vector of length n. All the elements of this new vector are initially physically equal to dummy (in the sense of the == predicate).

Raise Invalid_argument if n < 0 or n > Sys.max_array_length. If the value of dummy is a floating-point number, then the maximum size is only Sys.max_array_length / 2.

Sourceval create : dummy:'a -> 'a t

Vector.create dummy returns a fresh vector of length 0.

Sourceval init : int -> dummy:'a -> (int -> 'a) -> 'a t

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

Raise Invalid_argument if n < 0 or n > Sys.max_array_length. If the return type of f is float, then the maximum size is only Sys.max_array_length / 2.

Sourceval resize : 'a t -> int -> unit

Vector.resize a n sets the length of vector a to n.

The elements that are no longer part of the vector, if any, are internally replaced by the dummy value of vector a, so that they can be garbage collected when possible.

Raise Invalid_argument if n < 0 or n > Sys.max_array_length.

Stack interface

Contrary to standard library's Stack, module Vector uses less space (between N and 2N words, instead of 3N) and has better data locality.

Sourceval push : 'a t -> 'a -> unit

Vector.push a x appends x at the end of vector a, i.e., increases the size of a by one and stores x at the rightmost position.

Note: the order of the arguments is not that of Stack.push.

Sourceexception Empty

Raised when Vector.pop or Vector.top is applied to an empty vector.

Sourceval pop : 'a t -> 'a

Vector.pop a removes and returns the rightmost element in vector a, or raises Empty if the stack is empty.

Sourceval top : 'a t -> 'a

Vector.top a returns the rightmost element in vector a, or raises Empty if the vector is empty.

Sourceval clear : 'a t -> unit

Discard all elements from a vector. This is equivalent to setting the size to 0 with resize.

Sourceval is_empty : 'a t -> bool

Return true if the given vector is empty, false otherwise.

Array interface

Sourceval length : 'a t -> int

Return the length (number of elements) of the given vector. Note: the number of memory words occupiedby the vector can be larger.

Sourceval set : 'a t -> int -> 'a -> unit

Vector.set a n x modifies vector a in place, replacing element number n with x.

Raise Invalid_argument "Vector.set" if n is outside the range 0 to Vector.length a - 1.

Sourceval append : 'a t -> 'a t -> unit

Vector.append a1 a2 appends the elements of vector a2 to the end of vector a1. It works correctly even if a1 and a2 are the same vector.

Sourceval sub : 'a t -> int -> int -> 'a t

Vector.sub a start len returns a fresh vector of length len, containing the elements number start to start + len - 1 of vector a.

Sourceval copy : 'a t -> 'a t

Vector.copy a returns a copy of a, that is, a fresh vector containing the same elements as a.

Sourceval fill : 'a t -> int -> int -> 'a -> unit

Vector.fill a ofs len x modifies the vector a in place, storing x in elements number ofs to ofs + len - 1.

Raise Invalid_argument "Vector.fill" if ofs and len do not designate a valid subvector of a.

Sourceval blit : 'a t -> int -> 'a t -> int -> int -> unit

Vector.blit v1 o1 v2 o2 len copies len elements from vector v1, starting at element number o1, to vector v2, starting at element number o2. It works correctly even if v1 and v2 are the same vector, and the source and destination chunks overlap.

Raise Invalid_argument "Vector.blit" if o1 and len do not designate a valid subvector of v1, or if o2 and len do not designate a valid subvector of v2.

Sourceval to_list : 'a t -> 'a list

Vector.to_list a returns the list of all the elements of a.

Sourceval of_list : dummy:'a -> 'a list -> 'a t

Vector.of_list dummy l returns a fresh vector containing the elements of l.

Sourceval to_array : 'a t -> 'a array

Vector.to_array a returns the array of all the elements of a.

Sourceval of_array : dummy:'a -> 'a array -> 'a t

Vector.of_array dummy a returns a fresh vector containing the elements of a.

Sourceval map : ('a -> 'b) -> 'a t -> 'b t

Vector.map f a applies function f to all the elements of a, and builds a fresh vector with the results returned by f.

Note: the dummy value of the returned vector is obtained by applying f to the dummy value of a. If this is not what you want, first create a new vector and then fill it with the value f (get a 0), f (get a 1), etc.

Sourceval iteri : (int -> 'a -> unit) -> 'a t -> unit

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

Sourceval mapi : (int -> 'a -> 'b) -> 'a t -> 'b t

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

Note: the dummy value of the returned vector is obtained by applying f 0 to the dummy value of a.

Sourceval fold_left : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a

Vector.fold_left f x a computes f (... (f (f x (get a 0)) (get a 1)) ...) (get a (n-1)), where n is the length of the vector a.

Sourceval fold_right : ('b -> 'a -> 'a) -> 'b t -> 'a -> 'a

Vector.fold_right f a x computes f (get a 0) (f (get a 1) ( ... (f (get a (n-1)) x) ...)), where n is the length of the vector a.

Only if you know what you are doing...

Sourceval unsafe_get : 'a t -> int -> 'a
Sourceval unsafe_set : 'a t -> int -> 'a -> unit
Sourceval iter : f:('a -> unit) -> 'a t -> unit
Sourceval iteri_from : f:(int -> 'a -> 'b) -> int -> 'a t -> unit
Sourceval find_map_from : int -> 'a t -> f:('a -> 'b option) -> 'b option
Sourceval find_map : 'a t -> f:('a -> 'b option) -> 'b option
Sourceval insert : 'a Vector.t -> int -> 'a -> unit
Sourceval remove : 'a t -> int -> unit
Sourceval get_exn : 'a t -> int -> 'a
Sourceval get : [> `shadowed ]