simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-07 03:35:30 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

add CCArray.get_safe (close #70)

Browse source
This commit is contained in:
Simon Cruanes 2016-05-20 11:32:27 +02:00
parent 0a5e131ce1
commit 4c998bf57a
2 changed files with 41 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
src/core/CCArray.ml
View file

@ -22,6 +22,10 @@ module type S = sig
val get : 'a t -> int -> 'a
val get_safe : 'a t -> int -> 'a option
(** [get_safe a i] returns [Some a.(i)] if [i] is a valid index
@since NEXT_RELEASE *)
val set : 'a t -> int -> 'a -> unit
val length : _ t -> int
@ -291,6 +295,21 @@ let length = Array.length
let get = Array.get
let get_safe a i =
if i>=0 && i<Array.length a
then Some (Array.unsafe_get a i)
else None
(*$=
(Some 1) (get_safe [|1;2;3|] 0)
(Some 2) (get_safe [|1;2;3|] 1)
(Some 3) (get_safe [|1;2;3|] 2)
None (get_safe [|1;2;3|] 4)
None (get_safe [|1;2;3|] max_int)
None (get_safe [|1;2;3|] ~-1)
None (get_safe [|1;2;3|] ~-42)
*)
let set = Array.set
let fold = Array.fold_left
@ -568,6 +587,24 @@ module Sub = struct
if i<0 || j>=a.j then invalid_arg "Array.Sub.get";
a.arr.(j)
let get_safe a i =
try Some (get a i)
with Invalid_argument _ -> None
(*$inject
let sub_a = Sub.make [|1;2;3;4;5|] 1 ~len:3
*)
(*$=
(Some 2) (Sub.get_safe sub_a 0)
(Some 3) (Sub.get_safe sub_a 1)
(Some 4) (Sub.get_safe sub_a 2)
None (Sub.get_safe sub_a 4)
None (Sub.get_safe sub_a max_int)
None (Sub.get_safe sub_a ~-1)
None (Sub.get_safe sub_a ~-42)
*)
let set a i x =
let j = a.i + i in
if i<0 || j>=a.j then invalid_arg "Array.Sub.set";

4
src/core/CCArray.mli
View file

@ -24,6 +24,10 @@ module type S = sig
val get : 'a t -> int -> 'a
val get_safe : 'a t -> int -> 'a option
(** [get_safe a i] returns [Some a.(i)] if [i] is a valid index
@since NEXT_RELEASE *)
val set : 'a t -> int -> 'a -> unit
val length : _ t -> int