simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 19:25:28 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve CCImmutArray.sub comments and versioning

Browse source
This commit is contained in:
Stavros Polymenis 2017-11-20 20:42:17 +00:00
parent c49458d923
commit a28dd399f4
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/data/CCImmutArray.mli
View file

@ -37,9 +37,13 @@ val set : 'a t -> int -> 'a -> 'a t
(** Copy the array and modify its copy *)
val sub : 'a t -> int -> int -> 'a t
(** [sub a start len] returns a fresh array of length len, containing the elements number start to start + len - 1 of array a.
Raises [Invalid_argument "Array.sub"] if start and len do not designate a valid subarray of a; that is, if start < 0, or len < 0, or start + len > Array.length a. *)
(** [sub a start len] returns a fresh array of length len, containing the elements
from [start] to pstart + len - 1] of array a.
Raises [Invalid_argument "Array.sub"] if [start] and [len] do not designate a
valid subarray of a; that is, if start < 0, or len < 0, or start + len > Array.length a.
@since NEXT_RELEASE *)
val map : ('a -> 'b) -> 'a t -> 'b t