Module type Substring.S
include Core_kernel.Container.S0 with type t := t with type elt := Core_kernel__.Import.char
val length : t -> int
val is_empty : t -> bool
val iter : t -> f:(elt -> unit) -> unit
iter
must allow exceptions raised inf
to escape, terminating the iteration cleanly. The same holds for all functions below taking anf
.
val fold : t -> init:'accum -> f:('accum -> elt -> 'accum) -> 'accum
fold t ~init ~f
returnsf (... f (f (f init e1) e2) e3 ...) en
, wheree1..en
are the elements oft
.
val fold_result : t -> init:'accum -> f:('accum -> elt -> ('accum, 'e) Base.Result.t) -> ('accum, 'e) Base.Result.t
fold_result t ~init ~f
is a short-circuiting version offold
that runs in theResult
monad. Iff
returns anError _
, that value is returned without any additional invocations off
.
val fold_until : t -> init:'accum -> f:('accum -> elt -> ('accum, 'final) Base__.Container_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
fold_until t ~init ~f ~finish
is a short-circuiting version offold
. Iff
returnsStop _
the computation ceases and results in that value. Iff
returnsContinue _
, the fold will proceed. Iff
never returnsStop _
, the final result is computed byfinish
.Example:
type maybe_negative = | Found_negative of int | All_nonnegative of { sum : int } (** [first_neg_or_sum list] returns the first negative number in [list], if any, otherwise returns the sum of the list. *) let first_neg_or_sum = List.fold_until ~init:0 ~f:(fun sum x -> if x < 0 then Stop (Found_negative x) else Continue (sum + x)) ~finish:(fun sum -> All_nonnegative { sum }) ;; let x = first_neg_or_sum [1; 2; 3; 4; 5] val x : maybe_negative = All_nonnegative {sum = 15} let y = first_neg_or_sum [1; 2; -3; 4; 5] val y : maybe_negative = Found_negative -3
val exists : t -> f:(elt -> bool) -> bool
Returns
true
if and only if there exists an element for which the provided function evaluates totrue
. This is a short-circuiting operation.
val for_all : t -> f:(elt -> bool) -> bool
Returns
true
if and only if the provided function evaluates totrue
for all elements. This is a short-circuiting operation.
val count : t -> f:(elt -> bool) -> int
Returns the number of elements for which the provided function evaluates to true.
val sum : (module Base__.Container_intf.Summable with type t = 'sum) -> t -> f:(elt -> 'sum) -> 'sum
Returns the sum of
f i
for alli
in the container.
val find : t -> f:(elt -> bool) -> elt option
Returns as an
option
the first element for whichf
evaluates to true.
val find_map : t -> f:(elt -> 'a option) -> 'a option
Returns the first evaluation of
f
that returnsSome
, and returnsNone
if there is no such element.
val to_list : t -> elt list
val to_array : t -> elt array
val min_elt : t -> compare:(elt -> elt -> int) -> elt 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 usesfold
so it has the same complexity asfold
. ReturnsNone
iff the collection is empty.
val base : t -> base
val pos : t -> Core_kernel__.Import.int
pos
refers to the position in the base string, not any other substring that this substring was generated from.
val get : t -> Core_kernel__.Import.int -> Core_kernel__.Import.char
Per
String.get
andBigstring.get
, this raises an exception if the index is out of bounds.
val create : ?pos:Core_kernel__.Import.int -> ?len:Core_kernel__.Import.int -> base -> t
create ?pos ?len base
creates a substring of the base sequence of lengthlen
starting at positionpos
, i.e.,base.[pos], base.[pos + 1], ... base.[pos + len - 1]
An exception is raised if any of those indices into
base
is invalid.It does not copy the characters, so mutating
base
mutatest
and vice versa.
val sub : ?pos:Core_kernel__.Import.int -> ?len:Core_kernel__.Import.int -> t -> t
Blit functions
For copying characters from a substring to and from both strings and substrings.
val blit_to_string : t -> dst:Core_kernel__.Import.bytes -> dst_pos:Core_kernel__.Import.int -> Core_kernel__.Import.unit
val blit_to_bytes : t -> dst:Core_kernel__.Import.bytes -> dst_pos:Core_kernel__.Import.int -> Core_kernel__.Import.unit
val blit_to_bigstring : t -> dst:Core_kernel.Bigstring.t -> dst_pos:Core_kernel__.Import.int -> Core_kernel__.Import.unit
val blit_from_string : t -> src:Core_kernel__.Import.string -> src_pos:Core_kernel__.Import.int -> len:Core_kernel__.Import.int -> Core_kernel__.Import.unit
val blit_from_bigstring : t -> src:Core_kernel.Bigstring.t -> src_pos:Core_kernel__.Import.int -> len:Core_kernel__.Import.int -> Core_kernel__.Import.unit
String concatenation
val concat : t Core_kernel__.Import.list -> t
val concat_string : t Core_kernel__.Import.list -> Core_kernel__.Import.string
val concat_bigstring : t Core_kernel__.Import.list -> Core_kernel.Bigstring.t
Conversion to/from substrings
val to_string : t -> Core_kernel__.Import.string
val to_bigstring : t -> Core_kernel.Bigstring.t
val of_string : Core_kernel__.Import.string -> t
val of_bigstring : Core_kernel.Bigstring.t -> t
Prefixes and suffixes
The result of these functions share data with their input, but don't mutate the underlying string.
val drop_prefix : t -> Core_kernel__.Import.int -> t
val drop_suffix : t -> Core_kernel__.Import.int -> t
val prefix : t -> Core_kernel__.Import.int -> t
val suffix : t -> Core_kernel__.Import.int -> t