Up

# Module typeS1_phantom

### Signature

type ('a, +'phantom) t
include S1_phantom_invariant with type ('a, 'phantom) t := ('a, 'phantom) t
type ('a, 'phantom) t
val mem : ?equal:('a -> 'a -> bool) -> ('a, _) t -> 'a -> bool

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

val length : (_, _) t -> int
val is_empty : (_, _) t -> bool
val iter : ('a, _) t -> f:('a -> unit) -> unit
val fold : ('a, _) 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 exists : ('a, _) t -> f:('a -> bool) -> 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, _) t -> f:('a -> bool) -> 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, _) t -> f:('a -> bool) -> int

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

val sum : (module Commutative_group.S with type t = 'sum) -> ('a, _) t -> f:('a -> 'sum) -> 'sum

Returns the sum of `f i` for i in the container

val find : ('a, _) t -> f:('a -> bool) -> 'a option

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

val find_map : ('a, _) t -> f:('a -> 'b option) -> 'b option

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

val to_list : ('a, _) t -> 'a list
val to_array : ('a, _) t -> 'a array
val min_elt : ('a, _) t -> cmp:('a -> 'a -> int) -> 'a option

Returns a min (resp max) element from the collection using the provided `cmp` 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, _) t -> cmp:('a -> 'a -> int) -> 'a option