package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>
  5. S
    Simmo Saan <simmo.saan@gmail.com>

Sources

v3.7.2.tar.gz
md5=1fd7bddce07cf5d244fc9427f7b5e4d4
sha512=c0f2a0fdc8253e0ea999d8d4c58bfbf32b18d251a2e1d9656bf279de5f01a33e9aabac3af4d95f465f8b671e7711ebd37218043face233340a0c11b08fa62f78

doc/batteries.unthreaded/BatBounded/index.html

Module BatBoundedSource

Bounded values

This module implements values which must fall within given bounds.

  • author Hezekiah M. Carty
  • since 2.0
Sourcetype 'a bound_t = [
  1. | `o of 'a
  2. | `c of 'a
  3. | `u
]

`open or `closed or `unbounded bounds

Sourcetype ('a, 'b) bounding_f = bounds:('a bound_t * 'a bound_t) -> 'a -> 'b

The type of a bounding function with limits specified by bounds

Sourceval bounding_of_ord : default_low:'b -> default_high:'b -> ('a -> 'b) -> ('a -> 'a -> BatOrd.order) -> ('a, 'b) bounding_f

bounding_of_ord ~default_low ~default_high conv ord will returning a bounding function using ord for value comparison and default_low and default_high for values which fall outside of the requested range. conv is used to convert values which are in-range to the result type.

Sourceval bounding_of_ord_chain : low:('a -> 'b) -> high:('a -> 'b) -> ('a -> 'b) -> ('a -> 'a -> BatOrd.order) -> ('a, 'b) bounding_f

bounding_of_ord_chain ?low ?high ord is like bounding_of_ord except that functions are used to handle out of range values rather than single default values.

Sourceval saturate_of_ord : bounds:('a bound_t * 'a bound_t) -> ('a -> 'a -> BatOrd.order) -> 'a -> 'a

saturate_of_ord ~bounds:(low, high) ord will returning a bounding function using ord for value comparison and low and high for values which fall outside of the requested range.

Sourceval opt_of_ord : bounds:('a bound_t * 'a bound_t) -> ('a -> 'a -> BatOrd.order) -> 'a -> 'a option

opt_of_ord ~bounds:(low, high) ord will returning a bounding function using ord for value comparison and None for values which fall outside of the requested range.

Sourcemodule type BoundedType = sig ... end
Sourcemodule type BoundedNumericType = sig ... end
Sourcemodule type S = sig ... end
Sourcemodule type NumericSig = sig ... end
Sourcemodule Make (M : BoundedType) : S with type base_u = M.base_t with type u = M.t with type t = private M.t

Functor to build an implementation of a bounded type given the bounded values definition M

Sourcemodule MakeNumeric (M : BoundedNumericType) : NumericSig with type base_u = M.base_t with type u = M.t with type t = private M.t