diff --git a/docs/MAKE b/docs/MAKE index d5d1faa..10c50bb 100644 --- a/docs/MAKE +++ b/docs/MAKE @@ -1,7 +1,8 @@ python build_index.py ./source/index.md > ./html/index.html -python build_index.py ./source/Thun.md > html/Thun.html +python build_index.py ./source/Thun.md > ./html/Thun.html python build_index.py ./source/notebooks/BigNums.md > ./html/notebooks/BigInts.html python build_index.py ./source/notebooks/Generator_Programs.md > ./html/notebooks/Generator_Programs.html (cd ../implementations/Elm/ ; make) cp -f ../implementations/Elm/demo/Joy.js ./html/Joy.js +(cd ../reference/ ; make) diff --git a/docs/html/FuncRef.html b/docs/html/FuncRef.html index 5541ee7..ad347b4 100644 --- a/docs/html/FuncRef.html +++ b/docs/html/FuncRef.html @@ -1,4 +1,4 @@ -Thun Function Reference

Thun Function Reference

Home

Version -10.0.0

Each function, combinator, or definition should be documented here.


!-

Not negative.

+Thun Function Reference

Thun Function Reference

Home

Version -10.0.0

Each function, combinator, or definition should be documented here.


!-

Not negative.

    n !-
 ----------- n < 0
    false
@@ -7,34 +7,15 @@
    n !-
 ---------- n >= 0
    true
-

Definition

0 >=

Discussion

Return a Boolean value indicating if a number is greater than or equal to -zero.

!=

See ne.


%

See mod.


&

See and.


&&

combinator

Short-circuiting Boolean AND

-

Accept two quoted programs, run the first and expect a Boolean value, if -it's true pop it and run the second program (which should also return a -Boolean value) otherwise pop the second program (leaving false on the -stack.)

-
   [A] [B] &&
----------------- true
-        B
-
-
-   [A] [B] &&
----------------- false
-     false
-
-

Definition

-
nulco [nullary [false]] dip branch
-
-

Derivation

-

TODO: this is derived in one of the notebooks I think, look it up and -link to it, or copy the content here.

Discussion

This is seldom useful, I suspect, but this way you have it.

*

See mul.


+

See add.


++

See succ.

Definition

1 +

-

See sub.


--

See pred.

Definition

1 -

/


//


/floor


<

See lt.


<<

See lshift.

Definition

lshift

<<{}

   ... b a <{}
+

Definition

0 >=

Discussion

Return a Boolean value indicating if a number is greater than or equal to +zero.


!=

built-in

See ne.


%

built-in

See mod.


*

built-in

See mul.


+

built-in

See add.


++

See succ.

Definition

1 +

-

built-in

See sub.


--

See pred.

Definition

1 -

/

built-in


//


/floor


<

built-in

See lt.


<<

built-in

See lshift.

Definition


<<{}

   ... b a <{}
 -----------------
    ... [] b a
-

Definition

[] rollup

Discussion

Tuck an empty list just under the first two items on the stack.

<=

See le.


<>

See ne.


<{}

   ... a <{}
+

Definition

Discussion

Tuck an empty list just under the first two items on the stack.


<=

built-in

See le.


<>

built-in

See ne.


<{}

   ... a <{}
 ----------------
    ... [] a
-

Definition

[] swap

Discussion

Tuck an empty list just under the first item on the stack.

=

See eq.


>

See gt.


>=

See ge.


>>

See rshift.

Definition

rshift

?

Is the item on the top of the stack "truthy"?

Definition

dup bool

Discussion

You often want to test the truth value of an item on the stack without -consuming the item.

^

See xor.


abs

Return the absolute value of the argument.

Definition

dup 0 < [] [neg] branch

add

Add two numbers together: a + b.


anamorphism

combinator

Build a list of values from a generator program G and a stopping +

Definition

[] swap

Discussion

Tuck an empty list just under the first item on the stack.


=

built-in

See eq.


>

built-in

See gt.


>=

built-in

See ge.


>>

built-in

See rshift.

Definition


?

Is the item on the top of the stack "truthy"?

Definition

Discussion

You often want to test the truth value of an item on the stack without +consuming the item.


^

See xor.


abs

Take an integer from the stack and replace it with its absolute value.

Definition

dup 0 < [] [neg] branch

add

built-in

Take two integers from the stack and replace them with their sum.


anamorphism

combinator

Build a list of values from a generator program G and a stopping predicate P.

           [P] [G] anamorphism
 -----------------------------------------
@@ -42,36 +23,60 @@ predicate P.

Example

The range function generates a list of the integers from 0 to n - 1:

+
[0 <=] [-- dup] anamorphism
+
-

[0 <=] [-- dup] anamorphism

-

Definition

[pop []] swap [dip swons] genrec

Discussion

