package dolmen

  1. Overview
  2. Docs

Module Dolmen_std.VecSource

Resieable arrays

This is a minimalistic implementation of resizeable arrays.

Type and array creation

Sourcetype 'a t

Abstract type of vectors of 'a

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

make cap dummy creates a new vector filled with dummy. The vector is initially empty but its underlying array has capacity cap. dummy will stay alive as long as the vector

Sourceval create : unit -> 'a t

Create a fresh vector.

Sourceval copy : 'a t -> 'a t

Fresh copy

Size manipulation

Sourceval size : 'a t -> int

Size of the vector, aka number of elements in the vector.

Sourceval is_empty : 'a t -> bool

Is the vector empty ?

Sourceval is_full : 'a t -> bool

Is the capacity of the vector equal to the number of its elements?

Sourceval clear : 'a t -> unit

Set size to 0, doesn't free elements

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

shrink vec sz resets size of vec to sz. Assumes sz >=0 && sz <= size vec

Get/Set operations

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

get the element at the given index, or

Sourceval last : 'a t -> 'a

get the last element, or

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

set the element at the given index, either already set or the first free slot if not (is_full vec), or

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

Push element into the vector

Sourceval pop : 'a t -> 'a

Pop last element and return it.