package travesty

  1. Overview
  2. Docs
package travesty
Legend:
Library
Module
Module type
Parameter
Class
Class type

Extend0 creates extensions for a Container.S0.

Parameters

Signature

include Generic_types.S0 with type t := C.t with type elt := C.elt
include Container_exts_types.Generic with type 'a t := C.t and type 'a elt := C.elt

Generic_extensions refers to the container type as 'a t, and the element type as 'a elt; substitute t/elt (arity-0) or 'a t/'a (arity-1) accordingly below.

include Generic_types.Generic with type 'a t := C.t with type 'a elt := C.elt

Testing for a specific number of elements

The following functions help in checking whether a container has a particular, commonly-required number of elements (zero or one, one, two, and so on).

val at_most_one : C.t -> C.elt Base.option Base.Or_error.t

at_most_one xs returns Ok None if xs is empty; Ok Some(x) if it contains only x; and an error otherwise.

Examples (using an extended version of List):

List.at_most_one []     (* ok None *)
     at_most_one [1]    (* ok (Some 1) *)
     at_most_one [1; 2] (* error -- too many *)

one xs returns Ok x if xs contains only x, and an error otherwise.

Examples (using an extended version of List):

List.one []     (* error -- not enough *)
     one [1]    (* ok 1 *)
     one [1; 2] (* error -- too many *)
val two : C.t -> (C.elt * C.elt) Base.Or_error.t

two xs returns Ok (x, y) if xs is a list containing only x and y in that order, and an error otherwise.

Examples (using an extended version of List):

List.two []        (* error -- not enough *)
     two [1]       (* error -- not enough *)
     two [1; 2]    (* ok (1, 2) *)
     two [1; 2; 3] (* error -- too many *)

Miscellaneous extensions

val max_measure : measure:(C.elt -> Base.int) -> ?default:Base.int -> C.t -> Base.int

max_measure ~measure ~default xs measures each item in xs according to measure, and returns the highest measure reported. If xs is empty, return default if given, and 0 otherwise.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct