on master help sign in
various standard library doc fixes
commit6d6967d5b28589cc2ae12aabac94870ea55b1641 authorJohn Franklin <jfranklin9000@gmail.com> dateThu 7 Mar 2019, 04:08 (8 years ago) parentf1817cd
8 files changed+66−66
reference/library/1b.udon+1−1 reference/library/2n.udon+1−1 reference/library/3a.udon+6−6 reference/library/3b.udon+40−40 reference/library/3d.udon+15−15 reference/library/4c.udon+1−1 reference/library/4d.udon+1−1 reference/library/4g.udon+1−1
reference/library/1b.udon+1−1
@@ -10,7 +10,7 @@
1010Check out the Nock [explanation](/docs/nock/explanation/) for more
1111information on the tree-addressing system.
1212
13−### `++cap`(#anchors-in-markdown))
13+### `++cap`
1414
1515Tree head
1616
reference/library/2n.udon+1−1
@@ -98,7 +98,7 @@ A gate.
9898#### Examples
9999
100100```
101− > =tep (cury scan sym)
101+ > =tep (curr scan sym)
102102 > `@t`(tep "asd")
103103 'asd'
104104
reference/library/3a.udon+6−6
@@ -534,7 +534,7 @@ A signed atom.
534534```
535535
536536---
537−### `++new`
537+### `++new:si`
538538
539539Atom to @s
540540
@@ -608,7 +608,7 @@ A cell composed of a `term` and an atom.
608608```
609609
610610---
611−### `++pro`
611+### `++pro:si`
612612
613613Multiplication
614614
@@ -746,20 +746,20 @@ An atom.
746746#### Examples
747747
748748```
749− > (mul 2 90)
749+ > (sun:si 90)
750750 180
751751
752− > (mul 2 --90)
752+ > (sun:si --90)
753753 360
754754 > `@u`--90
755755 180
756756
757− > (mul 2 --89)
757+ > (sun:si --89)
758758 356
759759 > `@u`--89
760760 178
761761
762− > (mul 2 -89)
762+ > (sun:si -89)
763763 354
764764 > `@u`-89
765765 177
reference/library/3b.udon+40−40
@@ -1065,7 +1065,7 @@ The default value of `d` is `%d`.
10651065```
10661066
10671067---
1068−### `++emn:si`
1068+### `++emn:fl`
10691069
10701070Minimum exponent
10711071
@@ -2079,7 +2079,7 @@ A `unit` of @s.
20792079```
20802080
20812081---
2082−### `+ff`
2082+### `++ff`
20832083
20842084IEEE-754 Formatting
20852085
@@ -2110,7 +2110,7 @@ Container core for IEEE-754 formatting operations.
21102110---
21112111#### Discussion
21122112
2113−`+ff` has no use outside of the functionality provided to other cores: `++rd`,
2113+`++ff` has no use outside of the functionality provided to other cores: `++rd`,
21142114`++rs`, `++rq`, and `++rh`. It's not intended to be used directly; it's just
21152115meant to power those cores.
21162116
@@ -2187,7 +2187,7 @@ configuration of the `ff` core.
21872187internal use in other cores.
21882188
21892189---
2190−### `++sea`
2190+### `++sea:ff`
21912191
21922192`@r` to `fn`
21932193
@@ -2325,7 +2325,7 @@ A `flag`.
23252325```
23262326
23272327---
2328−### `++exp`
2328+### `++exp:ff`
23292329
23302330Get exponent
23312331
@@ -2355,7 +2355,7 @@ A signed integer.
23552355```
23562356
23572357---
2358−### `++add`
2358+### `++add:ff`
23592359
23602360Add
23612361
@@ -2419,7 +2419,7 @@ A `@r`, an IEEE float.
24192419```
24202420
24212421---
2422−### `mul:ff`
2422+### `++mul:ff`
24232423
24242424Multiply
24252425
@@ -2616,7 +2616,7 @@ A `flag`.
26162616```
26172617
26182618---
2619−### `equ:ff`
2619+### `++equ:ff`
26202620
26212621Equals
26222622
@@ -2867,7 +2867,7 @@ A `@r`, an IEEE float.
28672867```
28682868
28692869---
2870−### `rlyd`
2870+### `++rlyd`
28712871
28722872Prep `@rd` for print
28732873
@@ -3143,7 +3143,7 @@ configuration of the `rd` core.
31433143```
31443144
31453145---
3146−### `sea:rd`
3146+### `++sea:rd`
31473147
31483148`@rd` to `fn`
31493149
@@ -3162,7 +3162,7 @@ Converts `a` from a double-precision binary float to `fn`.
31623162```
31633163
31643164---
3165−### `bit:rd`
3165+### `++bit:rd`
31663166
31673167`fn` to `@rd`
31683168
@@ -3191,7 +3191,7 @@ A `@rd`, a double-precision float.
31913191```
31923192
31933193---
3194−### `add:rd`
3194+### `++add:rd`
31953195
31963196Add
31973197
@@ -3224,7 +3224,7 @@ A `@rd`.
32243224```
32253225
32263226---
3227−### `sub:rd`
3227+### `++sub:rd`
32283228
32293229Subtract
32303230
@@ -3257,7 +3257,7 @@ A `@rd`.
32573257```
32583258
32593259---
3260−### `sub:rd`
3260+### `++mul:rd`
32613261
32623262Multiply
32633263
@@ -3290,7 +3290,7 @@ A `@rd`.
32903290```
32913291
32923292---
3293−### `div:rd`
3293+### `++div:rd`
32943294
32953295Divide
32963296
@@ -3362,7 +3362,7 @@ A `@rd`.
33623362```
33633363
33643364---
3365−### `+sqt:fr`
3365+### `++sqt:rd`
33663366
33673367Square root
33683368
@@ -3392,7 +3392,7 @@ A `@rd`.
33923392```
33933393
33943394---
3395−### `lth:rd`
3395+### `++lth:rd`
33963396
33973397Less than
33983398
@@ -3470,7 +3470,7 @@ A `@rd`.
34703470```
34713471
34723472---
3473−### `equ:rd`
3473+### `++equ:rd`
34743474
34753475Equals
34763476
@@ -3576,14 +3576,14 @@ A `@rd`.
35763576#### Examples
35773577
35783578```
3579− > (gte:rd .~7.94099e2 .~1.2246e3)
3579+ > (gth:rd .~7.94099e2 .~1.2246e3)
35803580 %.n
35813581
3582− > (gte:rd .~7.94099e2 .~1.2246e2)
3582+ > (gth:rd .~7.94099e2 .~1.2246e2)
35833583 %.y
35843584
3585− > (gte:rd .~1.2246e2 .~1.2246e2)
3586− %.y
3585+ > (gth:rd .~1.2246e2 .~1.2246e2)
3586+ %.n
35873587```
35883588
35893589---
@@ -3671,7 +3671,7 @@ A `flag`.
36713671```
36723672
36733673---
3674−### `exp:rd`
3674+### `++exp:rd`
36753675
36763676Get exponent
36773677
@@ -3804,7 +3804,7 @@ down (`$d`), and round to zero (`$z`).
38043804```
38053805
38063806---
3807−### `ma:rs`
3807+### `++ma:rs`
38083808
38093809Initialize `ff`
38103810
@@ -3828,7 +3828,7 @@ configuration of the `rs` core.
38283828```
38293829
38303830---
3831−### `sea:rs`
3831+### `++sea:rs`
38323832
38333833`@rs` to `fn`
38343834
@@ -3857,7 +3857,7 @@ An `fn`.
38573857```
38583858
38593859---
3860−### `bit:rs`
3860+### `++bit:rs`
38613861
38623862`fn` to `@rs`
38633863
@@ -4075,7 +4075,7 @@ A `@rs`.
40754075```
40764076
40774077---
4078−### `lth:rs`
4078+### `++lth:rs`
40794079
40804080Less than
40814081
@@ -4147,7 +4147,7 @@ A `@rs`.
41474147```
41484148
41494149---
4150−### `equ:rs`
4150+### `++equ:rs`
41514151
41524152Equals
41534153
@@ -4344,7 +4344,7 @@ A `flag`.
43444344```
43454345
43464346---
4347−### `exp:rs`
4347+### `++exp:rs`
43484348
43494349Get exponent
43504350
@@ -4651,7 +4651,7 @@ A `@rq`.
46514651```
46524652
46534653---
4654−### `div:rq`
4654+### `++div:rq`
46554655
46564656Divide
46574657
@@ -4684,7 +4684,7 @@ A `@rq`.
46844684```
46854685
46864686---
4687−### `fma:rq`
4687+### `++fma:rq`
46884688
46894689Fused multiply-add
46904690
@@ -4720,7 +4720,7 @@ A `@rq`.
47204720```
47214721
47224722---
4723−#### Source
4723+### `++sqt:rq`
47244724
47254725Square root
47264726
@@ -4788,7 +4788,7 @@ A `@rq`.
47884788```
47894789
47904790---
4791−### `lte:rq`
4791+### `++lte:rq`
47924792
47934793Less than or equal
47944794
@@ -5337,7 +5337,7 @@ A `@rh`.
53375337```
53385338
53395339---
5340−### `div:rh`
5340+### `++div:rh`
53415341
53425342Divide
53435343
@@ -5370,7 +5370,7 @@ A `@rh`.
53705370```
53715371
53725372---
5373−### `fma:rh`
5373+### `++fma:rh`
53745374
53755375Fused multiply-add
53765376
@@ -5406,7 +5406,7 @@ A `@rh`.
54065406```
54075407
54085408---
5409−#### Source
5409+### `++sqt:rh`
54105410
54115411Square root
54125412
@@ -5473,7 +5473,7 @@ A `@rh`.
54735473```
54745474
54755475---
5476−### `lte:rh`
5476+### `++lte:rh`
54775477
54785478Less than or equal
54795479
@@ -5501,10 +5501,10 @@ A `@rh`.
55015501#### Examples
55025502
55035503```
5504− > (lth:rh .~~1.2e5 (mul:rh .~~9.02e2 .~~7.114e2))
5504+ > (lte:rh .~~1.2e5 (mul:rh .~~9.02e2 .~~7.114e2))
55055505 %.n
55065506
5507− > (lth:rh .~~1.2e3 (mul:rh .~~9.02e1 .~~7.114e2))
5507+ > (lte:rh .~~1.2e3 (mul:rh .~~9.02e1 .~~7.114e2))
55085508 %.y
55095509
55105510 > (lte:rh .~~1.2e3 .~~1.2e3)
@@ -5736,7 +5736,7 @@ A `@s`, a signed integer.
57365736```
57375737
57385738---
5739−### `toi:rh`
5739+### `++toi:rh`
57405740
57415741Round to integer
57425742
reference/library/3d.udon+15−15
@@ -36,7 +36,7 @@ An atom.
3636 718.295.626.625.655.417.234
3737```
3838
39−***
39+---
4040### `++shaf`
4141
4242Half SHA-256
@@ -71,7 +71,7 @@ first and last halves of the 256-bit salted hash `shas`.
7171 \/
7272```
7373
74−***
74+---
7575### `++shal`
7676
7777SHA-512 with length
@@ -227,7 +227,7 @@ Because byte-strings can have leading zeros, but atoms cannot, we use `len`
227227as a way of saying that the atom `ruz` is shorter than its representative
228228byte-string.
229229
230−***
230+---
231231### `++sham`
232232
233233128-bit noun hash
@@ -265,7 +265,7 @@ An atom.
265265 0v1.hg8mv.t7s3f.u4f8a.q5noe.dvqvh
266266```
267267
268−***
268+---
269269### `++shan`
270270
271271SHA-1
@@ -361,7 +361,7 @@ An atom.
361361
362362SHA-1 is a deprecated function; it is not considered secure.
363363
364−***
364+---
365365### `++shas`
366366
367367Salted hash
@@ -393,7 +393,7 @@ of that logical operation is then itself hashed with SHA-256.
393393 \/
394394```
395395
396−***
396+---
397397### `++shaw`
398398
399399Hash to nbits
@@ -431,7 +431,7 @@ An atom.
431431 0b11
432432```
433433
434−***
434+---
435435### `++shax`
436436
437437SHA-256
@@ -456,7 +456,7 @@ Produces an atom by hashing an atom `ruz` with SHA-256.
456456 \/
457457```
458458
459−***
459+---
460460### `++shay`
461461
462462SHA-256 with length
@@ -580,7 +580,7 @@ Because byte-strings can have leading zeros, but atoms cannot, we use `len`
580580as a way of saying that the atom `ruz` is shorter than its representative
581581byte-string.
582582
583−***
583+---
584584### `++shaz`
585585
586586SHA-512
@@ -613,7 +613,7 @@ An atom.
613613 \/
614614```
615615
616−***
616+---
617617### `++og`
618618
619619Container arm for SHA-256-powered random-number generation. Its sample `a` is an
@@ -648,7 +648,7 @@ Note that the product is deterministic; the seed will produce the same
648648result every time it is run. Use `eny`, 256 bits of entropy, for a
649649non-deterministic product.
650650
651−***
651+---
652652### `++rad`
653653
654654Random in range
@@ -689,7 +689,7 @@ An atom.
689689 7
690690```
691691
692−***
692+---
693693### `++rads`
694694
695695Random continuation
@@ -734,7 +734,7 @@ Since everything in Hoon is a pure function, we need to use tricks like this to
734734generate separate random values from the same seed. Notice how we jump from
735735one `rads` function call to another in the above example.
736736
737−***
737+---
738738### `++raw`
739739
740740Random bits
@@ -783,7 +783,7 @@ An atom.
783783 0b100
784784```
785785
786−***
786+---
787787### `++raws`
788788
789789Random bits continuation
@@ -821,4 +821,4 @@ Since everything in Hoon is a pure function, we need to use tricks like this to
821821generate separate random values from the same seed. Notice how we jump from
822822one `raws` function call to another in the above example.
823823
824−***
824+---
reference/library/4c.udon+1−1
@@ -364,4 +364,4 @@ XX document
364364
365365
366366
367−***
367+---
reference/library/4d.udon+1−1
@@ -101,4 +101,4 @@ A hair.
101101 [2 6]
102102```
103103
104−***
104+---
reference/library/4g.udon+1−1
@@ -57,7 +57,7 @@ The value of the parse result, or crash.
5757
5858Parse or null
5959
60−Parse a given with a given rule and produce null if the cord isn't
60+Parse an atom with a given rule and produce null if the cord isn't
6161entirely parsed.
6262
6363#### Accepts