package ocaml-base-compiler

  1. Overview
  2. Docs
Official release 4.10.1

Install 

dune-project
 Dependency

ocaml.org Edit opam file Versions (70)

Authors

  1. Xavier Leroy

Maintainers

  1. David Allsopp
  2. F
    Florian Angeletti <florian.angeletti@inria.fr>

Sources

4.10.1.tar.gz
sha256=d1dd3d39dc2d06aca694e8a97983d25d5730c19ad8ceff83c3072fd05adaf28e

doc/ocamlcommon/Parmatch/index.html

Module Parmatch

Detection of partial matches and unused match cases.

val omega : Typedtree.pattern

aka. "Tpat_any" or "_"

val omegas : int -> Typedtree.pattern list

List.init (fun _ -> omega)

val omega_list : 'a list -> Typedtree.pattern list

List.map (fun _ -> omega)

val normalize_pat : Typedtree.pattern -> Typedtree.pattern

Keep only the "head" of a pattern: all arguments are replaced by omega, so are variables.

val const_compare : Asttypes.constant -> Asttypes.constant -> int

const_compare c1 c2 compares the actual values represented by c1 and c2, while simply using Stdlib.compare would compare the representations.

cf. MPR#5758

val le_pat : Typedtree.pattern -> Typedtree.pattern -> bool

le_pat p q means: forall V, V matches q implies V matches p

val le_pats : Typedtree.pattern list -> Typedtree.pattern list -> bool

le_pats (p1 .. pm) (q1 .. qn) means: forall i <= m, le_pat pi qi

module Compat (_ : sig ... end) : sig ... end

Exported compatibility functor, abstracted over constructor equality

exception Empty

lub p q is a pattern that matches all values matched by p and q. May raise Empty, when p and q are not compatible.

val lubs : Typedtree.pattern list -> Typedtree.pattern list -> Typedtree.pattern list

lubs [p1; ...; pn] [q1; ...; qk], where n < k, is [lub p1 q1; ...; lub pk qk].

val get_mins : ('a -> 'a -> bool) -> 'a list -> 'a list

Those two functions recombine one pattern and its arguments: For instance: (_,_)::p1::p2::rem -> (p1, p2)::rem The second one will replace mutable arguments by '_'

val set_args_erase_mutable : Typedtree.pattern -> Typedtree.pattern list -> Typedtree.pattern list

ppat_of_type builds an untyped or-pattern from its expected type. May raise Empty when type_expr is an empty variant

val pressure_variants : Env.t -> Typedtree.pattern list -> unit

check_partial pred loc caselist and check_unused refute pred caselist are called with a function pred which will be given counter-example candidates: they may be partially ill-typed, and have to be type-checked to extract a valid counter-example. pred returns a valid counter-example or None. refute indicates that check_unused was called on a refutation clause.

val check_unused : (bool -> (string, Types.constructor_description) Hashtbl.t -> (string, Types.label_description) Hashtbl.t -> Parsetree.pattern -> Typedtree.pattern option) -> Typedtree.case list -> unit
val irrefutable : Typedtree.pattern -> bool
val inactive : partial:Typedtree.partial -> Typedtree.pattern -> bool

An inactive pattern is a pattern, matching against which can be duplicated, erased or delayed without change in observable behavior of the program. Patterns containing (lazy _) subpatterns or reads of mutable fields are active.

val check_ambiguous_bindings : Typedtree.case list -> unit
val some_private_tag : Asttypes.label