package core

  1. Overview
  2. Docs
package core
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Percent.OptionSource

The value nan cannot be represented as an Option.t

type value := t
Sourcetype t = private Base.Float.t
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

Sourceval bin_shape_t : Bin_prot.Shape.t
Sourceval t_sexp_grammar : t Sexplib0.Sexp_grammar.t
include Immediate_option.S_without_immediate with type value := value and type t := t
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Typerep_lib.Typerepable.S with type t := t
Sourceval typename_of_t : t Typerep_lib.Typename.t
include Immediate_option_intf.S_without_immediate_plain with type t := t with type value := value

Constructors analogous to None and Some. If not (some_is_representable x) then some x may raise or return none.

Sourceval none : t
Sourceval some : value -> t
Sourceval some_is_representable : value -> Base.Bool.t

For some representations of immediate options, the encodings of none and some overlap. For these representations, some_is_representable value = false if value cannot be represented as an option. For example, Int.Option uses min_value to represent none. For other representations, some_is_representable always returns true.

Sourceval is_none : t -> Base.Bool.t
Sourceval is_some : t -> Base.Bool.t
Sourceval value : t -> default:value -> value

value (some x) ~default = x and value none ~default = default.

Sourceval value_exn : t -> value

value_exn (some x) = x. value_exn none raises. Unlike Option.value_exn, there is no ?message argument, so that calls to value_exn that do not raise also do not have to allocate.

Sourceval unchecked_value : t -> value

unchecked_value (some x) = x. unchecked_value none returns an unspecified value. unchecked_value t is intended as an optimization of value_exn t when is_some t is known to be true.

Sourceval to_option : t -> value Base.Option.t
Sourceval of_option : value Base.Option.t -> t
Sourcemodule Optional_syntax : Optional_syntax.S with type t := t with type value := value
Sourceval apply_with_none_as_nan : t -> Base.Float.t -> Base.Float.t

apply_with_none_as_nan (some x) y = apply x y, and apply_with_none_as_nan none y = apply (of_mult Float.nan) y

Sourceval of_mult_with_nan_as_none : Base.Float.t -> t

of_mult_with_nan_as_none Float.nan = none, and of_mult_with_nan_as_none x = some (of_mult x) otherwise

Sourceval to_mult_with_none_as_nan : t -> Base.Float.t

to_mult_with_none_as_nan none = Float.nan, and to_mult_with_none_as_nan (some x) = to_mult x

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