aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/math/number/ratio.lux
blob: e74805a90a7ed0300744395fbc9183e3bc5f52ad (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
(.require
 [library
  [lux (.except)
   ["$" documentation]
   [data
    ["[0]" text (.only \n)
     ["%" \\format (.only format)]]]]]
 [\\library
  ["[0]" /]])

(def .public documentation
  (List $.Documentation)
  (list ($.module /._
                  "Rational numbers.")

        ($.definition /.nat)
        ($.definition /.=)
        ($.definition /.equivalence)
        ($.definition /.<)
        ($.definition /.<=)
        ($.definition /.>)
        ($.definition /.>=)
        ($.definition /.order)
        ($.definition /.+)
        ($.definition /.-)
        ($.definition /.*)
        ($.definition /./)
        ($.definition /.%)
        ($.definition /.reciprocal)
        ($.definition /.codec)
        ($.definition /.addition)
        ($.definition /.multiplication)

        ($.definition /.Ratio
          "An unsigned ratio of numbers.")

        ($.definition /.ratio
          "Rational literals."
          [(ratio numerator denominator)]
          ["The denominator can be omitted if it is 1."
           (ratio numerator)])
        ))