stdlib/source/documentation/lux/control/concatenative.lux


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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

(.require
 [library
  [lux (.except if loop left right)
   ["$" documentation]
   [data
    [text
     ["%" \\format (.only format)]]]
   [macro
    ["[0]" template]]
   [math
    [number
     ["n" nat]
     ["i" int]
     ["r" rev]
     ["f" frac]]]]]
 [\\library
  ["[0]" /]])

(`` (.def .public documentation
      (.List $.Module)
      ($.module /._
                ""
                [($.default /.value)

                 ($.documentation /.=>
                   "Concatenative function types."
                   [(=> [Nat] [Nat])]
                   [(All (_ a)
                      (-> a (=> [] [a])))]
                   [(All (_ t)
                      (=> [t] []))]
                   [(All (_ a b c)
                      (=> [a b c] [b c a]))]
                   [(All (_ ,,,0 ,,,1)
                      (=> [then (=> ,,,0 ,,,1)
                           else (=> ,,,0 ,,,1)]
                          ,,,0 [Bit then else] ,,,1))])

                 ($.documentation /.apply
                   "A generator for functions that turn arity N functions into arity N concatenative functions."
                   [(is (=> [Nat] [Nat])
                        ((apply 1) ++))])

                 (,, (with_template [<arity>]
                       [(with_expansions [<name> (template.symbol [/._] ["apply_" <arity>])
                                          <doc> (template.text ["Lift a function of arity " <arity>
                                                                " into a concatenative function of arity " <arity> "."])]
                          ($.documentation <name>
                            <doc>))]

                       [1] [2] [3] [4]
                       [5] [6] [7] [8]
                       ))

                 ($.documentation /.push
                   "Push a value onto the stack.")

                 ($.documentation /.drop
                   "Drop/pop a value from the top of the stack.")

                 ($.documentation /.nip
                   "Drop the second-to-last value from the top of the stack.")

                 ($.documentation /.dup
                   "Duplicate the top of the stack.")

                 ($.documentation /.swap
                   "Swaps the 2 topmost stack values.")

                 ($.documentation /.left_rotation
                   "Rotes the 3 topmost stack values to the left.")

                 ($.documentation /.right_rotation
                   "Rotes the 3 topmost stack values to the right.")

                 ($.documentation /.&&
                   "Groups the 2 topmost stack values as a 2-tuple.")

                 ($.documentation /.left
                   "Left-injects the top into sum.")

                 ($.documentation /.right
                   "Right-injects the top into sum.")

                 (,, (with_template [<input> <word> <func>]
                       [(`` ($.documentation (,, (template.symbol [/._] [<word>]))
                              (,, (template.text [<func> " for " <input> " arithmetic."]))))]

                       [Nat  n/+  n.+]
                       [Nat  n/-  n.-]
                       [Nat  n/*  n.*]
                       [Nat  n//  n./]
                       [Nat  n/%  n.%]
                       [Nat  n/=  n.=]
                       [Nat  n/<  n.<]
                       [Nat  n/<= n.<=]
                       [Nat  n/>  n.>]
                       [Nat  n/>= n.>=]

                       [Int  i/+  i.+]
                       [Int  i/-  i.-]
                       [Int  i/*  i.*]
                       [Int  i//  i./]
                       [Int  i/%  i.%]
                       [Int  i/=  i.=]
                       [Int  i/<  i.<]
                       [Int  i/<= i.<=]
                       [Int  i/>  i.>]
                       [Int  i/>= i.>=]

                       [Rev  r/+  r.+]
                       [Rev  r/-  r.-]
                       [Rev  r/*  r.*]
                       [Rev  r//  r./]
                       [Rev  r/%  r.%]
                       [Rev  r/=  r.=]
                       [Rev  r/<  r.<]
                       [Rev  r/<= r.<=]
                       [Rev  r/>  r.>]
                       [Rev  r/>= r.>=]

                       [Frac f/+  f.+]
                       [Frac f/-  f.-]
                       [Frac f/*  f.*]
                       [Frac f//  f./]
                       [Frac f/%  f.%]
                       [Frac f/=  f.=]
                       [Frac f/<  f.<]
                       [Frac f/<= f.<=]
                       [Frac f/>  f.>]
                       [Frac f/>= f.>=]
                       ))

                 ($.documentation /.if
                   "If expression."
                   [(same? "then"
                           (/.value (|>> (push true)
                                         (push "then")
                                         (push "else")
                                         if)))])

                 ($.documentation /.call
                   "Executes an anonymous block on the stack.")

                 ($.documentation /.loop
                   "Executes a block as a loop until it yields #0 to stop.")

                 ($.documentation /.dip
                   "Executes a block on the stack, save for the topmost value.")

                 ($.documentation /.dip_2
                   "Executes a block on the stack, save for the 2 topmost values.")

                 ($.documentation /.do
                   "Do-while loop expression."
                   [(n.= (++ sample)
                         (/.value (|>> (push sample)
                                       (push (push false))
                                       (push (|>> (push 1) n/+))
                                       do while)))])

                 ($.documentation /.while
                   "While loop expression."
                   [(n.= (n.+ distance start)
                         (/.value (|>> (push start)
                                       (push (|>> dup
                                                  (push start) n/-
                                                  (push distance) n/<))
                                       (push (|>> (push 1) n/+))
                                       while)))])

                 ($.documentation /.compose
                   "Function composition."
                   [(n.= (n.+ 2 sample)
                         (/.value (|>> (push sample)
                                       (push (|>> (push 1) n/+))
                                       (push (|>> (push 1) n/+))
                                       compose
                                       call)))])

                 ($.documentation /.partial
                   "Partial application."
                   [(n.= (n.+ sample sample)
                         (/.value (|>> (push sample)
                                       (push sample)
                                       (push n/+)
                                       partial
                                       call)))])

                 ($.documentation /.when
                   "Only execute the block when #1.")

                 ($.documentation /.?
                   "Choose the top value when #0 and the second-to-top when #1.")]
                [])))