See the [Recursion Combinators notebook](https://joypy.osdn.io/notebooks/Recursion_Combinators.html).

and

Logical bit-wise AND.

Definition

nulco [nullary [false]] dip branch

app1

combinator

"apply one"

+

joy? 5

+

5

+

joy? [0 <=] [-- dup]

+

5 [0 <=] [-- dup]

+

joy? anamorphism

+

[4 3 2 1 0]

+ +

Note that the last value generated (0) is at the bottom of the list. +See the Recursion Combinators notebook.

Definition


and

combinator

Short-circuiting Boolean AND

+

Accept two quoted programs, run the first and expect a Boolean value, if +it's true pop it and run the second program (which should also return a +Boolean value) otherwise pop the second program (leaving false on the +stack.) The quoted programs are run with [nullary].

+
   [A] [B] and
+----------------- A -> true
+        B
+
+
+   [A] [B] and
+----------------- A -> false
+     false
+
+

TODO: this is derived in one of the notebooks I think, look it up and +link to it, or copy the content here.

Definition


app1

combinator

"apply one"

Given a quoted program on TOS and anything as the second stack item run -the program without disturbing the stack and replace the two args with +the program without disturbing the rest of the stack and replace the two args with the first result of the program.

         ... x [Q] app1
 ---------------------------------
    ... [x ...] [Q] infra first
 
-

This is the same effect as the unary combinator.

Definition

grba infrst

Discussion

Just a specialization of `nullary` really. Its parallelizable cousins -are more useful.

app2

combinator

Like app1 with two items.

+

This is the same effect as the unary combinator.

Definition

Discussion

Just a specialization of nullary really. Its parallelizable cousins +are more useful.


app2

combinator

Like app1 with two items.

   ... y x [Q] . app2
 -----------------------------------
    ... [y ...] [Q] . infra first
        [x ...] [Q]   infra first
-

Definition

[grba swap grba swap] dip [infrst] cons ii

Discussion

Unlike [app1](#app1), which is essentially an alias for [unary](#unary), -this function is not the same as [binary](#binary). Instead of running +

Definition

Discussion

Unlike app1, which is essentially an alias for unary, +this function is not the same as binary. Instead of running one program using exactly two items from the stack and pushing one -result (as [binary](#binary) does) this function takes two items from the +result (as binary does) this function takes two items from the stack and runs the program twice, separately for each of the items, then puts both results onto the stack. This is not currently implemented as parallel processes but it can (and -should) be done.


app3

combinator

Like [app1] with three items.

+should) be done.


app3

combinator

Like [app1] with three items.

     ... z y x [Q] . app3
 -----------------------------------
    ... [z ...] [Q] . infra first
        [y ...] [Q]   infra first
        [x ...] [Q]   infra first
-

Definition

3 appN

Discussion

See [app2].

appN

combinator

Like [app1] with any number of items.

+

Definition

Discussion

See [app2].


appN

combinator

Like [app1] with any number of items.

   ... xN ... x2 x1 x0 [Q] n . appN
 --------------------------------------
    ... [xN ...] [Q] . infra first
@@ -79,26 +84,26 @@ should) be done.

Discussion

This function takes a quoted function `Q` and an integer and runs the -function that many times on that many stack items. See also [app2].

at

See getitem.

Definition

drop first

average

Compute the average of a list of numbers. +

Discussion

This function takes a quoted function Q and an integer and runs the +function that many times on that many stack items. See also [app2].


at

See getitem.

Definition


average

Compute the average of a list of numbers. (Currently broken until I can figure out what to do about "numeric tower" -in Thun.)

Definition

[sum] [size] cleave /

Discussion

Theoretically this function would compute the sum and the size in two +in Thun.)

Definition

Discussion

Theoretically this function would compute the sum and the size in two separate threads, then divide. This works but a compiled version would probably do better to sum and count the list once, in one thread, eh? As an exercise in Functional Programming in Joy it would be fun to convert this into a catamorphism. -See the [Recursion Combinators notebook](https://joypy.osdn.io/notebooks/Recursion_Combinators.html).


b

combinator

Run two quoted programs

+See the Recursion Combinators notebook.


b

combinator

Run two quoted programs

   [P] [Q] b
 ---------------
       P Q
-

Definition

[i] dip i

Discussion

This combinator may seem trivial but it comes in handy.

binary

combinator

Run a quoted program using exactly two stack values and leave the first +

Definition

[i] dip i

Discussion

This combinator may seem trivial but it comes in handy.


binary

combinator

Run a quoted program using exactly two stack values and leave the first item of the result on the stack.

   ... y x [P] binary
 -----------------------
         ... a
-

Definition

unary popd

Discussion

Runs any other quoted function and returns its first result while -consuming exactly two items from the stack.

bool

Convert the item on the top of the stack to a Boolean value.

Discussion

For integers 0 is `false` and any other number is `true`; for lists the -empty list is `false` and all other lists are `true`.

branch

combinator built-in

Use a Boolean value to select and run one of two quoted programs.

+

Definition

Discussion

Runs any other quoted function and returns its first result while +consuming exactly two items from the stack.


bool

Convert the item on the top of the stack to a Boolean value.

Discussion

For integers 0 is false and any other number is true; for lists the +empty list is false and all other lists are true.


branch

combinator built-in

Use a Boolean value to select and run one of two quoted programs.

   false [F] [T] branch
 --------------------------
           F
@@ -106,17 +111,17 @@ empty list is `false` and all other lists are `true`.

Discussion

This is one of the fundamental operations (although it can be defined in terms of [choice] as above). The more common "if..then..else" construct -[ifte] adds a predicate function that is evaluated [nullary].


ccccons

   a b c d [...] ccccons
+[ifte] adds a predicate function that is evaluated [nullary].


ccccons

   a b c d [...] ccccons
 ---------------------------
        [a b c d ...]
 
-

Do [cons] four times.

Definition

ccons ccons

ccons

   a b [...] ccons
+

Do [cons] four times.

Definition


ccons

   a b [...] ccons
 ---------------------
       [a b ...]
 
-

Do [cons] two times.

Definition

cons cons

choice

Use a Boolean value to select one of two items.

+

Do [cons] two times.

Definition


choice

Use a Boolean value to select one of two items.

   a b false choice
 ----------------------
           a
@@ -124,8 +129,8 @@ terms of [choice] as above).  The more common "if..then..else" construct
    a b true choice
 ---------------------
           b
-

Discussion

It's a matter of taste whether you implement this in terms of [branch] or -the other way around.

clear

built-in

Clear everything from the stack.

Definition

[] swaack pop

cleave

combinator

Run two programs in parallel, consuming one additional item, and put their +

Discussion

It's a matter of taste whether you implement this in terms of [branch] or +the other way around.


clear

built-in

Clear everything from the stack.

Definition


cleave

combinator

Run two programs in parallel, consuming one additional item, and put their results on the stack.

   ... x [A] [B] cleave
 ------------------------
@@ -139,14 +144,14 @@ results on the stack.

   1 2 3 [+] [-] cleave
 --------------------------
          1 2 5 -1
-

Definition

fork popdd

Discussion

One of a handful of useful parallel combinators.

clop

combinator

Run two programs in parallel, consuming two additional items, and put their results on the stack.

+

Definition

Discussion

One of a handful of useful parallel combinators.


clop

combinator

Run two programs in parallel, consuming two additional items, and put their results on the stack.

   ... x y [A] [B] clop
 --------------------------
         ... a b
-

Definition

cleave popdd

Discussion

Like [cleave] but consumes an additional item from the stack. +

Definition

Discussion

Like [cleave] but consumes an additional item from the stack. 1 2 3 4 [+] [-] clop -------------------------- - 1 2 7 -1


cmp

combinator

Take two values and three quoted programs on the stack and run one + 1 2 7 -1


cmp

combinator

Take two values and three quoted programs on the stack and run one of the three depending on the results of comparing the two values.

   a b [G] [E] [L] cmp
 ------------------------- a > b
@@ -159,23 +164,23 @@ of the three depending on the results of comparing the two values.

a b [G] [E] [L] cmp ------------------------- a < b L -

Definition

[[>] swap] dipd [ifte] ccons [=] swons ifte

Discussion

This is useful sometimes, and you can [dup] or [dupd] with two quoted +

Definition

Discussion

This is useful sometimes, and you can [dup] or [dupd] with two quoted programs to handle the cases when you just want to deal with [<=] or [>=] and not all three possibilities, e.g.: [G] [EL] dup cmp [GE] [L] dupd cmp Or even: - [GL] [E] over cmp


codi

combinator

Take a quoted program from the stack, [cons] the next item onto it, then + [GL] [E] over cmp


codi

combinator

Take a quoted program from the stack, [cons] the next item onto it, then [dip] the whole thing under what was the third item on the stack.

   a b [F] . codi
 --------------------
          b . F a
-

Definition

cons dip

Discussion

This is one of those weirdly specific functions that turns out to be -useful in a few places.

codireco

combinator

This is part of the [make_generator] function. You would not use this -combinator directly.

Definition

codi reco

Discussion

See [make_generator] and the -["Using `x` to Generate Values" notebook](https://joypy.osdn.io/notebooks/Generator_Programs.html#an-interesting-variation) +

Definition

Discussion

This is one of those weirdly specific functions that turns out to be +useful in a few places.


codireco

combinator

This is part of the [make_generator] function. You would not use this +combinator directly.

Definition

Discussion

See [make_generator] and the +"Using x to Generate Values" notebook as well as -[Recursion Theory and Joy](https://www.kevinalbrecht.com/code/joy-mirror/j05cmp.html) by Manfred von Thun.


concat

Concatinate two lists.

+Recursion Theory and Joy by Manfred von Thun.


concat

built-in

Concatinate two lists.

   [a b c] [d e f] concat
 ----------------------------
        [a b c d e f]
@@ -192,66 +197,66 @@ followed by the function expression to run if that predicate returns
     [Default]
 ]
 cond
-

Discussion

It works by rewriting into a chain of nested [ifte]{.title-ref} +

Discussion

It works by rewriting into a chain of nested [ifte]{.title-ref} expressions, e.g.: [[[B0] T0] [[B1] T1] [D]] cond ----------------------------------------- - [B0] [T0] [[B1] [T1] [D] ifte] ifte


cons

built-in

Given an item and a list, append the item to the list to make a new list.

+ [B0] [T0] [[B1] [T1] [D] ifte] ifte


cons

built-in

Given an item and a list, append the item to the list to make a new list.

   a [...] cons
 ------------------
      [a ...]
-

Discussion

Cons is a [venerable old function from Lisp](https://en.wikipedia.org/wiki/Cons#Lists). -Its inverse operation is [uncons].

dinfrirst

combinator

Specialist function (that means I forgot what it does and why.)

Definition

dip infrst

dip

combinator built-in

The dip combinator expects a quoted program on the stack and below it +

Discussion

Cons is a venerable old function from Lisp. +Its inverse operation is [uncons].


dinfrirst

combinator

Specialist function (that means I forgot what it does and why.)

Definition


dip

combinator built-in

The dip combinator expects a quoted program on the stack and below it some item, it hoists the item into the expression and runs the program on the rest of the stack.

   ... x [Q] . dip
 ---------------------
          ... . Q x
-

Discussion

This along with [infra] are enough to update any datastructure. -See the ["Traversing Datastructures with Zippers" notebook](https://joypy.osdn.io/notebooks/Zipper.html). -Note that the item that was on the top of the stack (`x` in the example above) +

Discussion

This along with [infra] are enough to update any datastructure. +See the "Traversing Datastructures with Zippers" notebook. +Note that the item that was on the top of the stack (x in the example above) will not be treated specially by the interpreter when it is reached again. This is something of a footgun. My advice is to avoid putting bare unquoted symbols onto the stack, but then you can't use symbols as -"atoms" and also use `dip` and `infra` to operate on compound +"atoms" and also use dip and infra to operate on compound datastructures with atoms in them. This is a kind of side-effect of the -Continuation-Passing Style. The `dip` combinator could "set aside" the -item and replace it after running `Q` but that means that there is an -"extra space" where the item resides while `Q` runs. One of the nice +Continuation-Passing Style. The dip combinator could "set aside" the +item and replace it after running Q but that means that there is an +"extra space" where the item resides while Q runs. One of the nice things about CPS is that the whole state is recorded in the stack and -pending expression (not counting modifications to the dictionary.)


dipd

combinator

Like [dip] but expects two items.

+pending expression (not counting modifications to the dictionary.)


dipd

combinator

Like [dip] but expects two items.

   ... y x [Q] . dipd
 -------------------------
            ... . Q y x
-

Definition

[dip] codi

Discussion

See [dip].

dipdd

combinator

Like [dip] but expects three items. :

+

Definition

Discussion

See [dip].


dipdd

combinator

Like [dip] but expects three items. :

   ... z y x [Q] . dip
 -----------------------------
              ... . Q z y x
-

Discussion

See [dip].

disenstacken

The disenstacken function expects a list on top of the stack and makes +

Discussion

See [dip].


disenstacken

The disenstacken function expects a list on top of the stack and makes that the stack discarding the rest of the stack.

   1 2 3 [4 5 6] disenstacken
 --------------------------------
             6 5 4
-

Definition

swaack pop

Discussion

Note that the order of the list is not changed, it just looks that way +

Definition

Discussion

Note that the order of the list is not changed, it just looks that way because the stack is printed with the top on the right while lists are -printed with the top or head on the left.


div


divmod

    x y divmod
+printed with the top or head on the left.


div

built-in


divmod

    x y divmod
 ------------------
      q      r
    (x/y)  (x%y)
 
-

Invariant: qy + r = x.

Definition

[/] [%] clop

down_to_zero

Given a number greater than zero put all the Natural numbers (including +

Invariant: qy + r = x.

Definition

[/] [%] clop

down_to_zero

Given a number greater than zero put all the Natural numbers (including zero) less than that onto the stack.

Example

   3 down_to_zero
 --------------------
       3 2 1 0
-

Definition

[0 >] [dup --] while

drop

Expects an integer and a quote on the stack and returns the quote with n +

Definition

[0 >] [dup --] while

drop

Expects an integer and a quote on the stack and returns the quote with n items removed off the top.

Example

   [a b c d] 2 drop
 ----------------------
        [c d]
-

Definition

[rest] times

dup

built-in

"Dup"licate the top item on the stack.

+

Definition


dup

built-in

"Dup"licate the top item on the stack.

   a dup
 -----------
     a a
@@ -259,11 +264,11 @@ items removed off the top.

   a b dupd
 --------------
     a a b
-

Definition

[dup] dip

dupdd

[dup] the third item down on the stack.

+

Definition


dupdd

[dup] the third item down on the stack.

   a b c dupdd
 -----------------
      a a b c
-

Definition

[dup] dipd

dupdip

combinator

Apply a function F and [dup] the item under it on the stack.

+

Definition


dupdip

combinator

Apply a function F and [dup] the item under it on the stack.

   a [F] dupdip
 ------------------
       a F a
@@ -275,26 +280,26 @@ a [F] [dup] dip dip
 a dup [F] dip
 a a [F] dip
 a F a
-

Definition

dupd dip

Discussion

A very common and useful combinator.

dupdipd

combinator

Run a copy of program F under the next item down on the stack.

+

Definition

Discussion

A very common and useful combinator.


dupdipd

combinator

Run a copy of program F under the next item down on the stack.

   a [F] dupdipd
 -------------------
       F a [F]
-

Definition

dup dipd

enstacken

Put the stack onto the stack replacing the contents of the stack.

+

Definition


enstacken

Put the stack onto the stack replacing the contents of the stack.

   ... a b c enstacken
 -------------------------
        [c b a ...]
-

Definition

stack [clear] dip

Discussion

This is a destructive version of [stack]. See the note under -[disenstacken] about the apparent but illusory reversal of the stack.

eq

Compare the two items on the top of the stack for equality and replace +

Definition

Discussion

This is a destructive version of [stack]. See the note under +[disenstacken] about the apparent but illusory reversal of the stack.


eq

built-in

Compare the two items on the top of the stack for equality and replace them with a Boolean value.

   a b eq
 -------------
    Boolean
    (a = b)
-

Definition

[false] [true] [false] cmp

first

built-in

Replace a list with its first item.

+

Definition

[false] [true] [false] cmp

first

built-in

Replace a list with its first item.

   [a ...]
 --------------
       a
-

Definition

uncons pop

first_two

Replace a list with its first two items.

+

Definition


first_two

Replace a list with its first two items.

   [a b ...] first_two
 -------------------------
            a b
@@ -303,107 +308,109 @@ them with a Boolean value.

   [[1 2] [3 [4] 5] [6 7]] flatten
 -------------------------------------
           [1 2 3 [4] 5 6 7]
-

Definition

<{} [concat] step

Discussion

Note that only one "level" of lists is flattened. In the example above -`[4]` is not unquoted.

floor

Return the largest integer \<= x.

Discussion

This function doesn't make sense (yet) to have because there are (as yet) -only integers in the system.

floordiv

I don't know why this is called "floor" div, I think it rounds its +

Definition

Discussion

Note that only one "level" of lists is flattened. In the example above +[4] is not unquoted.


floor

Return the largest integer \<= x.

Discussion

This function doesn't make sense (yet) to have because there are (as yet) +only integers in the system.


floordiv

I don't know why this is called "floor" div, I think it rounds its result down (not towards zero or up.)

   a b floordiv
 ------------------
       (a/b)
-

Discussion

All the division commands need to be revisited when the "numeric tower" -for Thun gets nailed down.

fork

combinator

Run two quoted programs in parallel and replace them with their results.

+

Discussion

All the division commands need to be revisited when the "numeric tower" +for Thun gets nailed down.


fork

combinator

Run two quoted programs in parallel and replace them with their results.

   ... [F] [G] fork
 ----------------------
        ... f g
-

Definition

[i] app2

Discussion

The basic parallelism combinator, the two programs are run independently.

fourth

Replace a list with its fourth item.

+

Definition

Discussion

The basic parallelism combinator, the two programs are run independently.


fourth

Replace a list with its fourth item.

   [a b c d ...] fourth
 --------------------------
           d
-

Definition

rest third

gcd

Take two integers from the stack and replace them with their Greatest -Common Denominator.

Definition

true [tuck mod dup 0 >] loop pop

Discussion

Euclid's Algorithm

gcd2

Compiled GCD function.

Discussion

See [gcd].

ge

Greater-than-or-equal-to comparison of two numbers.

+

Definition


gcd

Take two integers from the stack and replace them with their Greatest +Common Denominator.

Definition

true [tuck mod dup 0 >] loop pop

Discussion

Euclid's Algorithm


gcd2

Compiled GCD function.

Discussion

See [gcd].


ge

built-in

Greater-than-or-equal-to comparison of two numbers.

   a b ge
 --------------
    Boolean
    (a >= b)
-

Definition

[true] [true] [false] cmp

genrec

combinator

General Recursion Combinator.

+

Definition

[true] [true] [false] cmp

genrec

combinator

General Recursion Combinator.

                      [if] [then] [rec1] [rec2] genrec
 ---------------------------------------------------------------------
    [if] [then] [rec1 [[if] [then] [rec1] [rec2] genrec] rec2] ifte
-

Discussion

Note that this definition includes the `genrec` symbol itself, it is +

Discussion

Note that this definition includes the genrec symbol itself, it is self-referential. This is possible because the definition machinery does -not check that symbols in defs are in the dictionary. `genrec` is the +not check that symbols in defs are in the dictionary. genrec is the only self-referential definition. -See the [Recursion Combinators notebook](https://joypy.osdn.io/notebooks/Recursion_Combinators.html). -From ["Recursion Theory and Joy"](https://www.kevinalbrecht.com/code/joy-mirror/j05cmp.html) -by Manfred von Thun: -> "The genrec combinator takes four program parameters in addition to -> whatever data parameters it needs. Fourth from the top is an if-part, -> followed by a then-part. If the if-part yields true, then the then-part -> is executed and the combinator terminates. The other two parameters are -> the rec1-part and the rec2-part. If the if-part yields false, the -> rec1-part is executed. Following that the four program parameters and -> the combinator are again pushed onto the stack bundled up in a quoted -> form. Then the rec2-part is executed, where it will find the bundled -> form. Typically it will then execute the bundled form, either with i -> or with app2, or some other combinator." -The way to design one of these is to fix your base case `[then]` and the -test `[if]`, and then treat `rec1` and `rec2` as an else-part +See the Recursion Combinators notebook. +From "Recursion Theory and Joy" +by Manfred von Thun:

+
+

"The genrec combinator takes four program parameters in addition to +whatever data parameters it needs. Fourth from the top is an if-part, +followed by a then-part. If the if-part yields true, then the then-part +is executed and the combinator terminates. The other two parameters are +the rec1-part and the rec2-part. If the if-part yields false, the +rec1-part is executed. Following that the four program parameters and +the combinator are again pushed onto the stack bundled up in a quoted +form. Then the rec2-part is executed, where it will find the bundled +form. Typically it will then execute the bundled form, either with i +or with app2, or some other combinator." +The way to design one of these is to fix your base case [then] and the +test [if], and then treat rec1 and rec2 as an else-part "sandwiching" a quotation of the whole function. -For example, given a (general recursive) function `F`: +For example, given a (general recursive) function F: F == [I] [T] [R1] [R2] genrec -If the `[I]` if-part fails you must derive `R1` and `R2` from: : +If the [I] if-part fails you must derive R1 and R2 from: : ... R1 [F] R2 -Just set the stack arguments in front, and figure out what `R1` and `R2` -have to do to apply the quoted `[F]` in the proper way. In effect, the -`genrec` combinator turns into an [ifte] combinator with a quoted copy of +Just set the stack arguments in front, and figure out what R1 and R2 +have to do to apply the quoted [F] in the proper way. In effect, the +genrec combinator turns into an [ifte] combinator with a quoted copy of the original definition in the else-part: F == [I] [T] [R1] [R2] genrec == [I] [T] [R1 [F] R2] ifte -Tail recursive functions are those where `R2` is the `i` combinator: +Tail recursive functions are those where R2 is the i combinator: P == [I] [T] [R] tailrec == [I] [T] [R [P] i] ifte - == [I] [T] [R P] ifte


getitem

Expects an integer and a quote on the stack and returns the item at the + == [I] [T] [R P] ifte

+

getitem

Expects an integer and a quote on the stack and returns the item at the nth position in the quote counting from 0.

Example

   [a b c d] 2 getitem
 -------------------------
         c
-

Discussion

If the number isn't a valid index into the quote `getitem` will cause +

Discussion

If the number isn't a valid index into the quote getitem will cause some sort of problem (the exact nature of which is -implementation-dependant.)


grabN

Expect a number on the top of the stack and [cons] that many items from under it onto a new list.

+implementation-dependant.)


grabN

Expect a number on the top of the stack and [cons] that many items from under it onto a new list.

Example

   a b c d e 3 grabN
 -----------------------
       a b [c d e]
-

Definition

<{} [cons] times

grba

A weird function used in [app2] that does this:

+

Definition


grba

A weird function used in [app2] that does this:

      ... 1 2 3 4 5 grba
 -------------------------------
    ... 1 2 3 [4 3 2 1 ...] 5
 
-

It grabs the stack under the top item, and substitutes it for the second item down on the stack.

Definition

[stack popd] dip

Discussion

This function "grabs" an item from the stack along with a copy of the stack. -It's part of the [app2] definition.

gt

Greater-than comparison of two numbers.

+

It grabs the stack under the top item, and substitutes it for the second item down on the stack.

Definition

Discussion

This function "grabs" an item from the stack along with a copy of the stack. +It's part of the [app2] definition.


gt

built-in

Greater-than comparison of two numbers.

   a b gt
 --------------
    Boolean
    (a > b)
-

Definition

[true] [false] [false] cmp

help

Accepts a quoted symbol on the top of the stack and prints its +

Definition

[true] [false] [false] cmp

help

Accepts a quoted symbol on the top of the stack and prints its documentation.

   [foo] help
 ----------------
-

Discussion

Technically this is equivalent to `pop`, but it will only work if the -item on the top of the stack is a quoted symbol.

hypot

         x y hypot
+

Discussion

Technically this is equivalent to pop, but it will only work if the +item on the top of the stack is a quoted symbol.


hypot

         x y hypot
 ---------------------------
    sqrt(sqr(x) + sqr(y))
-

Definition

[sqr] ii + sqrt

Discussion

This is another function that has to wait on the numeric tower.

i

combinator built-in

Append a quoted expression onto the pending expression.

+

Definition

Discussion

This is another function that has to wait on the numeric tower.


i

combinator built-in

Append a quoted expression onto the pending expression.

   [Q] . i
 -------------
        . Q
-

Discussion

This is a fundamental combinator. It is used in all kinds of places. For -example, the [x] combinator can be defined as `dup i`.

id

The identity function.

Discussion

Does nothing. It's kind of a mathematical thing, but it occasionally comes in handy.

ifte

combinator

If-Then-Else combinator, a common and convenient specialization of [branch].

+

Discussion

This is a fundamental combinator. It is used in all kinds of places. For +example, the [x] combinator can be defined as dup i.


id

The identity function.

Discussion

Does nothing. It's kind of a mathematical thing, but it occasionally comes in handy.


ifte

combinator

If-Then-Else combinator, a common and convenient specialization of [branch].

        [if] [then] [else] ifte
 ---------------------------------------
    [if] nullary [else] [then] branch
-

Definition

[nullary] dipd swap branch

ii

combinator

Take a quoted program from the stack and run it twice, first under the +

Definition


ii

combinator

Take a quoted program from the stack and run it twice, first under the top item, then again with the top item.

... a [Q] ii
 ------------------
@@ -420,13 +427,13 @@ top item, then again with the top item.

1 2 4 4 [++] • i 1 2 4 4 • ++ 1 2 4 5 • -

Definition

[dip] dupdip i

Discussion

In some cases (like the example above) this is the same effect as using [app2] but most of the time it's not: +

Definition

Discussion

In some cases (like the example above) this is the same effect as using [app2] but most of the time it's not: 1 2 3 4 [+] ii -------------------- 1 9 1 2 3 4 [+] app2 ---------------------- - 1 2 5 6


infra

combinator

Accept a quoted program and a list on the stack and run the program with + 1 2 5 6


infra

combinator

Accept a quoted program and a list on the stack and run the program with the list as its stack. Does not affect the stack (below the list.)

   ... x y z [a b c] [Q] infra
 ---------------------------------
@@ -441,23 +448,23 @@ c b a [F] i [...]         swaack
 c b a  F    [...]         swaack
 d e         [...]         swaack
 ... [e d]
-

Definition

swons swaack [i] dip swaack

Discussion

This is one of the more useful combinators. It allows a quoted +

Definition

Discussion

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.


infrst

combinator

Does [infra] and then extracts the [first] item from the resulting list.

Definition

infra first

inscribe

Create a new Joy function definition in the Joy dictionary. A definition +infra lets you work on its internal structure.


infrst

combinator

Does [infra] and then extracts the [first] item from the resulting list.

Definition


inscribe

built-in

Create a new Joy function definition in the Joy dictionary. A definition is given as a quote with a name followed by a Joy expression.

Example

[sqr dup mul] inscribe
-

Discussion

This is the only function that modifies the dictionary. It's provided as a +

Discussion

This is the only function that modifies the dictionary. It's provided as a convenience, for tinkering with new definitions before entering them into -the `defs.txt` file. It can be abused, which you should avoid unless you -know what you're doing.


le

Less-Than-or-Equal-to comparison of the two items on the top of the +the defs.txt file. It can be abused, which you should avoid unless you +know what you're doing.


le

built-in

Less-Than-or-Equal-to comparison of the two items on the top of the stack, replacing them with a Boolean value.

   a b le
 -------------
    Boolean
    (a <= b)
-

Definition

[false] [true] [true] cmp

loop

combinator built-in

Expect a quoted program Q and a Boolean value on the stack. If the value is false +

Definition

[false] [true] [true] cmp

loop

combinator built-in

Expect a quoted program Q and a Boolean value on the stack. If the value is false discard the quoted program, otherwise run a copy of Q and loop again.

   false [Q] loop
 --------------------
@@ -466,25 +473,27 @@ discard the quoted program, otherwise run a copy of Q and loo
    true [Q] . loop
 --------------------------
             . Q [Q] loop
-

Discussion

This, along with [branch] and [fork], is one of the four main combinators +

Discussion

This, along with [branch] and [fork], is one of the four main combinators of all programming. The fourth, sequence, is implied by juxtaposition. -That is to say, in Joy `F G` is like `G(F(...))` in a language bassed on -function application. Or again, to quote the [Joy Wikipedia -entry](https://en.wikipedia.org/wiki/Joy_(programming_language)#Mathematical_purity), -> In Joy, the meaning function is a homomorphism from the syntactic monoid onto the semantic monoid. That is, the syntactic relation of concatenation of symbols maps directly onto the semantic relation of composition of functions. +That is to say, in Joy F G is like G(F(...)) in a language bassed on +function application. Or again, to quote the Joy Wikipedia +entry,

+
+

In Joy, the meaning function is a homomorphism from the syntactic monoid onto the semantic monoid. That is, the syntactic relation of concatenation of symbols maps directly onto the semantic relation of composition of functions. Anyway, [branch], [fork], amd [loop] are the fundamental combinators in Joy. Just as [branch] has it's more common and convenient form [ifte], -[loop] has [while].


lshift

Logical Left-Shift

+[loop] has [while].

+

lshift

built-in

Logical Left-Shift

   a n lshift
 ----------------
      (a×2ⁿ)
-

Definition

[2 *] times

lt

Less-Than comparison of the two items on the top of the +

Definition

[2 *] times

lt

built-in

Less-Than comparison of the two items on the top of the stack, replacing them with a Boolean value.

   a b lt
 -------------
    Boolean
    (a < b)
-

Definition

[false] [false] [true] cmp

make_generator

Given an initial state value and a quoted generator function build a +

Definition

[false] [false] [true] cmp

make_generator

Given an initial state value and a quoted generator function build a generator quote.

   state [generator function] make_generator
 -----------------------------------------------
@@ -499,15 +508,15 @@ generator quote.

   [230 [dup ++] codireco] 5 [x] times pop
 ---------------------------------------------
              230 231 232 233 234
-

Definition

[codireco] ccons

Discussion

See the ["Using `x` to Generate Values" notebook](https://joypy.osdn.io/notebooks/Generator_Programs.html#an-interesting-variation).

map

combinator

Given a list of items and a quoted program run the program for each item +

Definition


map

combinator

Given a list of items and a quoted program run the program for each item in the list (with the rest of the stack) and replace the old list and the program with a list of the results.

Example

   5 [1 2 3] [++ *] map
 --------------------------
        5 [10 15 20]
-

Definition

[_map0] cons [[] [_map?] [_mape]] dip tailrec

Discussion

This is a common operation in many languages. In Joy it can be a -parallelism combinator due to the "pure" nature of the language.

max

Given a list find the maximum.

+

Definition

Discussion

This is a common operation in many languages. In Joy it can be a +parallelism combinator due to the "pure" nature of the language.


max

Given a list find the maximum.

Example

   [1 2 3 4] max
 -------------------
@@ -521,7 +530,7 @@ parallelism combinator due to the "pure" nature of the language.
a b mod ------------- (a%b) -

Definition

%

modulus

See mod.


mul

Multiply two numbers.

+

Definition


modulus

See mod.


mul

built-in

Multiply two numbers.

   a b mul
 -------------
     (a×b)
@@ -535,7 +544,7 @@ stack, replacing them with a Boolean value.

   a neg
 -----------
     -a
-

Definition

0 swap -

not

Like [bool] but convert the item on the top of the stack to the inverse +

Definition


not

Like [bool] but convert the item on the top of the stack to the inverse Boolean value.

   true not
 --------------
@@ -544,11 +553,11 @@ Boolean value.

false not --------------- true -

Definition

[true] [false] branch

nulco

Take the item on the top of the stack and [cons] it onto [nullary].

+

Definition

[true] [false] branch

nulco

Take the item on the top of the stack and [cons] it onto [nullary].

     [F] nulco
 -------------------
    [[F] nullary]
-

Definition

[nullary] cons

Discussion

Helper function for [\|\|] and [&&].

nullary

combinator

Run a quoted program without using any stack values and leave the first +

Definition

Discussion

Helper function for [or] and [and].


nullary

combinator

Run a quoted program without using any stack values and leave the first item of the result on the stack.

   ... [P] nullary
 ---------------------
@@ -561,14 +570,14 @@ item of the result on the stack.

... [...] [P] infra first ... [a ...] first ... a -

Definition

[stack] dinfrirst

Discussion

A very useful function that runs any other quoted function and returns +

Definition

Discussion

A very useful function that runs any other quoted function and returns it's first result without disturbing the stack (under the quoted -program.)


of

Like [getitem] but [swap]s the order of arguments.

+program.)


of

Like [getitem] but [swap]s the order of arguments.

Example

   2 [a b c d] of
 --------------------
          c
-

Definition

swap at

or

Logical bit-wise OR.

Definition

nulco [nullary] dip [true] branch

over

[dup] the second item on the stack over the first.

+

Definition


or

Logical bit-wise OR.

Definition


over

[dup] the second item on the stack over the first.

   a b over
 --------------
     a b a
@@ -582,43 +591,43 @@ program.)

Discussion

A fine old word from Forth.

pam

combinator

Take a list of quoted functions from the stack and replace it with a list +

And so on...

Definition

Discussion

A fine old word from Forth.


pam

combinator

Take a list of quoted functions from the stack and replace it with a list of the [first] results from running those functions (on copies of the rest of the stack.)

Example

   5 7 [[+][-][*][/][%]] pam
 -------------------------------
       5 7 [12 -2 35 0 5]
-

Definition

[i] map

Discussion

A specialization of [map] that runs a list of functions in parallel (if -the underlying [map] function is so implemented, of course.)

pick

See getitem.


pm

Plus or minus. Replace two numbers with their sum and difference.

+

Definition

[i] map

Discussion

A specialization of [map] that runs a list of functions in parallel (if +the underlying [map] function is so implemented, of course.)


pick

See getitem.


pm

Plus or minus. Replace two numbers with their sum and difference.

      a b pm
 -----------------
    (a+b) (a-b)
-

Definition

[+] [-] clop

pop

built-in

Pop the top item from the stack and discard it.

+

Definition

[+] [-] clop

pop

built-in

Pop the top item from the stack and discard it.

   a pop
 -----------
 

popd

[pop] the second item down on the stack.

   a b popd
 --------------
       b
-

Definition

[pop] dip

popdd

[pop] the third item on the stack.

+

Definition


popdd

[pop] the third item on the stack.

   a b c popdd
 -----------------
        b c
-

Definition

[pop] dipd

popop

[pop] two items from the stack.

+

Definition


popop

[pop] two items from the stack.

   a b popop
 ---------------
-

Definition

pop pop

popopd

[pop] the second and third items from the stack.

+

Definition


popopd

[pop] the second and third items from the stack.

   a b c popopd
 ------------------
         c
-

Definition

[popop] dip

popopdd

   a b c d popopdd
+

Definition


popopdd

   a b c d popopdd
 ---------------------
         c d
-

Definition

[popop] dipd

popopop

[pop] three items from the stack.

+

Definition


popopop

[pop] three items from the stack.

   a b c popopop
 -------------------
-

Definition

pop popop

pow

Take two numbers a and n from the stack and raise a to the nth +

Definition


pow

Take two numbers a and n from the stack and raise a to the nth power. (n is on the top of the stack.)

   a n pow
 -------------
@@ -628,7 +637,7 @@ power.  (n is on the top of the stack.)

   2 [2 3 4 5 6 7 8 9] [pow] map
 -----------------------------------
     2 [4 8 16 32 64 128 256 512]
-

Definition

1 roll> swap [*] cons times

pred

Predecessor. Decrement TOS.


primrec

combinator

Definition


pred

Predecessor. Decrement TOS.


primrec

combinator

From the "Overview of the language JOY"

The primrec combinator expects two quoted programs in addition to a data parameter. For an integer data parameter it works like this: If @@ -652,8 +661,8 @@ element on the stack.

n [Base] [Recur] primrec ------------------------------------------ n > 0 n (n-1) [Base] [Recur] primrec Recur -

Discussion

Simple and useful specialization of the [genrec] combinator from the -[original Joy system](https://www.kevinalbrecht.com/code/joy-mirror/index.html).

product

Just as [sum] sums a list of numbers, this function multiplies them +

Discussion

Simple and useful specialization of the [genrec] combinator from the +original Joy system.


product

Just as [sum] sums a list of numbers, this function multiplies them together.

Definition

@@ -662,11 +671,11 @@ together.

Or,

[1] [[mul]] [primrec]

-

Definition

1 swap [*] step

quoted

"Quote D" Wrap the second item on the stack in a list.

+

Definition

1 swap [*] step

quoted

"Quote D" Wrap the second item on the stack in a list.

   a b quoted
 ----------------
      [a] b
-

Definition

[unit] dip

Discussion

This comes from the original Joy stuff.

range

Expect a number n on the stack and replace it with a list: +

Definition

Discussion

This comes from the original Joy stuff.


range

Expect a number n on the stack and replace it with a list: [(n-1)...0].

Example

     5 range
@@ -676,17 +685,17 @@ together.

-5 range -------------- [] -

Definition

[0 <=] [-- dup] anamorphism

Discussion

If `n` is less than 1 the resulting list is empty.

range_to_zero

Take a number n from the stack and replace it with a list +

Definition

Discussion

If n is less than 1 the resulting list is empty.


range_to_zero

Take a number n from the stack and replace it with a list [0...n].

Example

   5 range_to_zero
 ---------------------
     [0 1 2 3 4 5]
-

Definition

unit [down_to_zero] infra

Discussion

Note that the order is reversed compared to [range].

reco

Replace the first item in a list with the item under it.

+

Definition

Discussion

Note that the order is reversed compared to [range].


reco

Replace the first item in a list with the item under it.

   a [b ...] reco
 --------------------
      [a ...]
-

Definition

rest cons

rem

See mod.


remainder

See mod.


remove

Expects an item on the stack and a quote under it and removes that item +

Definition


rem

built-in

See mod.


remainder

built-in

See mod.


remove

Expects an item on the stack and a quote under it and removes that item from the the quote. The item is only removed once. If the list is empty or the item isn't in the list then the list is unchanged.

   [1 2 3 1] 1 remove
@@ -697,34 +706,34 @@ or the item isn't in the list then the list is unchanged.

See the "Remove Function" notebook.


rest

built-in

   [a ...] rest
 ------------------
       [...]
-

Definition

uncons popd

reverse

Reverse the list on the top of the stack.

+

Definition


reverse

Reverse the list on the top of the stack.

Example

   [1 2 3] reverse
 ---------------------
        [3 2 1]
-

Definition

<{} shunt

roll<

Definition

swapd swap

roll>

See rollup.

Definition

swap swapd

rolldown

   a b c rolldown
+

Definition


roll<

Definition


roll>

See rollup.

Definition


rolldown

   a b c rolldown
 --------------------
        b c a
-

Definition

roll<

rollup

   a b c rollup
+

Definition


rollup

   a b c rollup
 ------------------
       c a b
-

Definition

roll>

round

Round a number to a given precision in decimal digits.

Discussion

Another one that won't make sense until the "numeric tower" is nailed -down.

rrest

   [a b ...] rrest
+

Definition


round

Round a number to a given precision in decimal digits.

Discussion

Another one that won't make sense until the "numeric tower" is nailed +down.


rrest

   [a b ...] rrest
 ---------------------
         [...]
-

Definition

rest rest

rshift

Definition


rshift

built-in

Logical Right-Shift

   a n rshift
 ----------------
      (a∕2ⁿ)
-

Definition

[2 /] times

run

Run a quoted program in a list.

+

Definition

[2 /] times

run

Run a quoted program in a list.

Example

   [1 2 +] run
 -----------------
        [3]
-

Definition

<{} infra

second

   [a b ...] second
+

Definition


second

   [a b ...] second
 ----------------------
           b
-

Definition

rest first

select

Use a Boolean value to select one of two items from a sequence. :

+

Definition


select

Use a Boolean value to select one of two items from a sequence. :

   [a b] false select
 ------------------------
            a
@@ -732,60 +741,60 @@ down.

rrest

Discussion

The sequence can contain more than two items but not fewer.


sharing

Print redistribution information.

Discussion

Mathematically this is a form of [id], but it has the side-effect of -printing out the GPL notice.

shift

Move the top item from one list to another.

+

Discussion

The sequence can contain more than two items but not fewer.


sharing

Print redistribution information.

Discussion

Mathematically this is a form of [id], but it has the side-effect of +printing out the GPL notice.


shift

Move the top item from one list to another.

Example

   [x y z] [a b c] shift
 ---------------------------
       [a x y z] [b c]
-

Definition

uncons [swons] dip

shunt

Like [concat] but [reverse] the top list into the second.

+

Definition


shunt

Like [concat] but [reverse] the top list into the second.

Example

   [a b c] [d e f] shunt
 ---------------------------
        [f e d a b c]
-

Definition

[swons] step

Discussion

This is more efficient than [concat] so prefer it if you don't need to -preserve order.

size

Replace a list with its size.

+

Definition

Discussion

This is more efficient than [concat] so prefer it if you don't need to +preserve order.


size

Replace a list with its size.

Example

   [23 [cats] 4] size
 ------------------------
            3
-

Definition

[pop ++] step_zero

sort

Given a list return it sorted.

+

Definition


sort

Given a list return it sorted.

Example

   [4 2 5 7 1] sort
 ----------------------
       [1 2 4 5 7]
-

spiral_next

Example code.

Definition

[[[abs] ii <=] [[<>] [pop !-] or] and] [[!-] [[++]] [[--]] ifte dip] [[pop !-] [--] [++] ifte] ifte

Discussion

See the ["Square Spiral Example Joy Code" notebook](https://joypy.osdn.io/notebooks/Square_Spiral.html).

split_at

Split a list (second on the stack) at the position given by the number on +


spiral_next

Example code.

Definition

[[[abs] ii <=] [[<>] [pop !-] or] and] [[!-] [[++]] [[--]] ifte dip] [[pop !-] [--] [++] ifte] ifte

split_at

Split a list (second on the stack) at the position given by the number on the top of the stack.

Example

   [1 2 3 4 5 6 7] 4 split_at
 --------------------------------
        [5 6 7] [4 3 2 1]
-

Definition

[drop] [take] clop

Discussion

Take a list and a number `n` from the stack, take `n` items from the top -of the list and [shunt] them onto a new list that replaces the number `n` -on the top of the stack.

split_list

Split a list (second on the stack) at the position given by the number on +

Definition

Discussion

Take a list and a number n from the stack, take n items from the top +of the list and [shunt] them onto a new list that replaces the number n +on the top of the stack.


split_list

Split a list (second on the stack) at the position given by the number on the top of the stack such that [concat] would reconstruct the original list.

   [1 2 3 4 5 6 7] 4 split_list
 ----------------------------------
         [1 2 3 4] [5 6 7]
-

Definition

[take reverse] [drop] clop

Discussion

Compare with [split_at]. This function does extra work to ensure that -[concat] would reconstruct the original list.

sqr

Square the number on the top of the stack.

+

Definition

Discussion

Compare with [split_at]. This function does extra work to ensure that +[concat] would reconstruct the original list.


sqr

Square the number on the top of the stack.

   n  sqr
 ------------
      n²
-

Definition

dup mul

sqrt

Function Combinator

+

Definition


sqrt

Function Combinator

Return the square root of the number a. Negative numbers return complex -roots.

Discussion

Another "numeric tower" hatch...

stack

built-in

Put the stack onto the stack.

+roots.

Discussion

Another "numeric tower" hatch...


stack

built-in

Put the stack onto the stack.

      ... c b a stack
 ---------------------------
    ... c b a [a b c ...]
-

Discussion

This function forms a pair with [unstack], and together they form the -complement to the "destructive" pair [enstacken] and [disenstacken].

stackd

Grab the stack under the top item and put it onto the stack.

+

Discussion

This function forms a pair with [unstack], and together they form the +complement to the "destructive" pair [enstacken] and [disenstacken].


stackd

Grab the stack under the top item and put it onto the stack.

Example

   ... 1 2 3 stackd
 ------------------------
   ... 1 2 [2 1 ...] 3
-

Definition

[stack] dip

step

combinator

Run a quoted program on each item in a sequence.

+

Definition


step

combinator

Run a quoted program on each item in a sequence.

   ... [] [Q] step
 ---------------------
          ...
@@ -799,22 +808,22 @@ complement to the "destructive" pair [enstacken] and [disenstacken].

Definition

[_step0] x

Discussion

See the [Recursion Combinators notebook](https://joypy.osdn.io/notebooks/Recursion_Combinators.html).

step_zero

combinator

Like [step] but with 0 as the initial value.

+

Definition


step_zero

combinator

Like [step] but with 0 as the initial value.

   [...] [F] step_zero
 -------------------------
      0 [...] [F] step
-

Definition

0 roll> step

Discussion

[size] and [sum] can both be defined in terms of this specialization of -[step].

stuncons

Take the [stack] and [uncons] the top item.

+

Definition

Discussion

[size] and [sum] can both be defined in terms of this specialization of +[step].


stuncons

Take the [stack] and [uncons] the top item.

Example

   1 2 3 stuncons
 --------------------
    1 2 3 3 [2 1]
-

Definition

stack uncons

stununcons

Take the [stack] and [uncons] the top two items.

+

Definition


stununcons

Take the [stack] and [uncons] the top two items.

Example

   1 2 3 stununcons
 ----------------------
     1 2 3 3 2 [1]
-

sub

Subtract the number on the top of the stack from the number below it.

+

sub

built-in

Subtract the number on the top of the stack from the number below it.

   a b sub
 -------------
     (a-b)
@@ -823,14 +832,14 @@ complement to the "destructive" pair [enstacken] and [disenstacken].
[1 2 3 4 5] sum --------------------- 15 -

Definition

[+] step_zero

swaack

built-in

Swap stack. Take a list from the top of the stack, replace the stack +

Definition


swaack

built-in

Swap stack. Take a list from the top of the stack, replace the stack with the list, and put the old stack onto it.

Example

   1 2 3 [4 5 6] swaack
 --------------------------
    6 5 4 [3 2 1]
-

Discussion

This function works as a kind of "context switch". It's used in the -definition of [infra].

swap

built-in

Swap the top two items on the stack.

+

Discussion

This function works as a kind of "context switch". It's used in the +definition of [infra].


swap

built-in

Swap the top two items on the stack.

   a b swap
 --------------
      b a
@@ -838,29 +847,29 @@ definition of [infra].

swoncat

[concat] two lists, but [swap] the lists first.

Definition

swap concat

swons

Like [cons] but [swap] the item and list.

+

Definition


swoncat

[concat] two lists, but [swap] the lists first.

Definition


swons

Like [cons] but [swap] the item and list.

   [...] a swons
 -------------------
       [a ...]
-

Definition

swap cons

tailrec

combinator

A specialization of the [genrec] combinator.

Definition

[i] genrec

Discussion

Some recursive functions do not need to store additional data or pending -actions per-call. These are called ["tail recursive" functions](https://en.wikipedia.org/wiki/Tail_recursive). In Joy, +

Definition


tailrec

combinator

A specialization of the [genrec] combinator.

Definition

Discussion

Some recursive functions do not need to store additional data or pending +actions per-call. These are called "tail recursive" functions. In Joy, they appear as [genrec] definitions that have [i] for the second half of their recursive branch. -See the [Recursion Combinators notebook](https://joypy.osdn.io/notebooks/Recursion_Combinators.html).


take

Expects an integer n and a list on the stack and replace them with a list +See the Recursion Combinators notebook.


take

Expects an integer n and a list on the stack and replace them with a list with just the top n items in reverse order.

   [a b c d] 2 take
 ----------------------
         [b a]
-

Definition

<<{} [shift] times pop

ternary

combinator

Run a quoted program using exactly three stack values and leave the first +

Definition


ternary

combinator

Run a quoted program using exactly three stack values and leave the first item of the result on the stack.

   ... z y x [P] ternary
 -------------------------
          ... a
-

Definition

binary popd

Discussion

Runs any other quoted function and returns its first result while -consuming exactly three items from the stack.

third

   [a b c ...] third
+

Definition

Discussion

Runs any other quoted function and returns its first result while +consuming exactly three items from the stack.


third

   [a b c ...] third
 -----------------------
            c
-

Definition

rest second

times

combinator

Expect a quoted program and an integer n on the stack and do the +

Definition


times

combinator

Expect a quoted program and an integer n on the stack and do the program n times.

   ... n [Q] . times
 -----------------------  w/ n <= 0
@@ -873,7 +882,7 @@ program n times.

... n [Q] . times ------------------------------------- w/ n > 1 ... . Q (n-1) [Q] times -

Definition

[_times0] x

Discussion

This works by building a little [while] program and running it: +

Definition

Discussion

This works by building a little [while] program and running it: 1 3 [++] • [-- dip] cons [swap] infra [0 >] swap while pop 1 3 [++] [-- dip] • cons [swap] infra [0 >] swap while pop 1 3 [[++] -- dip] • [swap] infra [0 >] swap while pop @@ -887,37 +896,37 @@ program n times.

This is a common pattern in Joy. You accept some parameters from the stack which typically include qouted programs and use them to build another program which does the actual work. This is kind of like macros -in Lisp, or preprocessor directives in C.

truthy

See bool.


tuck

[dup] the item on the top of the stack under the second item on the +in Lisp, or preprocessor directives in C.


truthy

built-in

See bool.


tuck

[dup] the item on the top of the stack under the second item on the stack.

   a b tuck
 --------------
     b a b
-

Definition

dup swapd

unary

(Combinator)

+

Definition


unary

(Combinator)

Run a quoted program using exactly one stack value and leave the first item of the result on the stack.

   ... x [P] unary
 ---------------------
        ... a
-

Definition

nullary popd

Discussion

Runs any other quoted function and returns its first result while -consuming exactly one item from the stack.

uncons

Removes an item from a list and leaves it on the stack under the rest of +

Definition

Discussion

Runs any other quoted function and returns its first result while +consuming exactly one item from the stack.


uncons

Removes an item from a list and leaves it on the stack under the rest of the list. You cannot uncons an item from an empty list.

   [a ...] uncons
 --------------------
       a [...]
-

Definition

[first] dupdip rest

Discussion

This is the inverse of [cons].

unique

Given a list remove duplicate items.


unit

   a unit
+

Definition

Discussion

This is the inverse of [cons].


unique

Given a list remove duplicate items.


unit

   a unit
 ------------
     [a]
-

Definition

[] cons

unquoted

combinator

Unquote (using [i]) the list that is second on the stack.

+

Definition

[] cons

unquoted

combinator

Unquote (using [i]) the list that is second on the stack.

Example

   1 2 [3 4] 5 unquoted
 --------------------------
          1 2 3 4 5
-

Definition

[i] dip

unswons

   [a ...] unswons
+

Definition

[i] dip

unswons

   [a ...] unswons
 ---------------------
        [...] a
-

Definition

uncons swap

void

True if the form on TOS is void otherwise False.

Discussion

A form is any Joy expression composed solely of lists. +

Definition


void

True if the form on TOS is void otherwise False.

Discussion

A form is any Joy expression composed solely of lists. This represents a binary Boolean logical formula in the arithmetic of the -"Laws of Form", see [The Markable Mark](http://www.markability.net/)


warranty

Print warranty information.


while

combinator

A specialization of [loop] that accepts a quoted predicate program P +"Laws of Form", see The Markable Mark


warranty

Print warranty information.


while

combinator

A specialization of [loop] that accepts a quoted predicate program P and runs it [nullary].

   [P] [F] while
 ------------------- P -> false
@@ -925,27 +934,27 @@ and runs it [nullary].

[P] [F] while --------------------- P -> true F [P] [F] while -

words

Print all the words in alphabetical order.

Discussion

Mathematically this is a form of [id].

x

combinator

Take a quoted function F and run it with itself as the first item on +


words

Print all the words in alphabetical order.

Discussion

Mathematically this is a form of [id].


x

combinator

Take a quoted function F and run it with itself as the first item on the stack.

   [F] x
 -----------
    [F] F
-

Definition

dup i

Discussion

The simplest recursive pattern. -See the [Recursion Combinators notebook](https://joypy.osdn.io/notebooks/Recursion_Combinators.html). +

Definition

Discussion

The simplest recursive pattern. +See the Recursion Combinators notebook. as well as -[Recursion Theory and Joy](https://www.kevinalbrecht.com/code/joy-mirror/j05cmp.html) by Manfred von


xor

Logical bit-wise eXclusive OR.

Definition

[] [not] branch

zip

Replace the two lists on the top of the stack with a list of the pairs +Recursion Theory and Joy by Manfred von


xor

Logical bit-wise eXclusive OR.

Definition

[] [not] branch

zip

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.

Example

   [1 2 3] [4 5 6] zip
 -------------------------
    [[4 1] [5 2] [6 3]]
-

||

combinator

Short-circuiting Boolean OR

Discussion

Accept two quoted programs, run the first and expect a Boolean value, if -it’s `false` pop it and run the second program (which should also return a -Boolean value) otherwise pop the second program (leaving `true` on the +

||

combinator

Short-circuiting Boolean OR

Discussion

Accept two quoted programs, run the first and expect a Boolean value, if +it’s false pop it and run the second program (which should also return a +Boolean value) otherwise pop the second program (leaving true on the stack.) [A] [B] || ---------------- A -> false B [A] [B] || ---------------- A -> true - true

+ true

diff --git a/docs/reference/Function-Reference.md b/docs/reference/Function-Reference.md index c285f3a..196fbfb 100644 --- a/docs/reference/Function-Reference.md +++ b/docs/reference/Function-Reference.md @@ -10,18 +10,17 @@ Each function, combinator, or definition should be documented here. ## abs -Return the absolute value of the argument. +Take an integer from the stack and replace it with its absolute value. ------------------------------------------------------------------------ ## add -Add two numbers together: a + b. - +Take two integers from the stack and replace them with their sum. ------------------------------------------------------------------------ -## && +## and Combinator @@ -30,43 +29,24 @@ Short-circuiting Boolean AND Accept two quoted programs, run the first and expect a Boolean value, if it's `true` pop it and run the second program (which should also return a Boolean value) otherwise pop the second program (leaving `false` on the -stack.) +stack.) The quoted programs are run with [nullary]. - [A] [B] && - ---------------- true + [A] [B] and + ----------------- A -> true B - [A] [B] && - ---------------- false + [A] [B] and + ----------------- A -> false false - -### Definition - - nulco [nullary [false]] dip branch - -### Derivation - TODO: this is derived in one of the notebooks I think, look it up and link to it, or copy the content here. -### Discussion - -This is seldom useful, I suspect, but this way you have it. - ### Crosslinks -[||](#section-25) - - --------------- - -## & - -See [and](#and). - +[or](#or) ------------------------------------------------------------------------ @@ -85,27 +65,26 @@ predicate `P`. The `range` function generates a list of the integers from 0 to n - 1: -> \[0 <=\] \[\-\- dup\] anamorphism + [0 <=] [-- dup] anamorphism -### Discussion +> joy? 5 +> +> 5 +> +> joy? [0 <=] [-- dup] +> +> 5 [0 <=] [-- dup] +> +> joy? anamorphism +> +> [4 3 2 1 0] +Note that the last value generated (0) is at the bottom of the list. See the [Recursion Combinators notebook](https://joypy.osdn.io/notebooks/Recursion_Combinators.html). ------------------------------------------------------------------------ -## and - -Logical bit-wise AND. - -### Crosslinks - -[or](#or) -[xor](#xor) - - --------------------- - ## app1 "apply one" @@ -113,7 +92,7 @@ Logical bit-wise AND. Combinator Given a quoted program on TOS and anything as the second stack item run -the program without disturbing the stack and replace the two args with +the program without disturbing the rest of the stack and replace the two args with the first result of the program. ... x [Q] app1 @@ -1958,12 +1937,12 @@ Take the item on the top of the stack and [cons] it onto `[nullary]`. ### Discussion -Helper function for [\|\|] and [&&]. +Helper function for [or] and [and]. ### Crosslinks -[&&] -[||] +[and] +[or] -------------------- @@ -3319,7 +3298,7 @@ stack.) ### Crosslinks -[&&](#section-1) +[and] ------------------------------------------------------------------------ diff --git a/docs/reference/to_html.py b/docs/reference/to_html.py index 17efb09..10905db 100644 --- a/docs/reference/to_html.py +++ b/docs/reference/to_html.py @@ -44,44 +44,32 @@ for el in used_by.values(): el.sort() -def def_format(to, name): - try: - defi = definitions[name] - except KeyError: - return - to = to.div(class_='definition') - to.h3('Definition') - to = to.blockquote - start = 0 - for match in re.finditer('[^ [\]]+', defi): - b, e = match.span() - if b != start: - to += defi[start:b] - foo = match.group() - anchor = anchors.get(foo, '') - to.a(foo, href='#' + anchor) - start = e - end = defi[start:] - if end: - to += end - - -def foo(to, text): +def foo(to, text, class_='notes'): html = markdown.markdown(text, output_format="html5") - html = '
' + html + '
' + html = f'
{html}
' try: t = ET.fromstringlist([html]) except: - print(repr(html)) - raise + #######################print(repr(html)) + #raise + t = text to += t basis_functions = set('''\ i dip branch loop cons first rest stack swaack -dup swap pop clear'''.split()) +dup swap pop clear +add sub mul div rem remainder ++ - * / % +concat +truthy +inscribe +< > >= <= != <> = +gt lt ge le neq eq +<< >> +lshift rshift'''.split()) k = re.split('^-+$', md, flags=re.MULTILINE) #k = md.split('------------------------------------------------------------------------\n') @@ -105,7 +93,7 @@ def anchor_for(name): anchors = {} sections = {} -for i, section in enumerate(k): +for section in k: for line in section: if line.startswith('## '): name = line[3:].strip() @@ -141,6 +129,38 @@ for name, section in sections.items(): del section[i:] +def add_definition(to, name): + try: + defi = definitions[name] + except KeyError: + return + to = to.div(class_='definition_wrapper') + to.h3('Definition') + to = to.div(class_='definition') + start = 0 + for match in re.finditer('[^ [\]]+', defi): + b, e = match.span() + if b != start: + to += defi[start:b] + foo = match.group() + if foo.isnumeric() or foo == 'true' or foo == 'false': + to += foo + else: + to.a(foo, href='#' + get_anchor(foo)) + start = e + end = defi[start:] + if end: + to += end + + +non = set() +def get_anchor(name): + if name in anchors: + return anchors[name] + non.add(name) + return '' + + def add_crosslinks(to, name): try: links = crosslinks[name] @@ -168,9 +188,9 @@ def add_discussion(to, name): discussion = discussions[name] except KeyError: return - to = to.div(class_='discussion') + to = to.div(class_='discussion_wrapper') to.h3('Discussion') - to += ('\n'.join(discussion)) + foo(to, '\n'.join(discussion), class_='discussion') def add_backlinks(to, name): @@ -188,7 +208,7 @@ def add_backlinks(to, name): first = not first else: to += ' ' - anchor = anchors.get(link_to, '') + anchor = get_anchor(link_to) to.a(link_to, href='#' + anchor, class_='func_name') @@ -197,7 +217,7 @@ doc = HTML() with doc.head as h: h.meta(charset='utf-8') h.title(TITLE) - h.link(rel='stylesheet', href='/css/fonts.css') + h.link(rel='stylesheet', href='/css/font/fonts.css') h.link(rel='stylesheet', href='/css/func_ref.css') with doc.body as b: @@ -226,7 +246,7 @@ with doc.body as b: foo(d, '\n'.join(section)) - def_format(d, name) + add_definition(d, name) add_discussion(d, name) add_crosslinks(d, name) add_backlinks(d, name) @@ -239,3 +259,7 @@ print(html_string, file=open('../html/FuncRef.html', 'w')) ##import pprint ##pprint.pprint(crosslinks) + +if non: + for n in sorted(non): + print(n)