package smtml

You can search for identifiers within the package.

in-package search v0.2.0

An SMT solver frontend for OCaml

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (2)

Authors

Maintainers

F

Filipe Marques <filipe.s.marques@tecnico.ulisboa.pt>

Sources

v0.8.0.tar.gz

md5=f3384afc4c52ea0fcda2b434892f8412

sha512=47a70d32fae1c833b6a4765ab1152b241e1c60078a30c27b4669bb4a7fe499228d5c5783aca4462ed553408fa16488903924bad11b050bb22a985770796f56af

doc/smtml.prelude/Smtml_prelude/Option/index.html

Module `Smtml_prelude.Option`Source

include module type of struct include Prelude.Option end

include module type of struct include Option end

Options

type 'a t = 'a option =

| None
| Some of 'a

The type for option values. Either None or a value Some v.

val none : 'a option

none is None.

val some : 'a -> 'a option

some v is Some v.

val value : 'a option -> default:'a -> 'a

value o ~default is v if o is Some v and default otherwise.

val bind : 'a option -> ('a -> 'b option) -> 'b option

bind o f is f v if o is Some v and None if o is None.

val join : 'a option option -> 'a option

join oo is Some v if oo is Some (Some v) and None otherwise.

val map : ('a -> 'b) -> 'a option -> 'b option

map f o is None if o is None and Some (f v) if o is Some v.

val fold : none:'a -> some:('b -> 'a) -> 'b option -> 'a

fold ~none ~some o is none if o is None and some v if o is Some v.

val iter : ('a -> unit) -> 'a option -> unit

iter f o is f v if o is Some v and () otherwise.

Predicates and comparisons

val is_none : 'a option -> bool

is_none o is true if and only if o is None.

val is_some : 'a option -> bool

is_some o is true if and only if o is Some o.

val equal : ('a -> 'a -> bool) -> 'a option -> 'a option -> bool

equal eq o0 o1 is true if and only if o0 and o1 are both None or if they are Some v0 and Some v1 and eq v0 v1 is true.

val compare : ('a -> 'a -> int) -> 'a option -> 'a option -> int

compare cmp o0 o1 is a total order on options using cmp to compare values wrapped by Some _. None is smaller than Some _ values.

Converting

val to_result : none:'e -> 'a option -> ('a, 'e) result

to_result ~none o is Ok v if o is Some v and Error none otherwise.

val to_list : 'a option -> 'a list

to_list o is [] if o is None and [v] if o is Some v.

val to_seq : 'a option -> 'a Seq.t

to_seq o is o as a sequence. None is the empty sequence and Some v is the singleton sequence containing v.

Source

val get : 
  Prelude.this_function_has_been_hidden_by_prelude_because_it_is_unwanted

Sourceval (let*) : 'a option -> ('a -> 'b option) -> 'b option

Sourceval (let+) : 'a option -> ('a -> 'b) -> 'b option