vec 0.4.0 · OCaml Package

Mutable dynamic arrays

type ('a, -'p) t

A value of type ('a, 'p) Vec.t is a vector of values of type 'a, with mutability permissions 'p.

The permissions can be [`R | `W] for read-write vectors, [`R] for read-only vectors, or [`W] for write-only vectors.

Reading vector properties

val length : ('a, [> ]) t -> int

Returns the length of the vector.

val capacity : ('a, [> ]) t -> int

Returns the capacity of the vector.

Creating vectors

val make : ?capacity:int -> unit -> ('a, [ `R | `W ]) t

Constructs a vector with the specified capacity (defaults to 0).

val range : int -> int -> (int, [ `R | `W ]) t

Constructs a vector containing all numbers in the specified range. Both ascending and descending ranges are supported.

val singleton : 'a -> ('a, [ `R | `W ]) t

Returns a singleton vector containing the specified item. (Applicative functor pure operation)

val copy : ('a, [> `R ]) t -> ('a, [ `R | `W ]) t

Creates a copy of the vector.

Restricting permissions

val as_read_only : ('a, [> `R ]) t -> ('a, [ `R ]) t

Reinterprets the vector as a read-only vector.

val as_write_only : ('a, [> `W ]) t -> ('a, [ `W ]) t

Reinterprets the vector as a write-only vector.

Accessing elements

val get : ('a, [> `R ]) t -> int -> 'a

Gets the value in the vector at the specified index.

raises [Invalid_argument]
if the index is out of bounds.

val try_get : ('a, [> `R ]) t -> int -> 'a option

Gets the value in the vector at the specified index. Returns None if the index is out of range.

val set : ('a, [> `W ]) t -> int -> 'a -> unit

Sets the value in the vector at the specified index to the specified value.

raises [Invalid_argument]
if the index is out of bounds.

val try_set : ('a, [> `W ]) t -> int -> 'a -> bool

Sets the value in the vector at the specified index to the specified value. Returns false if the index is out of range.

val find : ('a -> bool) -> ('a, [> `W ]) t -> 'a

Returns the first element of the vector that satisfies the predicate.

raises [Not_found]
if no element satisfies the predicate.

val try_find : ('a -> bool) -> ('a, [> `W ]) t -> 'a option

Returns the first element of the vector that satisfies the predicate, or None.

Conversions

val of_list : 'a list -> ('a, [ `R | `W ]) t

Constructs a vector from the specified list.

val to_list : ('a, [> `R ]) t -> 'a list

Constructs a list from the specified vector.

val of_array : 'a array -> ('a, [ `R | `W ]) t

Constructs a vector from a copy of the specified array.

val to_array : ('a, [> `R ]) t -> 'a array

Constructs an array containing the values of specified vector.

val of_array_unsafe : 'a array -> ('a, [ `R | `W ]) t

Constructs a vector from the specified array, without copying.

val to_array_unsafe : ('a, [ `R | `W ]) t -> 'a array

Returns the vector's underlying buffer. Note: The array may contain uninitialized elements.

val pretty_print : ('a -> string) -> ('a, [> `R ]) t -> string

Returns a string representation of the vector, using the specified function to format each value.

Modifying vectors

val clear : ('a, [> `W ]) t -> unit

Resets the vector to an empty state.

val reserve : int -> ('a, [> `W ]) t -> unit

Ensures the vector's capacity is at least as large as the specified value, allocating if necessary.

val shrink_to_fit : ('a, [> `W ]) t -> unit

Shrinks the vector's internal buffer to only be as large as the vector's length.

val push : 'a -> ('a, [> `W ]) t -> unit

Pushes the specified item onto the end of the vector.

val pop : ('a, [ `R | `W ]) t -> 'a

Pops off the item from the end of the vector.

raises [Invalid_argument]
if the vector is empty.

val try_pop : ('a, [ `R | `W ]) t -> 'a option

Pops off the item from the end of the vector. Returns None if the vector is empty.

val insert_at : int -> 'a -> ('a, [> `W ]) t -> unit

Inserts an item into the vector at the specified index.

raises [Invalid_argument]
if the index is out of bounds.

val try_insert_at : int -> 'a -> ('a, [> `W ]) t -> bool

Inserts an item into the vector at the specified index. Returns false if the index is out of range.

val remove_at : int -> ('a, [ `R | `W ]) t -> 'a

Removes and returns the item at the specified index.

raises [Invalid_argument]
if the index is out of bounds.

val try_remove_at : int -> ('a, [ `R | `W ]) t -> 'a option

Removes and returns the item at the specified index. Returns None if the index is out of range.

Transformations

val map : ('a -> 'b) -> ('a, [> `R ]) t -> ('b, [ `R | `W ]) t

Maps the specified function over the vector, returning a new vector. (Functor map operation)

val mapi : (int -> 'a -> 'b) -> ('a, [> `R ]) t -> ('b, [ `R | `W ]) t

Like map, but the function also takes the item's index as a parameter.

val map_in_place : ('a -> 'a) -> ('a, [ `R | `W ]) t -> unit

Like map, but the transformation is done in-place.

val flat_map : 
  ('a -> ('b, [> `R ]) t) ->
  ('a, [> `R ]) t ->
  ('b, [ `R | `W ]) t

Like map, but flattens the result. (Monad bind operation)

val rev : ('a, [> `R ]) t -> ('a, [ `R | `W ]) t

Returns a new vector that contains all the items in the specified vector, but in reverse order.

val rev_in_place : ('a, [ `R | `W ]) t -> unit

Reverses the vector in-place.

Filters & folds

val filter : ('a -> bool) -> ('a, [> `R ]) t -> ('a, [ `R | `W ]) t

Returns a new vector containing only the items from the first vector that satisfy the specified predicate.

val filteri : (int -> 'a -> bool) -> ('a, [> `R ]) t -> ('a, [ `R | `W ]) t

Like filter, but the predicate also takes the item's index as a parameter.

val filter_in_place : ('a -> bool) -> ('a, [ `R | `W ]) t -> unit

Performs a filter in-place, based on the specified predicate.

val fold_left : ('b -> 'a -> 'b) -> 'b -> ('a, [> `R ]) t -> 'b

Folds the specified function and default value over the array, from left to right.

val fold_right : ('a -> 'b -> 'b) -> ('a, [> `R ]) t -> 'b -> 'b

Folds the specified function and default value over the array, from right to left.

Combining vectors

val append : ('a, [> `R ]) t -> ('a, [> `R ]) t -> ('a, [ `R | `W ]) t

Concatenates the two vectors into a new vector.

val append_in_place : ('a, [ `R | `W ]) t -> ('a, [> `R ]) t -> unit

Appends the second vector to the first vector in-place.

val cartesian_product : 
  ('a, [> `R ]) t ->
  ('b, [> `R ]) t ->
  ('a * 'b, [ `R | `W ]) t

Cartesian product of 2 vectors. (Equivalent to liftA2 (,))

val map2 : 
  ('a -> 'b -> 'c) ->
  ('a, [> `R ]) t ->
  ('b, [> `R ]) t ->
  ('c, [ `R | `W ]) t

Maps the specified function over all combinations of tuples from the 2 vectors, returning a new vector. (Applicative functor liftA2 operation

val apply : ('a -> 'b, [> `R ]) t -> ('a, [> `R ]) t -> ('b, [ `R | `W ]) t

Applies every function from the first vector to every value from the second vector, returning a new vector. (Applicatve functor ap operation)

val flatten : (('a, [> `R ]) t, [> `R ]) t -> ('a, [ `R | `W ]) t

Flattens nested vectors into a single, one-dimensional vector. (Monad join operation)

val zip : ('a, [> `R ]) t -> ('b, [> `R ]) t -> ('a * 'b, [ `R | `W ]) t

Zips the two vectors together.

val zip_with : 
  ('a -> 'b -> 'c) ->
  ('a, [> `R ]) t ->
  ('b, [> `R ]) t ->
  ('c, [ `R | `W ]) t

Zips the two vectors together, using the specified function to combine values.

Querying vectors

val exists : ('a -> bool) -> ('a, [> `R ]) t -> bool

Returns true if any item in the vector satisfies the specified predicate.

val for_all : ('a -> bool) -> ('a, [> `R ]) t -> bool

Returns true if all items in the vector satisfy the specified predicate.

val mem : 'a -> ('a, [> `R ]) t -> bool

Returns true if the specified item exists in the vector. Uses structural equality.

val memq : 'a -> ('a, [> `R ]) t -> bool

Returns true if the specified item exists in the vector. Uses physical equality.

Sorting

val sort : ('a, [ `R | `W ]) t -> unit

Sorts the vector in-place.

val sort_by : ('a -> 'a -> int) -> ('a, [ `R | `W ]) t -> unit

Sorts the vector in-place, using the specified comparison function.

Equality and comparison

val equal : ('a, [> `R ]) t -> ('a, [> `R ]) t -> bool

Compares two vectors for equality.

val equal_by : ('a -> 'a -> bool) -> ('a, [> `R ]) t -> ('a, [> `R ]) t -> bool

Compares two vectors for equality, using the specified equality function for elements.

val compare : ('a, [> `R ]) t -> ('a, [> `R ]) t -> int

Compares two vectors lexicographically.

val compare_by : ('a -> 'a -> int) -> ('a, [> `R ]) t -> ('a, [> `R ]) t -> int

Compares two vectors lexicographically, using the specified comparison function for elements.

Iteration

val iter : ('a -> unit) -> ('a, [> `R ]) t -> unit

Applies the specified function to each item in the vector.

val iteri : (int -> 'a -> unit) -> ('a, [> `R ]) t -> unit

Like iter, but the function also takes the item's index as a parameter.

Infix operators

module Infix : sig ... end

Contains infix versions of some vector operations, as well as binding operators and extended indexing operators.

package vec