aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/type/quotient.lux
blob: b349f4088c7f55d8061668154a1bcb928c62d8cf (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
(.using
 [library
  [lux (.except type)
   ["$" documentation (.only documentation:)]
   [control
    ["<>" parser
     ["<[0]>" code]]]
   [data
    ["[0]" text (.only \n)
     ["%" format (.only format)]]]
   [macro
    ["[0]" template]]]]
 [\\library
  ["[0]" /]])

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

(documentation: (/.Quotient value label)
  (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))

   (is Even
       (quotient even 123))])

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