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

(.def .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [($.default /.zero_cannot_be_a_modulus)
             ($.default /.modulus)
             ($.default /.divisor)
             ($.default /.=)

             ($.documentation (/.Modulus %)
               (format "A number used as a modulus in modular arithmetic."
                       \n "It cannot be 0."))

             ($.documentation /.congruent?
               ""
               [(congruent? modulus reference subject)])

             ($.documentation /.literal
               ""
               ["Success!"
                (literal 123)]
               ["Failure!"
                (literal 0)])]
            []))