From 4821f231a00dc93c42fb437359ea657c59c63053 Mon Sep 17 00:00:00 2001 From: Marshall Lochbaum Date: Thu, 27 Jan 2022 22:45:08 -0500 Subject: Add full documentation links to help pages --- help/2-modifierrightoperand.md | 1 + help/absolutevalue_modulus.md | 2 ++ help/assert_assertwithmessage.md | 2 ++ help/beginblock.md | 1 + help/beginlist.md | 1 + help/ceiling_maximum.md | 2 ++ help/change.md | 1 + help/classify_indexof.md | 2 ++ help/comment.md | 1 + help/conjugate_add.md | 2 ++ help/currentfunction.md | 1 + help/currentmodifier.md | 1 + help/deduplicate_find.md | 2 ++ help/define.md | 1 + help/depth.md | 1 + help/depth_match.md | 2 ++ help/deshape_reshape.md | 2 ++ help/each.md | 1 + help/enclose_lessthan.md | 2 ++ help/endblock.md | 1 + help/endlist.md | 1 + help/enlist_pair.md | 2 ++ help/exponential_power.md | 2 ++ help/export.md | 2 ++ help/first_pick.md | 2 ++ help/firstcell_select.md | 2 ++ help/floor_minimum.md | 2 ++ help/fold.md | 2 ++ help/gradedown_binsdown.md | 2 ++ help/gradeup_binsup.md | 2 ++ help/greaterthanorequalto.md | 1 + help/groupindices_group.md | 2 ++ help/identity_left.md | 2 ++ help/identity_right.md | 2 ++ help/indices_replicate.md | 2 ++ help/infinity.md | 1 + help/insert.md | 2 ++ help/join_jointo.md | 2 ++ help/leftargument.md | 1 + help/length_notequals.md | 2 ++ help/lessthanorequalto.md | 1 + help/markfirst_memberof.md | 2 ++ help/merge_greaterthan.md | 2 ++ help/minus.md | 1 + help/modifierleftoperand.md | 1 + help/negate_subtract.md | 2 ++ help/not_span.md | 2 ++ help/nothing.md | 1 + help/nullcharacter.md | 1 + help/occurrencecount_progressiveindexof.md | 2 ++ help/pi.md | 1 + help/prefixes_take.md | 2 ++ help/range_windows.md | 2 ++ help/rank_equals.md | 2 ++ help/reciprocal_divide.md | 2 ++ help/repeat.md | 1 + help/reverse_rotate.md | 2 ++ help/rightargument.md | 1 + help/scan.md | 1 + help/separator.md | 1 + help/shape_notmatch.md | 2 ++ help/shiftafter.md | 2 ++ help/shiftbefore.md | 2 ++ help/sign_multiply.md | 2 ++ help/solo_couple.md | 2 ++ help/sortdown_or.md | 2 ++ help/sortup_and.md | 2 ++ help/squareroot_root.md | 2 ++ help/strand.md | 1 + help/suffixes_drop.md | 2 ++ help/table.md | 1 + help/transpose_reorderaxes.md | 2 ++ help/undo.md | 1 + 73 files changed, 118 insertions(+) (limited to 'help') diff --git a/help/2-modifierrightoperand.md b/help/2-modifierrightoperand.md index 1cdff64f..ccf28228 100644 --- a/help/2-modifierrightoperand.md +++ b/help/2-modifierrightoperand.md @@ -3,6 +3,7 @@ # Mathematical Double-struck G (`๐”พ`) ## `๐”พ`: 2-Modifier Right operand +[โ†’full documentation](../doc/syntax.md#blocks) A variable assigned to the right operand of a 2-modifier block. `๐•˜` can be used to access the right operand as a subject. diff --git a/help/absolutevalue_modulus.md b/help/absolutevalue_modulus.md index fb0011a0..5efea46b 100644 --- a/help/absolutevalue_modulus.md +++ b/help/absolutevalue_modulus.md @@ -3,6 +3,7 @@ # Pipe (`|`) ## `| ๐•ฉ`: Absolute Value +[โ†’full documentation](../doc/arithmetic.md#additional-arithmetic) Absolute Value of `๐•ฉ`. @@ -15,6 +16,7 @@ Absolute Value of `๐•ฉ`. ## `๐•จ | ๐•ฉ`: Modulus +[โ†’full documentation](../doc/arithmetic.md#additional-arithmetic) Remainder of `๐•ฉ` divided by `๐•จ`. diff --git a/help/assert_assertwithmessage.md b/help/assert_assertwithmessage.md index 2a027b5f..37e7f4ba 100644 --- a/help/assert_assertwithmessage.md +++ b/help/assert_assertwithmessage.md @@ -3,6 +3,7 @@ # Exclamation Mark (`!`) ## `! ๐•ฉ`: Assert +[โ†’full documentation](../doc/assert.md) Throw an error if `๐•ฉ` is not 1. @@ -16,6 +17,7 @@ Throw an error if `๐•ฉ` is not 1. ## `๐•จ ! ๐•ฉ`: Assert With Message +[โ†’full documentation](../doc/assert.md) Throw an error with message `๐•จ` if `๐•ฉ` is not 1. diff --git a/help/beginblock.md b/help/beginblock.md index 32456c45..2c61355a 100644 --- a/help/beginblock.md +++ b/help/beginblock.md @@ -3,6 +3,7 @@ # Left Curly Bracket (`{`) ## `{ ...`: Begin Block +[โ†’full documentation](../doc/syntax.md#blocks) Starts a block, which can be one of: diff --git a/help/beginlist.md b/help/beginlist.md index 9b16c69f..c1dee17b 100644 --- a/help/beginlist.md +++ b/help/beginlist.md @@ -3,6 +3,7 @@ # Mathematical Left Angle Bracket (`โŸจ`) ## `โŸจ ...`: Begin list +[โ†’full documentation](../doc/syntax.md#list-notation) Starts a list. Inner elements must be separated by `,` or `โ‹„`. Lists can be nested in other lists. diff --git a/help/ceiling_maximum.md b/help/ceiling_maximum.md index 70600211..a3b2c771 100644 --- a/help/ceiling_maximum.md +++ b/help/ceiling_maximum.md @@ -3,6 +3,7 @@ # Left Ceiling (`โŒˆ`) ## `โŒˆ ๐•ฉ`: Ceiling +[โ†’full documentation](../doc/arithmetic.md#additional-arithmetic) Round `๐•ฉ` up to the nearest integer. @@ -13,6 +14,7 @@ Round `๐•ฉ` up to the nearest integer. ## `๐•จ โŒˆ ๐•ฉ`: Maximum +[โ†’full documentation](../doc/arithmetic.md#additional-arithmetic) Maximum of `๐•จ` and `๐•ฉ`. diff --git a/help/change.md b/help/change.md index 17901f3c..f5085d46 100644 --- a/help/change.md +++ b/help/change.md @@ -3,6 +3,7 @@ # Leftwards Arrow With Hook (`โ†ฉ`) ## `n โ†ฉ v`: Change +[โ†’full documentation](../doc/expression.md#assignment) Changes the value of variable with name `n` to value `v`. diff --git a/help/classify_indexof.md b/help/classify_indexof.md index f453b326..f6412053 100644 --- a/help/classify_indexof.md +++ b/help/classify_indexof.md @@ -3,6 +3,7 @@ # Square Original Of (`โŠ`) ## `โŠ ๐•ฉ`: Classify +[โ†’full documentation](../doc/selfcmp.md#classify) Translate major cells of `๐•ฉ` to unique ID numbers based on first occurrence. @@ -15,6 +16,7 @@ Translate major cells of `๐•ฉ` to unique ID numbers based on first occurrence. ## `๐•จ โŠ ๐•ฉ`: Index Of +[โ†’full documentation](../doc/search.md#index-of) First index of each major cell of `๐•ฉ` in `๐•จ`. Rank of `๐•ฉ` must be at least cell rank of `๐•จ`. diff --git a/help/comment.md b/help/comment.md index e4002008..9e966a50 100644 --- a/help/comment.md +++ b/help/comment.md @@ -3,6 +3,7 @@ # Number Sign (`#`) ## `#`: Comment +[โ†’full documentation](../doc/syntax.md#comments) Create a comment that extends to the end of the line. diff --git a/help/conjugate_add.md b/help/conjugate_add.md index 9c95db32..7227562e 100644 --- a/help/conjugate_add.md +++ b/help/conjugate_add.md @@ -3,6 +3,7 @@ # Plus (`+`) ## `+ ๐•ฉ`: Conjugate +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) Complex conjugate of `๐•ฉ`. BQN doesn't support complex numbers yet, so it has no effect. @@ -12,6 +13,7 @@ Complex conjugate of `๐•ฉ`. BQN doesn't support complex numbers yet, so it has ## `๐•จ + ๐•ฉ`: Add +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) `๐•จ` added to `๐•ฉ`. Either `๐•จ` or `๐•ฉ` can be a character, and if so, the other has to be an integer. diff --git a/help/currentfunction.md b/help/currentfunction.md index a47150d7..26746577 100644 --- a/help/currentfunction.md +++ b/help/currentfunction.md @@ -3,6 +3,7 @@ # Mathematical Double-struck S (`๐•Š`) ## `๐•Š`: Current Function +[โ†’full documentation](../doc/syntax.md#blocks) A variable assigned to the current function block. `๐•ค` accesses the same value but has a subject role. diff --git a/help/currentmodifier.md b/help/currentmodifier.md index 50d2f12d..ed144afa 100644 --- a/help/currentmodifier.md +++ b/help/currentmodifier.md @@ -3,6 +3,7 @@ # Mathematical Double-struck R (`๐•ฃ`) ## `๐•ฃ`: Current Modifier +[โ†’full documentation](../doc/syntax.md#blocks) A variable assigned to the current modifier block. Add underscores to the beginning and/or end (`_๐•ฃ`, `_๐•ฃ_`) to use it in a modifier role. diff --git a/help/deduplicate_find.md b/help/deduplicate_find.md index aa1ce601..bb8b4e57 100644 --- a/help/deduplicate_find.md +++ b/help/deduplicate_find.md @@ -3,6 +3,7 @@ # Epsilon Underbar (`โท`) ## `โท ๐•ฉ`: Deduplicate +[โ†’full documentation](../doc/selfcmp.md#deduplicate) Unique major cells of `๐•ฉ`. @@ -15,6 +16,7 @@ Unique major cells of `๐•ฉ`. ## `๐•จ โท ๐•ฉ`: Find +[โ†’full documentation](../doc/find.md) Mark the top left location of the occurrences of `๐•จ` in `๐•ฉ` with a 1, and other locations with 0. diff --git a/help/define.md b/help/define.md index eb9af748..cfaddeec 100644 --- a/help/define.md +++ b/help/define.md @@ -3,6 +3,7 @@ # Leftwards Arrow (`โ†`) ## `n โ† v`: Define +[โ†’full documentation](../doc/expression.md#assignment) Defines a new variable with name `n` and value `v`. diff --git a/help/depth.md b/help/depth.md index a891d193..8c0d4367 100644 --- a/help/depth.md +++ b/help/depth.md @@ -3,6 +3,7 @@ # Circle With Two Dots (`โš‡`) ## `๐”ฝโš‡๐•˜ ๐•ฉ`, `๐•จ ๐”ฝโš‡๐•˜ ๐•ฉ`: Depth +[โ†’full documentation](../doc/depth.md#the-depth-modifier) Apply `๐”ฝ` to the cells of the arguments at depth given in `๐•˜`. diff --git a/help/depth_match.md b/help/depth_match.md index fc823662..fbbc1fcb 100644 --- a/help/depth_match.md +++ b/help/depth_match.md @@ -3,6 +3,7 @@ # Identical To (`โ‰ก`) ## `โ‰ก ๐•ฉ`: Depth +[โ†’full documentation](../doc/depth.md) Highest level of nesting in `๐•ฉ`. @@ -15,6 +16,7 @@ Highest level of nesting in `๐•ฉ`. ## `๐•จ โ‰ก ๐•ฉ`: Match +[โ†’full documentation](../doc/match.md) Does `๐•จ` exactly match `๐•ฉ`? diff --git a/help/deshape_reshape.md b/help/deshape_reshape.md index 01ba9330..2d57ea43 100644 --- a/help/deshape_reshape.md +++ b/help/deshape_reshape.md @@ -3,6 +3,7 @@ # Barb (`โฅŠ`) ## `โฅŠ ๐•ฉ`: Deshape +[โ†’full documentation](../doc/reshape.md) Put all elements of `๐•ฉ` in a rank 1 array, promoting to an array if necessary. @@ -13,6 +14,7 @@ Put all elements of `๐•ฉ` in a rank 1 array, promoting to an array if necessary ## `๐•จ โฅŠ ๐•ฉ`: Reshape +[โ†’full documentation](../doc/reshape.md) Put all elements of `๐•ฉ` in an array of shape `๐•จ`, removing elements or repeating them cyclically if necessary. diff --git a/help/each.md b/help/each.md index 2b079930..b9ec2c1b 100644 --- a/help/each.md +++ b/help/each.md @@ -3,6 +3,7 @@ # Diaresis (`ยจ`) ## `๐”ฝยจ ๐•ฉ`, `๐•จ ๐”ฝยจ ๐•ฉ`: Each +[โ†’full documentation](../doc/map.md) Apply `๐”ฝ` to/between the elements of the arguments. (`๐”ฝโš‡ยฏ1`) diff --git a/help/enclose_lessthan.md b/help/enclose_lessthan.md index 8f8da581..a622404f 100644 --- a/help/enclose_lessthan.md +++ b/help/enclose_lessthan.md @@ -3,6 +3,7 @@ # Lesser Than (`<`) ## `< ๐•ฉ`: Enclose +[โ†’full documentation](../doc/enclose.md) Create a unit array containing `๐•ฉ`. (`(โ‰ข<๐•ฉ) โ‰ก โŸจโŸฉ`) @@ -15,6 +16,7 @@ Create a unit array containing `๐•ฉ`. (`(โ‰ข<๐•ฉ) โ‰ก โŸจโŸฉ`) ## `๐•จ < ๐•ฉ`: Lesser Than +[โ†’full documentation](../doc/arithmetic.md#comparisons) `๐•จ` and `๐•ฉ` can both be either numbers or characters. diff --git a/help/endblock.md b/help/endblock.md index ed3b6e3a..b6ae5235 100644 --- a/help/endblock.md +++ b/help/endblock.md @@ -3,6 +3,7 @@ # Right Curly Bracket (`}`) ## `... }`: End Block +[โ†’full documentation](../doc/syntax.md#blocks) Starts a block, which starts with `}`. See [Begin Block](beginblock.md) for more details. diff --git a/help/endlist.md b/help/endlist.md index 0e76b84f..234690aa 100644 --- a/help/endlist.md +++ b/help/endlist.md @@ -3,6 +3,7 @@ # Mathematical Right Angle Bracket (`โŸฉ`) ## `... โŸฉ`: End list +[โ†’full documentation](../doc/syntax.md#list-notation) Ends a list started by a `โŸจ`. See [Begin List](beginlist.md) for more details. diff --git a/help/enlist_pair.md b/help/enlist_pair.md index 7cd76533..baaa68a0 100644 --- a/help/enlist_pair.md +++ b/help/enlist_pair.md @@ -3,6 +3,7 @@ # Bow Tie (`โ‹ˆ`) ## `โ‹ˆ ๐•ฉ`: Enlist +[โ†’full documentation](../doc/pair.md) Put `๐•ฉ` in a single element list. (`โŸจ๐•ฉโŸฉ`) @@ -13,6 +14,7 @@ Put `๐•ฉ` in a single element list. (`โŸจ๐•ฉโŸฉ`) ## `๐•จ โ‹ˆ ๐•ฉ`: Pair +[โ†’full documentation](../doc/pair.md) Put `๐•จ` and `๐•ฉ` in a two element list. (`โŸจ๐•จ, ๐•ฉโŸฉ`) diff --git a/help/exponential_power.md b/help/exponential_power.md index 990d7122..d829e638 100644 --- a/help/exponential_power.md +++ b/help/exponential_power.md @@ -3,6 +3,7 @@ # Star (`โ‹†`) ## `โ‹† ๐•ฉ`: Exponential +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) `e` (Euler's constant) to the power of `๐•ฉ`. @@ -13,6 +14,7 @@ ## `๐•จ โ‹† ๐•ฉ`: Power +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) `๐•จ` to the power of `๐•ฉ`. diff --git a/help/export.md b/help/export.md index 3ae604be..6b71fdb0 100644 --- a/help/export.md +++ b/help/export.md @@ -3,6 +3,7 @@ # Leftward Double Arrow (`โ‡`) ## `n โ‡ v`: Export Definition +[โ†’full documentation](../doc/expression.md#exports) Define a variable with name `n` and export it from the current namespace. @@ -11,6 +12,7 @@ Define a variable with name `n` and export it from the current namespace. ns.unexported ## `๐•จ โ‡`: Export names +[โ†’full documentation](../doc/expression.md#exports) Export the names given in `๐•ฉ` from the current namespace. Names must be defined somewhere in the scope. diff --git a/help/first_pick.md b/help/first_pick.md index deb09cc3..6824accb 100644 --- a/help/first_pick.md +++ b/help/first_pick.md @@ -3,6 +3,7 @@ # Square Image Of Or Equal To (`โŠ‘`) ## `โŠ‘ ๐•ฉ`: First +[โ†’full documentation](../doc/pick.md#first) First element of `๐•ฉ`. @@ -15,6 +16,7 @@ First element of `๐•ฉ`. ## `๐•จ โŠ‘ ๐•ฉ`: Pick +[โ†’full documentation](../doc/pick.md) Pick the element of `๐•จ` at index `๐•ฉ`. diff --git a/help/firstcell_select.md b/help/firstcell_select.md index 016f2ef9..d4ee2354 100644 --- a/help/firstcell_select.md +++ b/help/firstcell_select.md @@ -3,6 +3,7 @@ # Square Image Of (`โŠ`) ## `โŠ ๐•ฉ`: First Cell +[โ†’full documentation](../doc/select.md) First major cell of `๐•ฉ`. @@ -15,6 +16,7 @@ First major cell of `๐•ฉ`. ## `๐•จ โŠ ๐•ฉ`: Select +[โ†’full documentation](../doc/select.md) Select the major cells of `๐•จ` at the indices in `๐•ฉ`. diff --git a/help/floor_minimum.md b/help/floor_minimum.md index ff4ee621..42caaedd 100644 --- a/help/floor_minimum.md +++ b/help/floor_minimum.md @@ -3,6 +3,7 @@ # Left Floor (`โŒŠ`) ## `โŒŠ ๐•ฉ`: Floor +[โ†’full documentation](../doc/arithmetic.md#additional-arithmetic) Round `๐•ฉ` down to the nearest integer. @@ -13,6 +14,7 @@ Round `๐•ฉ` down to the nearest integer. ## `๐•จ โŒŠ ๐•ฉ`: Minimum +[โ†’full documentation](../doc/arithmetic.md#additional-arithmetic) Minimum of `๐•จ` and `๐•ฉ`. diff --git a/help/fold.md b/help/fold.md index 56b812f8..4ad93dc3 100644 --- a/help/fold.md +++ b/help/fold.md @@ -3,6 +3,7 @@ # Acute Accent (`ยด`) ## `๐”ฝยด ๐•ฉ`: Fold +[โ†’full documentation](../doc/fold.md) Fold over `๐•ฉ` with `๐”ฝ` from right to left i.e. Insert `๐”ฝ` between the elements of `๐•ฉ`. @@ -18,6 +19,7 @@ Fold over `๐•ฉ` with `๐”ฝ` from right to left i.e. Insert `๐”ฝ` between the e ## `๐•จ ๐”ฝยด ๐•ฉ`: Fold With Initial +[โ†’full documentation](../doc/fold.md#initial-element) Monadic fold, but use `๐•จ` as initial right argument. diff --git a/help/gradedown_binsdown.md b/help/gradedown_binsdown.md index c4749da9..9528079d 100644 --- a/help/gradedown_binsdown.md +++ b/help/gradedown_binsdown.md @@ -3,6 +3,7 @@ # Del Stile (`โ’`) ## `โ’ ๐•ฉ`: Grade Down +[โ†’full documentation](../doc/order.md#grade) Indices of `๐•ฉ` that would sort its major cells in descending order. @@ -15,6 +16,7 @@ Indices of `๐•ฉ` that would sort its major cells in descending order. ## `๐•จ โ’ ๐•ฉ`: Bins Down +[โ†’full documentation](../doc/order.md#bins) Binary search for each cell of `๐•ฉ` in `๐•จ`, returning the number of major cells in `๐•จ` greater than or equal to that cell. diff --git a/help/gradeup_binsup.md b/help/gradeup_binsup.md index f5c8e52a..79ac96e4 100644 --- a/help/gradeup_binsup.md +++ b/help/gradeup_binsup.md @@ -3,6 +3,7 @@ # Delta Stile (`โ‹`) ## `โ‹ ๐•ฉ`: Grade Up +[โ†’full documentation](../doc/order.md#grade) Indices of `๐•ฉ` that would sort its major cells in ascending order. @@ -16,6 +17,7 @@ Indices of `๐•ฉ` that would sort its major cells in ascending order. ## `๐•จ โ‹ ๐•ฉ`: Bins Up +[โ†’full documentation](../doc/order.md#bins) Binary search for each cell of `๐•ฉ` in `๐•จ`, returning the number of major cells in `๐•จ` less than or equal to that cell. diff --git a/help/greaterthanorequalto.md b/help/greaterthanorequalto.md index 8117209f..013c5344 100644 --- a/help/greaterthanorequalto.md +++ b/help/greaterthanorequalto.md @@ -3,6 +3,7 @@ # Greater Than or Equal To (`โ‰ฅ`) ## `๐•จ โ‰ฅ ๐•ฉ`: Greater Than or Equal To +[โ†’full documentation](../doc/arithmetic.md#comparisons) `๐•จ` and `๐•ฉ` can both be either numbers or characters. diff --git a/help/groupindices_group.md b/help/groupindices_group.md index f313bfc8..9ea99048 100644 --- a/help/groupindices_group.md +++ b/help/groupindices_group.md @@ -3,6 +3,7 @@ # Square Cup (`โŠ”`) ## `โŠ” ๐•ฉ`: Group Indices +[โ†’full documentation](../doc/group.md) Group the indices of the major cells of `๐•ฉ` by their respective values. @@ -15,6 +16,7 @@ Group the indices of the major cells of `๐•ฉ` by their respective values. ## `๐•จ โŠ” ๐•ฉ`: Group +[โ†’full documentation](../doc/group.md) Group the major cells of `๐•ฉ` by their respective indices in `๐•จ`. diff --git a/help/identity_left.md b/help/identity_left.md index 7ef2620e..9d08e4c2 100644 --- a/help/identity_left.md +++ b/help/identity_left.md @@ -3,6 +3,7 @@ # Left Tack (`โŠฃ`) ## `โŠฃ ๐•ฉ`: Identity +[โ†’full documentation](../doc/identity.md) Return `๐•ฉ`. @@ -11,6 +12,7 @@ Return `๐•ฉ`. ## `๐•จ โŠฃ ๐•ฉ`: Left +[โ†’full documentation](../doc/identity.md) Return `๐•จ`. diff --git a/help/identity_right.md b/help/identity_right.md index d81f3bc2..434d1a81 100644 --- a/help/identity_right.md +++ b/help/identity_right.md @@ -3,6 +3,7 @@ # Right Tack (`โŠข`) ## `โŠข ๐•ฉ`: Identity +[โ†’full documentation](../doc/identity.md) Return `๐•ฉ`. @@ -11,6 +12,7 @@ Return `๐•ฉ`. ## `๐•จ โŠข ๐•ฉ`: Right +[โ†’full documentation](../doc/identity.md) Return `๐•ฉ`. diff --git a/help/indices_replicate.md b/help/indices_replicate.md index 15f05a91..5a95a636 100644 --- a/help/indices_replicate.md +++ b/help/indices_replicate.md @@ -3,6 +3,7 @@ # Solidus (`/`) ## `/ ๐•ฉ`: Indices +[โ†’full documentation](../doc/replicate.md#indices) Repeat the index of each element in `๐•ฉ` by the element's value. `๐•ฉ` must be rank 1. @@ -13,6 +14,7 @@ Repeat the index of each element in `๐•ฉ` by the element's value. `๐•ฉ` must b ## `๐•จ / ๐•ฉ`: Replicate +[โ†’full documentation](../doc/replicate.md) Repeat each major cell in `๐•ฉ` by the corresponding element in `๐•จ`. diff --git a/help/infinity.md b/help/infinity.md index a3787d24..d26b4614 100644 --- a/help/infinity.md +++ b/help/infinity.md @@ -3,6 +3,7 @@ # Infinity (`โˆž`) ## `โˆž`: Infinity +[โ†’full documentation](../doc/syntax.md#constants) Mathematical constant Infinity, a numeric literal. Can be negative (`ยฏโˆž`). diff --git a/help/insert.md b/help/insert.md index 9042d43f..ea027c2f 100644 --- a/help/insert.md +++ b/help/insert.md @@ -3,6 +3,7 @@ # Double Acute Accent (`ห`) ## `๐”ฝห ๐•ฉ`: Insert +[โ†’full documentation](../doc/fold.md) Fold over cells of `๐•ฉ` with `๐”ฝ` from end to start, that is, insert `๐”ฝ` between the major cells of `๐•ฉ`. @@ -14,6 +15,7 @@ Fold over cells of `๐•ฉ` with `๐”ฝ` from end to start, that is, insert `๐”ฝ` ## `๐•จ ๐”ฝห ๐•ฉ`: Insert With Initial +[โ†’full documentation](../doc/fold.md#initial-element) Monadic insert, but use `๐•จ` as initial right argument. diff --git a/help/join_jointo.md b/help/join_jointo.md index 177f72e3..9ea34a2a 100644 --- a/help/join_jointo.md +++ b/help/join_jointo.md @@ -3,6 +3,7 @@ # Lazy S (`โˆพ`) ## `โˆพ ๐•ฉ`: Join +[โ†’full documentation](../doc/join.md) Join all elements of `๐•ฉ` together. @@ -17,6 +18,7 @@ Element ranks must be compatible. ## `๐•จ โˆพ ๐•ฉ`: Join To +[โ†’full documentation](../doc/join.md) Join `๐•จ` to `๐•ฉ` along the first axis. diff --git a/help/leftargument.md b/help/leftargument.md index 38bb6183..f8031f26 100644 --- a/help/leftargument.md +++ b/help/leftargument.md @@ -3,6 +3,7 @@ # Mathematical Double-struck W (`๐•จ`) ## `๐•จ`: Left Argument +[โ†’full documentation](../doc/syntax.md#blocks) A variable assigned to the left argument of a block. `๐•Ž` can be used to access the left argument as a function. diff --git a/help/length_notequals.md b/help/length_notequals.md index e3c5c223..5d17237c 100644 --- a/help/length_notequals.md +++ b/help/length_notequals.md @@ -3,6 +3,7 @@ # Not Equal (`โ‰ `) ## `โ‰  ๐•ฉ`: Length +[โ†’full documentation](../doc/shape.md) Length of the first dimension of `๐•ฉ`. @@ -20,6 +21,7 @@ Length of the first dimension of `๐•ฉ`. ## `๐•จ โ‰  ๐•ฉ`: Not Equal To +[โ†’full documentation](../doc/arithmetic.md#comparisons) [Pervasive.](../doc/arithmetic.md#pervasion) diff --git a/help/lessthanorequalto.md b/help/lessthanorequalto.md index 6b0986f1..9c351831 100644 --- a/help/lessthanorequalto.md +++ b/help/lessthanorequalto.md @@ -3,6 +3,7 @@ # Lesser Than or Equal To (`โ‰ค`) ## `๐•จ โ‰ค ๐•ฉ`: Lesser Than or Equal To +[โ†’full documentation](../doc/arithmetic.md#comparisons) `๐•จ` and `๐•ฉ` can both be either numbers or characters. diff --git a/help/markfirst_memberof.md b/help/markfirst_memberof.md index d86f0813..5911d89c 100644 --- a/help/markfirst_memberof.md +++ b/help/markfirst_memberof.md @@ -3,6 +3,7 @@ # Element Of (`โˆŠ`) ## `โˆŠ ๐•ฉ`: Mark Firsts +[โ†’full documentation](../doc/selfcmp.md#mark-firsts) Mark the first occurrence of each major cell in `๐•ฉ` with a 1, and all other occurrences with a 0. @@ -15,6 +16,7 @@ Mark the first occurrence of each major cell in `๐•ฉ` with a 1, and all other o ## `๐•จ โˆŠ ๐•ฉ`: Member Of +[โ†’full documentation](../doc/search.md#member-of) Is each cell in `๐•จ` a major cell of `๐•ฉ`? diff --git a/help/merge_greaterthan.md b/help/merge_greaterthan.md index 31cf3dc0..ee315fca 100644 --- a/help/merge_greaterthan.md +++ b/help/merge_greaterthan.md @@ -3,6 +3,7 @@ # Greater Than (`>`) ## `> ๐•ฉ`: Merge +[โ†’full documentation](../doc/couple.md) Add the rank of an element of `๐•ฉ` to the rank of `๐•ฉ`. @@ -23,6 +24,7 @@ Returns atomic values as is. ## `๐•จ > ๐•ฉ`: Greater Than +[โ†’full documentation](../doc/arithmetic.md#comparisons) `๐•จ` and `๐•ฉ` can both be either numbers or characters. diff --git a/help/minus.md b/help/minus.md index 6669c562..534d553b 100644 --- a/help/minus.md +++ b/help/minus.md @@ -3,6 +3,7 @@ # Macron (`ยฏ`) ## `ยฏ`: Minus +[โ†’full documentation](../doc/syntax.md#constants) Prefix before numbers to indicate that they are negative. diff --git a/help/modifierleftoperand.md b/help/modifierleftoperand.md index d517c7bf..1ae8efaf 100644 --- a/help/modifierleftoperand.md +++ b/help/modifierleftoperand.md @@ -3,6 +3,7 @@ # Mathematical Double-struck F (`๐”ฝ`) ## `๐”ฝ`: Modifier Left operand +[โ†’full documentation](../doc/syntax.md#blocks) A variable assigned to the left operand of a modifier block. `๐•—` can be used to access the left operand as a subject. diff --git a/help/negate_subtract.md b/help/negate_subtract.md index a07ff965..2b1126a9 100644 --- a/help/negate_subtract.md +++ b/help/negate_subtract.md @@ -3,6 +3,7 @@ # Minus (`-`) ## `- ๐•ฉ`: Negate +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) Additive Inverse of `๐•ฉ`. @@ -14,6 +15,7 @@ Additive Inverse of `๐•ฉ`. ## `๐•จ - ๐•ฉ`: Subtract +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) Subtract `๐•ฉ` from `๐•จ`. `๐•จ` and `๐•ฉ` can be characters or numbers. diff --git a/help/not_span.md b/help/not_span.md index 0bae4e14..d5967b57 100644 --- a/help/not_span.md +++ b/help/not_span.md @@ -3,6 +3,7 @@ # Not (`ยฌ`) ## `ยฌ ๐•ฉ`: Logical Not +[โ†’full documentation](../doc/logic.md) Logical Not of `๐•ฉ`. @@ -15,6 +16,7 @@ Logical Not of `๐•ฉ`. ## `๐•จ ยฌ ๐•ฉ`: Span +[โ†’full documentation](../doc/logic.md) Count of numbers in the inclusive range from `๐•ฉ` to `๐•จ`. diff --git a/help/nothing.md b/help/nothing.md index 17e42319..0a5ad783 100644 --- a/help/nothing.md +++ b/help/nothing.md @@ -3,6 +3,7 @@ # Middle Dot (`ยท`) ## `ยท`: Nothing +[โ†’full documentation](../doc/expression.md#nothing) ### In Trains diff --git a/help/nullcharacter.md b/help/nullcharacter.md index a8469d7d..6c0c18ab 100644 --- a/help/nullcharacter.md +++ b/help/nullcharacter.md @@ -3,6 +3,7 @@ # Commercial At (`@`) ## `@`: Null Character +[โ†’full documentation](../doc/syntax.md#constants) Null character, code point 0 in ASCII. A shortcut character literal. diff --git a/help/occurrencecount_progressiveindexof.md b/help/occurrencecount_progressiveindexof.md index 1aa8f319..77823ed0 100644 --- a/help/occurrencecount_progressiveindexof.md +++ b/help/occurrencecount_progressiveindexof.md @@ -3,6 +3,7 @@ # Square Original Of or Equal To (`โŠ’`) ## `โŠ’ ๐•ฉ`: Occurrence Count +[โ†’full documentation](../doc/selfcmp.md#occurrence-count) Number of times each major cell of `๐•ฉ` has occurred before the current position. @@ -13,6 +14,7 @@ Number of times each major cell of `๐•ฉ` has occurred before the current positi ## `๐•จ โŠ’ ๐•ฉ`: Progressive Index Of +[โ†’full documentation](../doc/search.md#progressive-index-of) Index of the first unused match of each major cell of `๐•ฉ` in `๐•จ`. If there are no more matches left, the length of `๐•จ` is placed in that position. diff --git a/help/pi.md b/help/pi.md index c979ec38..e32ff767 100644 --- a/help/pi.md +++ b/help/pi.md @@ -3,6 +3,7 @@ # Pi (`ฯ€`) ## `ฯ€`: Pi +[โ†’full documentation](../doc/syntax.md#constants) The mathematical constant pi, a numeric literal. Can be negative (`ยฏฯ€`). diff --git a/help/prefixes_take.md b/help/prefixes_take.md index 183b7b4c..214b4ffb 100644 --- a/help/prefixes_take.md +++ b/help/prefixes_take.md @@ -3,6 +3,7 @@ # Up Arrow (`โ†‘`) ## `โ†‘ ๐•ฉ`: Prefixes +[โ†’full documentation](../doc/prefixes.md) Prefixes of array `๐•ฉ` along its first axis. @@ -15,6 +16,7 @@ Prefixes of array `๐•ฉ` along its first axis. ## `๐•จ โ†‘ ๐•ฉ`: Take +[โ†’full documentation](../doc/take.md) For each integer in `๐•จ`, take that many elements from each dimension of `๐•ฉ`. diff --git a/help/range_windows.md b/help/range_windows.md index eca59a05..0896a6e9 100644 --- a/help/range_windows.md +++ b/help/range_windows.md @@ -3,6 +3,7 @@ # Up Down Arrow (`โ†•`) ## `โ†• ๐•ฉ`: Range +[โ†’full documentation](../doc/range.md) Return all indices that would index into an array of shape `๐•ฉ`. @@ -15,6 +16,7 @@ When given a single number, range from `0` to `๐•ฉ-1`. ## `๐•จ โ†• ๐•ฉ`: Windows +[โ†’full documentation](../doc/windows.md) Overlapping slices from `๐•ฉ` of shape `๐•จ`. diff --git a/help/rank_equals.md b/help/rank_equals.md index 4506ffa5..0f41f6fa 100644 --- a/help/rank_equals.md +++ b/help/rank_equals.md @@ -3,6 +3,7 @@ # Equal (`=`) ## `= ๐•ฉ`: Rank +[โ†’full documentation](../doc/shape.md) Returns the number of dimensions in `๐•ฉ`. @@ -18,6 +19,7 @@ Returns the number of dimensions in `๐•ฉ`. ## `๐•จ = ๐•ฉ`: Equal To +[โ†’full documentation](../doc/arithmetic.md#comparisons) [Pervasive.](../doc/arithmetic.md#pervasion) diff --git a/help/reciprocal_divide.md b/help/reciprocal_divide.md index 0d27eb2d..2d10225f 100644 --- a/help/reciprocal_divide.md +++ b/help/reciprocal_divide.md @@ -3,6 +3,7 @@ # Divide (`รท`) ## `รท ๐•ฉ`: Reciprocal +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) Gives `1 รท ๐•ฉ`. @@ -13,6 +14,7 @@ Gives `1 รท ๐•ฉ`. ## `๐•จ รท ๐•ฉ`: Divide +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) `๐•จ` divided by `๐•ฉ`. diff --git a/help/repeat.md b/help/repeat.md index c9aeea3c..2ddd1881 100644 --- a/help/repeat.md +++ b/help/repeat.md @@ -3,6 +3,7 @@ # Circle Star (`โŸ`) ## `๐”ฝโŸ๐”พ ๐•ฉ`, `๐•จ ๐”ฝโŸ๐”พ ๐•ฉ`: Repeat +[โ†’full documentation](../doc/repeat.md) Apply `๐”พ` to `๐•จ` and `๐•ฉ`, then apply `๐”ฝ` to `๐•ฉ` that may times. If `๐•จ` is given, use it each time as a constant left argument. diff --git a/help/reverse_rotate.md b/help/reverse_rotate.md index dea8e98d..39f3f496 100644 --- a/help/reverse_rotate.md +++ b/help/reverse_rotate.md @@ -3,6 +3,7 @@ # Circle Stile (`โŒฝ`) ## `โŒฝ ๐•ฉ`: Reverse +[โ†’full documentation](../doc/reverse.md) Reverse `๐•ฉ` along the first axis. @@ -15,6 +16,7 @@ Reverse `๐•ฉ` along the first axis. ## `๐•จ โŒฝ ๐•ฉ`: Rotate +[โ†’full documentation](../doc/reverse.md#rotate) Move the first `๐•จ` elements of `๐•ฉ` to its end. Negative `๐•จ` reverses the direction of rotation. diff --git a/help/rightargument.md b/help/rightargument.md index 531bec37..75c5e7e3 100644 --- a/help/rightargument.md +++ b/help/rightargument.md @@ -3,6 +3,7 @@ # Mathematical Double-struck X (`๐•ฉ`) ## `๐•ฉ`: Right Argument +[โ†’full documentation](../doc/syntax.md#blocks) A variable assigned to the right argument of a block. `๐•` can be used to access the right argument as a function. diff --git a/help/scan.md b/help/scan.md index ed5ed281..a4d84fc6 100644 --- a/help/scan.md +++ b/help/scan.md @@ -3,6 +3,7 @@ # Grave (`` ` ``) ## ``๐”ฝ` ๐•ฉ``: Scan +[โ†’full documentation](../doc/scan.md) Scan over `๐•ฉ` with `๐”ฝ` from left to right, producing intermediate values. diff --git a/help/separator.md b/help/separator.md index 0806317c..a64720bf 100644 --- a/help/separator.md +++ b/help/separator.md @@ -3,6 +3,7 @@ # Comma (`,`) and Diamond (`โ‹„`) ## `,` or `โ‹„`: Separator +[โ†’full documentation](../doc/syntax.md#separators) Separates statements in blocks, programs, and arrays. Characters `,` and `โ‹„` are interchangeable with each other and with newline. diff --git a/help/shape_notmatch.md b/help/shape_notmatch.md index 5b2baf19..fe4481b6 100644 --- a/help/shape_notmatch.md +++ b/help/shape_notmatch.md @@ -3,6 +3,7 @@ # Not Identical To (`โ‰ข`) ## `โ‰ข ๐•ฉ`: Shape +[โ†’full documentation](../doc/shape.md) Length of each dimension of x. @@ -15,6 +16,7 @@ Length of each dimension of x. ## `๐•จ โ‰ข ๐•ฉ`: Not Match +[โ†’full documentation](../doc/match.md) Does `๐•จ` not exactly match `๐•ฉ`? diff --git a/help/shiftafter.md b/help/shiftafter.md index 18f01f53..753fc77e 100644 --- a/help/shiftafter.md +++ b/help/shiftafter.md @@ -3,6 +3,7 @@ # Right Pointing Double Angle Quotation (`ยป`) ## `ยป ๐•ฉ`: Shift After +[โ†’full documentation](../doc/shift.md) Remove the last element of `๐•ฉ`, add a cell of fill values to the start of the first axis of `๐•ฉ`. @@ -13,6 +14,7 @@ Remove the last element of `๐•ฉ`, add a cell of fill values to the start of the ## `๐•จ ยป ๐•ฉ`: Shift After +[โ†’full documentation](../doc/shift.md) Remove the last `โ‰ ๐•จ` (length) major cells from `๐•ฉ`, join `๐•จ` to the start of `๐•ฉ`. Ranks must match. diff --git a/help/shiftbefore.md b/help/shiftbefore.md index 748919fd..25a1d799 100644 --- a/help/shiftbefore.md +++ b/help/shiftbefore.md @@ -3,6 +3,7 @@ # Left Pointing Double Angle Quotation (`ยซ`) ## `ยซ ๐•ฉ`: Shift Before +[โ†’full documentation](../doc/shift.md) Remove the first element of `๐•ฉ`, add a cell of fill values to the end of the first axis of `๐•ฉ`. @@ -15,6 +16,7 @@ Remove the first element of `๐•ฉ`, add a cell of fill values to the end of the ## `๐•จ ยซ ๐•ฉ`: Shift Before +[โ†’full documentation](../doc/shift.md) Remove the first `โ‰ ๐•จ` (length) major cells from `๐•ฉ`, join `๐•จ` to the end of `๐•ฉ`. Ranks must match. diff --git a/help/sign_multiply.md b/help/sign_multiply.md index 74fefa8c..47464687 100644 --- a/help/sign_multiply.md +++ b/help/sign_multiply.md @@ -3,6 +3,7 @@ # Times (`ร—`) ## `ร— ๐•ฉ`: Sign +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) Sign of `๐•ฉ`. - `ยฏ1` if `๐•ฉ < 0` @@ -16,6 +17,7 @@ Sign of `๐•ฉ`. ## `๐•จ ร— ๐•ฉ`: Multiply +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) `๐•จ` multiplied by `๐•ฉ`. diff --git a/help/solo_couple.md b/help/solo_couple.md index be981eac..0559dbe5 100644 --- a/help/solo_couple.md +++ b/help/solo_couple.md @@ -3,6 +3,7 @@ # Tape (`โ‰`) ## `โ‰ ๐•ฉ`: Solo +[โ†’full documentation](../doc/couple.md) Add a dimension to `๐•ฉ`. @@ -23,6 +24,7 @@ Add a dimension to `๐•ฉ`. ## `๐•จ โ‰ ๐•ฉ`: Couple +[โ†’full documentation](../doc/couple.md) Join `๐•จ` and `๐•ฉ` along a newly created axis. diff --git a/help/sortdown_or.md b/help/sortdown_or.md index 3ca0d0ef..179ebc0a 100644 --- a/help/sortdown_or.md +++ b/help/sortdown_or.md @@ -3,6 +3,7 @@ # Logical Or (`โˆจ`) ## `โˆจ ๐•ฉ`: Sort Down +[โ†’full documentation](../doc/order.md#sort) Sort array `๐•ฉ` in descending order. @@ -11,6 +12,7 @@ Sort array `๐•ฉ` in descending order. ## `๐•จ โˆจ ๐•ฉ`: Logical Or +[โ†’full documentation](../doc/logic.md) Logical Or of `๐•จ` and `๐•ฉ`. diff --git a/help/sortup_and.md b/help/sortup_and.md index 6fe95044..aa9ff8a6 100644 --- a/help/sortup_and.md +++ b/help/sortup_and.md @@ -3,6 +3,7 @@ # Logical And (`โˆง`) ## `โˆง ๐•ฉ`: Sort Up +[โ†’full documentation](../doc/order.md#sort) Sort array `๐•ฉ` in ascending order. @@ -11,6 +12,7 @@ Sort array `๐•ฉ` in ascending order. ## `๐•จ โˆง ๐•ฉ`: Logical And +[โ†’full documentation](../doc/logic.md) Logical And of `๐•จ` and `๐•ฉ`. diff --git a/help/squareroot_root.md b/help/squareroot_root.md index 2215dcaa..2cfe0788 100644 --- a/help/squareroot_root.md +++ b/help/squareroot_root.md @@ -3,6 +3,7 @@ # Root (`โˆš`) ## `โˆš ๐•ฉ`: Square root +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) [Pervasive.](../doc/arithmetic.md#pervasion) @@ -11,6 +12,7 @@ ## `๐•จ โˆš ๐•ฉ`: Root +[โ†’full documentation](../doc/arithmetic.md#basic-arithmetic) `๐•จ`th root of `๐•ฉ`. diff --git a/help/strand.md b/help/strand.md index 24e586e0..696bb1d5 100644 --- a/help/strand.md +++ b/help/strand.md @@ -3,6 +3,7 @@ # Undertie (`โ€ฟ`) ## `โ€ฟ`: Strand +[โ†’full documentation](../doc/syntax.md#list-notation) Create a list via [strand notation](../doc/arrayrepr.md#strands). diff --git a/help/suffixes_drop.md b/help/suffixes_drop.md index e2e8d624..b23989b5 100644 --- a/help/suffixes_drop.md +++ b/help/suffixes_drop.md @@ -3,6 +3,7 @@ # Down Arrow (`โ†“`) ## `โ†“ ๐•ฉ`: Suffixes +[โ†’full documentation](../doc/prefixes.md) Suffixes of array `๐•ฉ` along its first axis. @@ -15,6 +16,7 @@ Suffixes of array `๐•ฉ` along its first axis. ## `๐•จ โ†“ ๐•ฉ`: Drop +[โ†’full documentation](../doc/take.md) For each integer in `๐•จ`, drop that many elements from the beginning of each dimension of `๐•ฉ`. diff --git a/help/table.md b/help/table.md index f57a4f84..c15a7316 100644 --- a/help/table.md +++ b/help/table.md @@ -3,6 +3,7 @@ # Top Left Corner (`โŒœ`) ## `๐•จ ๐”ฝโŒœ ๐•ฉ`: Table +[โ†’full documentation](../doc/map.md) Apply `๐”ฝ` between every possible pair of the elements of the arguments. diff --git a/help/transpose_reorderaxes.md b/help/transpose_reorderaxes.md index e96d7d9c..0d953d69 100644 --- a/help/transpose_reorderaxes.md +++ b/help/transpose_reorderaxes.md @@ -3,6 +3,7 @@ # Circle Backslash (`โ‰`) ## `โ‰ ๐•ฉ`: Transpose +[โ†’full documentation](../doc/transpose.md) Move the first axis of `๐•ฉ` to the end. @@ -17,6 +18,7 @@ Move the first axis of `๐•ฉ` to the end. ## `๐•จ โ‰ ๐•ฉ`: Reorder Axes +[โ†’full documentation](../doc/transpose.md) Rearrange the axes of `๐•ฉ` as per the axis indices in `๐•จ`. diff --git a/help/undo.md b/help/undo.md index 7ada9161..c418fa8e 100644 --- a/help/undo.md +++ b/help/undo.md @@ -3,6 +3,7 @@ # Superscript Equals Sign (`โผ`) ## `๐”ฝโผ ๐•ฉ`, `๐•จ ๐”ฝโผ ๐•ฉ`: Undo +[โ†’full documentation](../doc/undo.md) Invert the function `๐”ฝ`, or use its defined inverse. Not all functions have inverses. -- cgit v1.2.3