aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/math/number/nat.lux
blob: 957da93b020ed0220dc31c80df277e3ce9de83ba (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
(.module:
  [library
   [lux {"-" [private]}
    ["$" documentation {"+" [documentation:]}]
    [data
     ["." text {"+" [\n]}
      ["%" format {"+" [format]}]]]
    [macro
     ["." template]]]]
  [\\library
   ["." /]])

(template [<name> <documentation>]
  [(documentation: <name>
     <documentation>
     [(<name> parameter subject)])]

  [/.= "Nat(ural) equivalence."]
  [/.+ "Nat(ural) addition."]
  [/.- "Nat(ural) substraction."]
  [/.< "Nat(ural) less-than."]
  [/.<= "Nat(ural) less-than or equal."]
  [/.> "Nat(ural) greater-than."]
  [/.>= "Nat(ural) greater-than or equal."]
  [/.* "Nat(ural) multiplication."]
  [/./ "Nat(ural) division."]
  [/./% "Nat(ural) [division remainder]."]
  [/.% "Nat(ural) remainder."]
  )

(template [<name> <doc>]
  [(documentation: <name>
     <doc>
     [(<name> left right)])]

  [/.min "Nat(ural) minimum."]
  [/.max "Nat(ural) maximum."]
  )

(documentation: /.gcd
  "Greatest Common Divisor.")

(documentation: /.lcm
  "Least Common Multiple.")

(.def: .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [..=
             ..+
             ..-
             ..<
             ..<=
             ..>
             ..>=
             ..*
             ../
             ../%
             ..%
             ..min
             ..max
             ..gcd
             ..lcm
             ($.default /.co_prime?)
             ($.default /.even?)
             ($.default /.odd?)
             ($.default /.frac)
             ($.default /.equivalence)
             ($.default /.order)
             ($.default /.enum)
             ($.default /.interval)
             ($.default /.addition)
             ($.default /.multiplication)
             ($.default /.minimum)
             ($.default /.maximum)
             ($.default /.binary)
             ($.default /.octal)
             ($.default /.hex)
             ($.default /.decimal)
             ($.default /.hash)]
            []))