package core

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

Source file bounded_index_intf.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
open! Import
open! Std_internal

module type S = sig
  type t [@@deriving hash]

  include Identifiable with type t := t

  (** [create index ~min ~max] raises if [index < min || index > max].  The resulting [t]
      is only equal to other [t] if all three fields are the same. *)
  val create : int -> min:int -> max:int -> t

  (** all indices in ascending order *)
  val create_all : min:int -> max:int -> t list

  (** Accessors. *)

  (** [zero_based_index t] is the function that code consuming a [t] most likely wants to
      call. It is simply [index t - min_index t], meaning it returns an index [i] such
      that [0 <= i <= (max_index t - min_index t)]. *)
  val zero_based_index : t -> int

  (** [index t] returns the index [t] was created with, i.e. a number between
      [min_index t] and [max_index t]. *)
  val index : t -> int

  val min_index : t -> int
  val max_index : t -> int

  (** [num_indexes t] returns the number of valid indexes in the range. Equal to
      [max_index t - min_index t + 1]*)
  val num_indexes : t -> int

  module Stable : sig
    module V1 :
      Stable_comparable.With_stable_witness.V1
        with type t = t
        with type comparator_witness = comparator_witness
  end
end

module type Bounded_index = sig
  (** [Bounded_index] creates unique index types with explicit bounds and human-readable
      labels. "(thing 2 of 0 to 4)" refers to a 0-based index for the third element of
      five with the label "thing", whereas a 1-based index for the second element of
      twelve with the label "item" renders as "(item 2 of 1 to 12)", even though both
      represent the index 2.

      Use [Bounded_index] to help distinguish between different index types when reading
      rendered values, deserializing sexps, and typechecking. Consider using
      [Bounded_index] to label fixed pools of resources such as cores in a cpu, worker
      processes in a parallel application, or machines in a cluster. *)

  module type S = S

  module Make (M : sig
    val label : string
    val module_name : string
  end) : S
end
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