Module `Core.Maybe_bound`Source

This module extends Base.Maybe_bound with bin_io and with compare functions in the form of As_lower_bound and As_upper_bound modules.

Sourcetype 'a t = 'a Base.Maybe_bound.t =

| Incl of 'a
| Excl of 'a
| Unbounded

include Bin_prot.Binable.S_local1 with type 'a t := 'a t

include Bin_prot.Binable.S1 with type 'a t := 'a t

Sourceval bin_shape_t : Bin_prot.Shape.t -> Bin_prot.Shape.t

Sourceval bin_size_t : ('a, 'a t) Bin_prot.Size.sizer1

Sourceval bin_write_t : ('a, 'a t) Bin_prot.Write.writer1

Sourceval bin_read_t : ('a, 'a t) Bin_prot.Read.reader1

Sourceval __bin_read_t__ : ('a, int -> 'a t) Bin_prot.Read.reader1

Sourceval bin_writer_t : ('a, 'a t) Bin_prot.Type_class.S1.writer

Sourceval bin_reader_t : ('a, 'a t) Bin_prot.Type_class.S1.reader

Sourceval bin_t : ('a, 'a t) Bin_prot.Type_class.S1.t

Sourceval bin_size_t__local : ('a, 'a t) Bin_prot.Size.sizer_local1

Sourceval bin_write_t__local : ('a, 'a t) Bin_prot.Write.writer_local1

include Ppx_compare_lib.Equal.S1 with type 'a t := 'a t

Sourceval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool

include Ppx_hash_lib.Hashable.S1 with type 'a t := 'a t

Source

val hash_fold_t : 
  (Base.Hash.state -> 'a -> Base.Hash.state) ->
  Base.Hash.state ->
  'a t ->
  Base.Hash.state

include Ppx_quickcheck_runtime.Quickcheckable.S1 with type 'a t := 'a t

Source

val quickcheck_generator : 
  'a Base_quickcheck.Generator.t ->
  'a t Base_quickcheck.Generator.t

Source

val quickcheck_observer : 
  'a Base_quickcheck.Observer.t ->
  'a t Base_quickcheck.Observer.t

Source

val quickcheck_shrinker : 
  'a Base_quickcheck.Shrinker.t ->
  'a t Base_quickcheck.Shrinker.t

Sourceval all : 'a list -> 'a t list

include Sexplib0.Sexpable.S1 with type 'a t := 'a t

Sourceval t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t

Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

Sourceval t_sexp_grammar : 'a Sexplib0.Sexp_grammar.t -> 'a t Sexplib0.Sexp_grammar.t

Sourceval globalize : ('a -> 'a) -> 'a t -> 'a t

Sourceval map : 'a t -> f:('a -> 'b) -> 'b t

Sourceval is_lower_bound : 'a t -> of_:'a -> compare:('a -> 'a -> int) -> bool

Sourceval is_upper_bound : 'a t -> of_:'a -> compare:('a -> 'a -> int) -> bool

Source

val interval_contains_exn : 
  lower:'a t ->
  upper:'a t ->
  'a ->
  compare:('a -> 'a -> int) ->
  bool

interval_contains_exn ~lower ~upper x ~compare raises if lower and upper are crossed.

Source

val bounds_crossed : 
  lower:'a t ->
  upper:'a t ->
  compare:('a -> 'a -> int) ->
  bool

bounds_crossed ~lower ~upper ~compare returns true if lower > upper.

It ignores whether the bounds are Incl or Excl.

Sourcetype interval_comparison = Base.Maybe_bound.interval_comparison =

| Below_lower_bound
| In_range
| Above_upper_bound

Sourceval sexp_of_interval_comparison : interval_comparison -> Sexplib0.Sexp.t

Sourceval interval_comparison_of_sexp : Sexplib0.Sexp.t -> interval_comparison

Source

val interval_comparison_sexp_grammar : 
  interval_comparison Sexplib0.Sexp_grammar.t

Source

val compare_interval_comparison : 
  interval_comparison ->
  interval_comparison ->
  int

Source

val compare_interval_comparison__local : 
  interval_comparison ->
  interval_comparison ->
  int

Source

val hash_fold_interval_comparison : 
  Base.Hash.state ->
  interval_comparison ->
  Base.Hash.state

Sourceval hash_interval_comparison : interval_comparison -> Base.Hash.hash_value

Source

val compare_to_interval_exn : 
  lower:'a t ->
  upper:'a t ->
  'a ->
  compare:('a -> 'a -> int) ->
  interval_comparison

compare_to_interval_exn ~lower ~upper x ~compare raises if lower and upper are crossed.

Sourcemodule As_lower_bound : sig ... end

Compares t values as lower bounds, where Unbounded is lowest, Incl x < Excl x, and other cases of Incl and/or Excl are compared based on 'a. If As_lower_bound.compare compare t1 t2 <= 0 and is_lower_bound t2 ~of_:a ~compare, then is_lower_bound t1 ~of_:a ~compare. For example, for int As_lower_bound.t:

Sourcemodule As_upper_bound : sig ... end

Compares t values as upper bounds, where Unbounded is highest, Incl x > Excl x, and other cases of Incl and/or Excl are compared based on 'a. If As_upper_bound.compare compare_a t1 t2 <= 0 and is_upper_bound t1 ~of_:a ~compare, then is_upper_bound t2 ~of_:a ~compare. For example, for int As_upper_bound.t:

Sourcemodule Stable : sig ... end

Install

dune-project
Dependency

Authors

Maintainers

Sources

doc/core/Core/Maybe_bound/index.html

Module `Core.Maybe_bound`Source

package core

Install

dune-project Dependency

Authors

Maintainers

Sources

doc/core/Core/Maybe_bound/index.html

Module Core.Maybe_boundSource

dune-project
Dependency

Module `Core.Maybe_bound`Source