Fast, safe mutable dynamic arrays for OCaml.
You can find API documentation here.
The idea behind this library is to provide efficient, mutable dynamic arrays with Rust-like mutability permissions.
To achieve this, the
Vec.t type uses a polymorphic variant as a phantom type parameter, which is
[`R | `W] for read-write vectors,
[`R] for read-only vectors, or
[`W] for write-only vectors.
All functions defined in the
Vec module are polymorphic in this type parameter, only requiring it to contain each function's needed capability.
For example, functions that only read data from a vector accept a
('a, [> `R]) Vec.t parameter,
[`R] vectors and
[`R | `W] vectors can be passed.
The package can be found on OPAM here.
To install it, run:
opam install vec
Building from source
To build the project and run the test suite, run the following in the root of the repository:
dune build @doc @runtest
This repository is licensed under the terms of the MIT License.
For more details, see the license file.