Module Array.Permissioned

The Permissioned module gives the ability to restrict permissions on an array, so you can give a function read-only access to an array, create an immutable array, etc.

type ('a, -'perms) t

The meaning of the 'perms parameter is as usual (see the Perms module for more details) with the non-obvious difference that you don't need any permissions to extract the length of an array. This was done for simplicity because some information about the length of an array can leak out even if you only have write permissions since you can catch out-of-bounds errors.

include Bin_prot.Binable.S2 with type ('a, -'perms) t := ('a, 'perms) t
type ('a, 'b) t
val bin_shape_t : Bin_prot.Shape.t -> Bin_prot.Shape.t -> Bin_prot.Shape.t
val bin_size_t : ('a, 'b, ('a, 'b) t) Bin_prot.Size.sizer2
val bin_write_t : ('a, 'b, ('a, 'b) t) Bin_prot.Write.writer2
val bin_read_t : ('a, 'b, ('a, 'b) t) Bin_prot.Read.reader2
val __bin_read_t__ : ('a, 'b, int -> ('a, 'b) t) Bin_prot.Read.reader2
val bin_writer_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.writer
val bin_reader_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.reader
val bin_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.t
val compare : ('a -> 'a -> Core_kernel__.Import.int) -> ('perms -> 'perms -> Core_kernel__.Import.int) -> ('a, 'perms) t -> ('a, 'perms) t -> Core_kernel__.Import.int
include Ppx_sexp_conv_lib.Sexpable.S2 with type ('a, -'perms) t := ('a, 'perms) t
type ('a, 'b) t
val t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> (Sexplib0.Sexp.t -> 'b) -> Sexplib0.Sexp.t -> ('a, 'b) t
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> ('b -> Sexplib0.Sexp.t) -> ('a, 'b) t -> Sexplib0.Sexp.t
module Int : sig ... end
module Float : sig ... end
val of_array_id : 'a Core_kernel__.Import.array -> ('a, [< Perms.Export.read_write ]) t

of_array_id and to_array_id return the same underlying array. On the other hand, to_array (inherited from Container.S1_permissions below) makes a copy.

To create a new (possibly immutable) copy of an array a, use copy (of_array_id a). More generally, any function that takes a (possibly mutable) t can be called on an array by calling of_array_id on it first.

There is a conceptual type equality between 'a Array.t and ('a, read_write) Array.Permissioned.t. The reason for not exposing this as an actual type equality is that we also want:

  • The type equality 'a Array.t = 'a array for interoperability with code which does not use Core.
  • The type ('a, 'perms) Array.Permissioned.t to be abstract, so that the permission phantom type will have an effect.

