diff --git a/docs/reference/help.md b/docs/reference/help.md index bacc176..d3e6534 100644 --- a/docs/reference/help.md +++ b/docs/reference/help.md @@ -2,28 +2,16 @@ ## help -Basis Function Combinator +Function -Accepts a quoted symbol on the top of the stack and prints its docs. +Accepts a quoted symbol on the top of the stack and prints its +documentation. -Gentzen diagram. - -### Definition - -if not basis. - -### Derivation - -if not basis. - -### Source - -if basis + [foo] help + ---------------- ### Discussion -Lorem ipsum. +Technically this is equivalent to `pop`, but it will only work if the +item on the top of the stack is a quoted symbol. -### Crosslinks - -Lorem ipsum. diff --git a/docs/reference/hypot.md b/docs/reference/hypot.md index 903d06f..4abcd23 100644 --- a/docs/reference/hypot.md +++ b/docs/reference/hypot.md @@ -2,28 +2,21 @@ ## hypot -Basis Function Combinator +Function -\[sqr\] ii + sqrt - -Gentzen diagram. + x y hypot + -------------------------- + sqrt(sqr(x) + sqr(y)) ### Definition -if not basis. - -### Derivation - -if not basis. - -### Source - -if basis +> \[[sqr]\] [ii] [+] [sqrt] ### Discussion -Lorem ipsum. +This is another function that has to wait on the numeric tower. ### Crosslinks -Lorem ipsum. +[sqrt] + diff --git a/docs/reference/mkref/FuncRef.html b/docs/reference/mkref/FuncRef.html index 10bcc6a..0d53cdc 100644 --- a/docs/reference/mkref/FuncRef.html +++ b/docs/reference/mkref/FuncRef.html @@ -1262,34 +1262,26 @@ a F a
Basis Function Combinator
-Accepts a quoted symbol on the top of the stack and prints its docs.
-Gentzen diagram.
-if not basis.
-if not basis.
-if basis
+Function
+Accepts a quoted symbol on the top of the stack and prints its documentation.
+ [foo] help
+----------------
Lorem ipsum.
-Lorem ipsum.
+Technically this is equivalent to pop, but it will only work if the item on the top of the stack is a quoted symbol.
Basis Function Combinator
-[sqr] ii + sqrt
-Gentzen diagram.
-if not basis.
-if not basis.
-if basis
+Function
+ x y hypot
+--------------------------
+ sqrt(sqr(x) + sqr(y))
++ +
Lorem ipsum.
-Lorem ipsum.
+This is another function that has to wait on the numeric tower.
+(Basis Combinator)
@@ -1297,7 +1289,7 @@ a F a [Q] i
-----------
Q
-combo(i, [list(P)|S], S, Ei, Eo) :- append(P, Ei, Eo).
This is probably the fundamental combinator. You wind up using it in all kinds of places (for example, the x combinator can be defined as dup i.)
Basis Function Combinator
The identity function.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Has the effect of grabbing a copy of the stack on which to run the if-part using infra.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
... [a b c] [Q] infra
---------------------------
c b a Q [...] swaack
-swons swaack [i] dip swaack
This is one of the more useful combinators. It allows a quoted expression to serve as a stack for a program, effectively running it in a kind of “pocket universe”. If the list represents a datastructure then infra lets you work on its internal structure.
Basis Function Combinator
infra first
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
[sqr dup mul] inscribe
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a <= b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a << b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a < b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[codireco] ccons
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Run the quoted program on TOS on the items in the list under it, push a new list with the results in place of the program and original list.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Given a list find the maximum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Given a list find the minimum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a % b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a * b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a != b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as -a.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as not a.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
0 >=
Basis Function Combinator
[nullary] cons
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
... [P] nullary
---------------------
... A
-[stack] dip infra first
-... [P] nullary
... [P] [stack] dip infra first
... stack [P] infra first
@@ -1657,67 +1649,67 @@ a F a
... A
A very useful function that runs any other quoted function and returns it’s first result without disturbing the stack (under the quoted program.)
-Basis Function Combinator
swap at
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a | b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a2 a1 -- a2 a1 a2)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[i] map
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a1 --)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a2 a1 -- a1)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a3 a2 a1 -- a2 a1)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a2 a1 --)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a3 a2 a1 -- a1)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a4 a3 a2 a1 -- a2 a1)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
pop popop
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a ** b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Decrement TOS.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
1 swap [*] step
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[unit] dip
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[0 <=] [1 - dup] anamorphism
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
unit [down_to_zero] infra
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
rest cons
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
([a1 ...0] -- [...0])
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Reverse the list on the top of the stack. :
reverse == [] swap shunt
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a1 a2 a3 -- a2 a3 a1)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a1 a2 a3 -- a3 a1 a2)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Round a number to a given precision in decimal digits.
The return value is an integer if ndigits is omitted or None. Otherwise the return value has the same type as the number. ndigits may be negative.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
([a1 a2 ...1] -- [...1])
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a >> b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
<{} infra
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
([a1 a2 ...1] -- a2)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
The sequence can contain more than two items but not fewer. Currently Python semantics are used to evaluate the "truthiness" of the Boolean value (so empty string, zero, etc. are counted as false, etc.)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Print redistribution information.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
uncons [swons] dip
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[pop ++] step_zero
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Given a list return it sorted.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[[[abs] ii <=] [[<>] [pop !-] ||] &&] [[!-] [[++]] [[--]] ifte dip] [[pop !-] [--] [++] ifte] ifte
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[drop] [take] clop
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[take reverse] [drop] clop
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
dup *
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Return the square root of the number a. Negative numbers return complex roots.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(... -- ... [...])
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[stack] dip
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
The step combinator executes the quotation on each member of the list on top of the stack.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
0 roll> step
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(... a1 -- ... a1 a1 [...])
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(... a2 a1 -- ... a2 a1 a1 a2 [...])
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Same as a - b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Increment TOS.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Given a quoted sequence of numbers return the sum. :
sum == 0 swap [+] step
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
([...1] -- [...0])
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a1 a2 -- a2 a1)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[swap] dip
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
swap concat
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
([...1] a1 -- [a1 ...1])
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[i] genrec
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
... z y x [P] unary
-------------------------
... A
-binary popd
Runs any other quoted function and returns its first result while consuming exactly three items from the stack.
-Basis Function Combinator
([a1 a2 a3 ...1] -- a3)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a2 a1 -- a1 a2 a1)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
... x [P] unary
---------------------
... A
-nullary popd
Runs any other quoted function and returns its first result while consuming exactly one item from the stack.
- [A ...] uncons
--------------------
A [...]
-func(uncons, Si, So) :- func(cons, So, Si).
This is the inverse of cons.
Basis Function Combinator
Given a list remove duplicate items.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
(a1 -- [a1 ])
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
[i] dip
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
([a1 ...1] -- [...1] a1)
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
True if the form on TOS is void otherwise False.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Print warranty information.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
swap nulco dupdipd concat loop
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Print all the words in alphabetical order.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
[F] x
-----------
[F] F
-dup i
The x combinator …
Basis Function Combinator
Same as a ^ b.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.
Basis Function Combinator
Replace the two lists on the top of the stack with a list of the pairs from each list. The smallest list sets the length of the result list.
Gentzen diagram.
-if not basis.
-if not basis.
-if basis
Lorem ipsum.
-Lorem ipsum.