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

(.def .public documentation
  (.List $.Module)
  ($.module /._
            "Rational numbers."
            [($.default /.nat)
             ($.default /.=)
             ($.default /.equivalence)
             ($.default /.<)
             ($.default /.<=)
             ($.default /.>)
             ($.default /.>=)
             ($.default /.order)
             ($.default /.+)
             ($.default /.-)
             ($.default /.*)
             ($.default /./)
             ($.default /.%)
             ($.default /.reciprocal)
             ($.default /.codec)
             ($.default /.addition)
             ($.default /.multiplication)

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

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