Since we don't control the definition of 'a array, this would require a type ('a, 'perms) Array.Permissioned.t which is abstract, except that ('a, read_write) Array.Permissioned.t is concrete, which is not possible.

val to_array_id : ('a, [> Perms.Export.read_write ]) t -> 'a Core_kernel__.Import.array
val to_sequence_immutable : ('a, [> Perms.Export.immutable ]) t -> 'a Sequence.t

to_sequence_immutable t converts t to a sequence. Unlike to_sequence, to_sequence_immutable does not need to copy t since it is immutable.

include Container.S1_permissions with type ('a, 'perms) t := ('a, 'perms) t
type ('a, -'permissions) t
val mem : ('a, [> Perms.Export.read ]) t -> 'a -> equal:('a -> 'a -> Core_kernel__.Import.bool) -> Core_kernel__.Import.bool

Checks whether the provided element is there, using polymorphic compare if equal is not provided.

val length : (_, [> Perms.Export.read ]) t -> Core_kernel__.Import.int
val is_empty : (_, [> Perms.Export.read ]) t -> Core_kernel__.Import.bool
val iter : ('a, [> Perms.Export.read ]) t -> f:('a -> Core_kernel__.Import.unit) -> Core_kernel__.Import.unit
val fold : ('a, [> Perms.Export.read ]) t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t

val fold_result : ('a, [> Perms.Export.read ]) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Result.t) -> ('accum, 'e) Result.t

fold_result t ~init ~f is a short-circuiting version of fold that runs in the Result monad. If f returns an Error _, that value is returned without any additional invocations of f.

val fold_until : ('a, [> Perms.Export.read ]) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Container_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final

fold_until t ~init ~f ~finish is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed. If f never returns Stop _, the final result is computed by finish.

val exists : ('a, [> Perms.Export.read ]) t -> f:('a -> Core_kernel__.Import.bool) -> Core_kernel__.Import.bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : ('a, [> Perms.Export.read ]) t -> f:('a -> Core_kernel__.Import.bool) -> Core_kernel__.Import.bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : ('a, [> Perms.Export.read ]) t -> f:('a -> Core_kernel__.Import.bool) -> Core_kernel__.Import.int

Returns the number of elements for which the provided function evaluates to true.

val sum : (module Base.Container.Summable with type t = 'sum) -> ('a, [> Perms.Export.read ]) t -> f:('a -> 'sum) -> 'sum

Returns the sum of f i for i in the container

val find : ('a, [> Perms.Export.read ]) t -> f:('a -> Core_kernel__.Import.bool) -> 'a Core_kernel__.Import.option

Returns as an option the first element for which f evaluates to true.

val find_map : ('a, [> Perms.Export.read ]) t -> f:('a -> 'b Core_kernel__.Import.option) -> 'b Core_kernel__.Import.option

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val to_list : ('a, [> Perms.Export.read ]) t -> 'a Core_kernel__.Import.list
val to_array : ('a, [> Perms.Export.read ]) t -> 'a Core_kernel__.Import.array
val min_elt : ('a, [> Perms.Export.read ]) t -> compare:('a -> 'a -> Core_kernel__.Import.int) -> 'a Core_kernel__.Import.option

Returns a min (resp max) element from the collection using the provided compare function. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold. Returns None iff the collection is empty.

val max_elt : ('a, [> Perms.Export.read ]) t -> compare:('a -> 'a -> Core_kernel__.Import.int) -> 'a Core_kernel__.Import.option
include Blit.S1_permissions with type ('a, 'perms) t := ('a, 'perms) t
type ('a, -'perms) t
val blit : (('a, [> Perms.Export.read ]) t, ('a, [> Perms.Export.write ]) t) Base.Blit.blit
val blito : (('a, [> Perms.Export.read ]) t, ('a, [> Perms.Export.write ]) t) Base.Blit.blito
val unsafe_blit : (('a, [> Perms.Export.read ]) t, ('a, [> Perms.Export.write ]) t) Base.Blit.blit
val sub : (('a, [> Perms.Export.read ]) t, ('a, [< _ Perms.Export.perms ]) t) Base.Blit.sub
val subo : (('a, [> Perms.Export.read ]) t, ('a, [< _ Perms.Export.perms ]) t) Base.Blit.subo
include Binary_searchable.S1_permissions with type ('a, 'perms) t := ('a, 'perms) t
type ('a, -'perms) t
val binary_search_segmented : (('a, [> Perms.Export.read ]) t, 'a) Base.Binary_searchable.binary_search_segmented
val length : (_, _) t -> Core_kernel__.Import.int
val is_empty : (_, _) t -> Core_kernel__.Import.bool
val get : ('a, [> Perms.Export.read ]) t -> Core_kernel__.Import.int -> 'a
val set : ('a, [> Perms.Export.write ]) t -> Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.unit
val unsafe_get : ('a, [> Perms.Export.read ]) t -> Core_kernel__.Import.int -> 'a
val unsafe_set : ('a, [> Perms.Export.write ]) t -> Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.unit
val create : len:Core_kernel__.Import.int -> 'a -> ('a, [< _ Perms.Export.perms ]) t
val init : Core_kernel__.Import.int -> f:(Core_kernel__.Import.int -> 'a) -> ('a, [< _ Perms.Export.perms ]) t
val make_matrix : dimx:Core_kernel__.Import.int -> dimy:Core_kernel__.Import.int -> 'a -> (('a, [< _ Perms.Export.perms ]) t, [< _ Perms.Export.perms ]) t
val append : ('a, [> Perms.Export.read ]) t -> ('a, [> Perms.Export.read ]) t -> ('a, [< _ Perms.Export.perms ]) t
val concat : ('a, [> Perms.Export.read ]) t Core_kernel__.Import.list -> ('a, [< _ Perms.Export.perms ]) t
val copy : ('a, [> Perms.Export.read ]) t -> ('a, [< _ Perms.Export.perms ]) t
val fill : ('a, [> Perms.Export.write ]) t -> pos:Core_kernel__.Import.int -> len:Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.unit
val of_list : 'a Core_kernel__.Import.list -> ('a, [< _ Perms.Export.perms ]) t
val map : ('a, [> Perms.Export.read ]) t -> f:('a -> 'b) -> ('b, [< _ Perms.Export.perms ]) t
val mapi : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> 'b) -> ('b, [< _ Perms.Export.perms ]) t
val folding_map : ('a, [> Perms.Export.read ]) t -> init:'b -> f:('b -> 'a -> 'b * 'c) -> ('c, [< _ Perms.Export.perms ]) t
val iteri : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.unit) -> Core_kernel__.Import.unit
val foldi : ('a, [> Perms.Export.read ]) t -> init:'b -> f:(Core_kernel__.Import.int -> 'b -> 'a -> 'b) -> 'b
val folding_mapi : ('a, [> Perms.Export.read ]) t -> init:'b -> f:(Core_kernel__.Import.int -> 'b -> 'a -> 'b * 'c) -> ('c, [< _ Perms.Export.perms ]) t
val fold_right : ('a, [> Perms.Export.read ]) t -> f:('a -> 'b -> 'b) -> init:'b -> 'b
val sort : ?⁠pos:Core_kernel__.Import.int -> ?⁠len:Core_kernel__.Import.int -> ('a, [> Perms.Export.read_write ]) t -> compare:('a -> 'a -> Core_kernel__.Import.int) -> Core_kernel__.Import.unit
val stable_sort : ('a, [> Perms.Export.read_write ]) t -> compare:('a -> 'a -> Core_kernel__.Import.int) -> Core_kernel__.Import.unit
val is_sorted : ('a, [> Perms.Export.read ]) t -> compare:('a -> 'a -> Core_kernel__.Import.int) -> Core_kernel__.Import.bool
val is_sorted_strictly : ('a, [> Perms.Export.read ]) t -> compare:('a -> 'a -> Core_kernel__.Import.int) -> Core_kernel__.Import.bool
val concat_map : ('a, [> Perms.Export.read ]) t -> f:('a -> ('b, [> Perms.Export.read ]) t) -> ('b, [< _ Perms.Export.perms ]) t
val concat_mapi : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> ('b, [> Perms.Export.read ]) t) -> ('b, [< _ Perms.Export.perms ]) t
val partition_tf : ('a, [> Perms.Export.read ]) t -> f:('a -> Core_kernel__.Import.bool) -> ('a, [< _ Perms.Export.perms ]) t * ('a, [< _ Perms.Export.perms ]) t
val partitioni_tf : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.bool) -> ('a, [< _ Perms.Export.perms ]) t * ('a, [< _ Perms.Export.perms ]) t
val cartesian_product : ('a, [> Perms.Export.read ]) t -> ('b, [> Perms.Export.read ]) t -> ('a * 'b, [< _ Perms.Export.perms ]) t
val transpose : (('a, [> Perms.Export.read ]) t, [> Perms.Export.read ]) t -> (('a, [< _ Perms.Export.perms ]) t, [< _ Perms.Export.perms ]) t Core_kernel__.Import.option
val transpose_exn : (('a, [> Perms.Export.read ]) t, [> Perms.Export.read ]) t -> (('a, [< _ Perms.Export.perms ]) t, [< _ Perms.Export.perms ]) t
val normalize : (_, _) t -> Core_kernel__.Import.int -> Core_kernel__.Import.int
val slice : ('a, [> Perms.Export.read ]) t -> Core_kernel__.Import.int -> Core_kernel__.Import.int -> ('a, [< _ Perms.Export.perms ]) t
val nget : ('a, [> Perms.Export.read ]) t -> Core_kernel__.Import.int -> 'a
val nset : ('a, [> Perms.Export.write ]) t -> Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.unit
val filter_opt : ('a Core_kernel__.Import.option, [> Perms.Export.read ]) t -> ('a, [< _ Perms.Export.perms ]) t
val filter_map : ('a, [> Perms.Export.read ]) t -> f:('a -> 'b Core_kernel__.Import.option) -> ('b, [< _ Perms.Export.perms ]) t
val filter_mapi : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> 'b Core_kernel__.Import.option) -> ('b, [< _ Perms.Export.perms ]) t
val for_alli : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.bool) -> Core_kernel__.Import.bool
val existsi : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.bool) -> Core_kernel__.Import.bool
val counti : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.bool) -> Core_kernel__.Import.int
val iter2_exn : ('a, [> Perms.Export.read ]) t -> ('b, [> Perms.Export.read ]) t -> f:('a -> 'b -> Core_kernel__.Import.unit) -> Core_kernel__.Import.unit
val map2_exn : ('a, [> Perms.Export.read ]) t -> ('b, [> Perms.Export.read ]) t -> f:('a -> 'b -> 'c) -> ('c, [< _ Perms.Export.perms ]) t
val fold2_exn : ('a, [> Perms.Export.read ]) t -> ('b, [> Perms.Export.read ]) t -> init:'c -> f:('c -> 'a -> 'b -> 'c) -> 'c
val for_all2_exn : ('a, [> Perms.Export.read ]) t -> ('b, [> Perms.Export.read ]) t -> f:('a -> 'b -> Core_kernel__.Import.bool) -> Core_kernel__.Import.bool
val exists2_exn : ('a, [> Perms.Export.read ]) t -> ('b, [> Perms.Export.read ]) t -> f:('a -> 'b -> Core_kernel__.Import.bool) -> Core_kernel__.Import.bool
val filter : ('a, [> Perms.Export.read ]) t -> f:('a -> Core_kernel__.Import.bool) -> ('a, [< _ Perms.Export.perms ]) t
val filteri : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.bool) -> ('a, [< _ Perms.Export.perms ]) t
val swap : ('a, [> Perms.Export.read_write ]) t -> Core_kernel__.Import.int -> Core_kernel__.Import.int -> Core_kernel__.Import.unit
val rev_inplace : ('a, [> Perms.Export.read_write ]) t -> Core_kernel__.Import.unit
val of_list_rev : 'a Core_kernel__.Import.list -> ('a, [< _ Perms.Export.perms ]) t
val of_list_map : 'a Core_kernel__.Import.list -> f:('a -> 'b) -> ('b, [< _ Perms.Export.perms ]) t
val of_list_mapi : 'a Core_kernel__.Import.list -> f:(Core_kernel__.Import.int -> 'a -> 'b) -> ('b, [< _ Perms.Export.perms ]) t
val of_list_rev_map : 'a Core_kernel__.Import.list -> f:('a -> 'b) -> ('b, [< _ Perms.Export.perms ]) t
val of_list_rev_mapi : 'a Core_kernel__.Import.list -> f:(Core_kernel__.Import.int -> 'a -> 'b) -> ('b, [< _ Perms.Export.perms ]) t
val map_inplace : ('a, [> Perms.Export.read_write ]) t -> f:('a -> 'a) -> Core_kernel__.Import.unit
val find_exn : ('a, [> Perms.Export.read ]) t -> f:('a -> Core_kernel__.Import.bool) -> 'a
val find_map_exn : ('a, [> Perms.Export.read ]) t -> f:('a -> 'b Core_kernel__.Import.option) -> 'b
val findi : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.bool) -> (Core_kernel__.Import.int * 'a) Core_kernel__.Import.option
val findi_exn : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> Core_kernel__.Import.bool) -> Core_kernel__.Import.int * 'a
val find_mapi : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> 'b Core_kernel__.Import.option) -> 'b Core_kernel__.Import.option
val find_mapi_exn : ('a, [> Perms.Export.read ]) t -> f:(Core_kernel__.Import.int -> 'a -> 'b Core_kernel__.Import.option) -> 'b
val find_consecutive_duplicate : ('a, [> Perms.Export.read ]) t -> equal:('a -> 'a -> Core_kernel__.Import.bool) -> ('a * 'a) Core_kernel__.Import.option
val reduce : ('a, [> Perms.Export.read ]) t -> f:('a -> 'a -> 'a) -> 'a Core_kernel__.Import.option
val reduce_exn : ('a, [> Perms.Export.read ]) t -> f:('a -> 'a -> 'a) -> 'a
val permute : ?⁠random_state:Core_kernel__.Import.Random.State.t -> ('a, [> Perms.Export.read_write ]) t -> Core_kernel__.Import.unit
val zip : ('a, [> Perms.Export.read ]) t -> ('b, [> Perms.Export.read ]) t -> ('a * 'b, [< _ Perms.Export.perms ]) t Core_kernel__.Import.option
val zip_exn : ('a, [> Perms.Export.read ]) t -> ('b, [> Perms.Export.read ]) t -> ('a * 'b, [< _ Perms.Export.perms ]) t
val unzip : ('a * 'b, [> Perms.Export.read ]) t -> ('a, [< _ Perms.Export.perms ]) t * ('b, [< _ Perms.Export.perms ]) t
val sorted_copy : ('a, [> Perms.Export.read ]) t -> compare:('a -> 'a -> Core_kernel__.Import.int) -> ('a, [< _ Perms.Export.perms ]) t
val last : ('a, [> Perms.Export.read ]) t -> 'a
val equal : ('a -> 'a -> Core_kernel__.Import.bool) -> ('a, [> Perms.Export.read ]) t -> ('a, [> Perms.Export.read ]) t -> Core_kernel__.Import.bool
val unsafe_truncate : (_, [> Perms.Export.write ]) t -> len:Core_kernel__.Import.int -> Core_kernel__.Import.unit
val to_sequence : ('a, [> Perms.Export.read ]) t -> 'a Sequence.t
val to_sequence_mutable : ('a, [> Perms.Export.read ]) t -> 'a Sequence.t