aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/type/quotient.lux
blob: 51b9db0792b7bbfac43449836d0f0a4e9331e881 (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
(.module:
  [library
   [lux (#- type)
    ["$" documentation (#+ documentation:)]
    [control
     ["<>" parser
      ["<.>" code]]]
    [data
     ["." text (#+ \n)
      ["%" format (#+ format)]]]
    [macro
     ["." template]]]]
  [\\library
   ["." /]])

(documentation: /.Class
  "The class knows how to classify/label values that are meant to be equivalent to one another.")

(documentation: /.Quotient
  (format "A quotient value has been labeled with a class."
          \n "All equivalent values will belong to the same class."
          \n "This means all equivalent values possess the same label."))

(documentation: /.quotient
  ""
  [(quotient class value)])

(documentation: /.type
  "The Quotient type associated with a Class type."
  [(def: even
     (class even?))

   (def: Even
     Type
     (type even))

   (: Even
      (quotient even 123))])

(.def: .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [..Class
             ..Quotient
             ..quotient
             ..type
             ($.default /.class)
             ($.default /.value)
             ($.default /.label)
             ($.default /.equivalence)]
            []))