aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/abstract/interval.lux
blob: 4e7db1093a3c5c561ebe322f5d18940d1cafb80e (plain)
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
61
(.using
 [library
  [lux
   ["$" documentation (.only documentation:)]
   [data
    [text (.only \n)
     ["%" \\format (.only format)]]]]]
 [\\library
  ["[0]" /]])

(documentation: (/.Interval it)
  "A representation of top and bottom boundaries for an ordered type.")

(documentation: /.singleton
  "An interval where both top and bottom are the same value."
  [(singleton enum elem)])

(documentation: /.borders?
  "Where a value is at the border of an interval.")

(documentation: /.union
  "An interval that spans both predecessors.")

(documentation: /.intersection
  "An interval spanned by both predecessors.")

(documentation: /.complement
  "The inverse of an interval.")

(documentation: /.meets?
  "Whether an interval meets another one on its bottom/lower side.")

(.def: .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [..Interval
             ..singleton
             ..borders?
             ..union
             ..intersection
             ..complement
             ..meets?
             ($.default /.between)
             ($.default /.inner?)
             ($.default /.outer?)
             ($.default /.singleton?)
             ($.default /.within?)
             ($.default /.starts_with?)
             ($.default /.ends_with?)
             ($.default /.precedes?)
             ($.default /.succeeds?)
             ($.default /.before?)
             ($.default /.after?)
             ($.default /.touches?)
             ($.default /.starts?)
             ($.default /.finishes?)
             ($.default /.equivalence)
             ($.default /.nested?)
             ($.default /.overlaps?)]
            []))