diff options
Diffstat (limited to '')
17 files changed, 158 insertions, 158 deletions
diff --git a/stdlib/source/documentation/lux/data/collection/array.lux b/stdlib/source/documentation/lux/data/collection/array.lux index c4ce92a7a..3517b2eeb 100644 --- a/stdlib/source/documentation/lux/data/collection/array.lux +++ b/stdlib/source/documentation/lux/data/collection/array.lux @@ -22,75 +22,75 @@ ($.default /.every?) ($.default /.any?) - ($.documentation (/.Array it) + ($.definition (/.Array it) "Mutable arrays.") - ($.documentation /.empty + ($.definition /.empty "An empty array of the specified size." [(empty size)]) - ($.documentation /.size + ($.definition /.size "" [(size array)]) - ($.documentation /.item + ($.definition /.item "" [(item index array)]) - ($.documentation /.has! + ($.definition /.has! "Mutate the array by writing a value to the specified index." [(has! index value array)]) - ($.documentation /.lacks! + ($.definition /.lacks! "Mutate the array by deleting the value at the specified index." [(lacks! index array)]) - ($.documentation /.has? + ($.definition /.has? "" [(has? index array)]) - ($.documentation /.revised! + ($.definition /.revised! "Mutate the array by updating the value at the specified index." [(revised! index transform array)]) - ($.documentation /.upsert! + ($.definition /.upsert! (format "Mutate the array by updating the value at the specified index." \n "If there is no value, update and write the default value given.") [(upsert! index default transform array)]) - ($.documentation /.copy! + ($.definition /.copy! "Writes the contents of one array into the other." [(copy! length src_start src_array dest_start dest_array)]) - ($.documentation /.occupancy + ($.definition /.occupancy "Finds out how many cells in an array are occupied." [(occupancy array)]) - ($.documentation /.vacancy + ($.definition /.vacancy "Finds out how many cells in an array are vacant." [(vacancy array)]) - ($.documentation /.only! + ($.definition /.only! "Delete every item of the array that fails to satisfy the predicate." [(only! p xs)]) - ($.documentation /.example + ($.definition /.example "Yields the first item in the array that satisfies the predicate." [(example p xs)]) - ($.documentation /.example' + ($.definition /.example' "Just like 'example', but with access to the index of each value." [(example' p xs)]) - ($.documentation /.clone + ($.definition /.clone "Yields a shallow clone of the array." [(clone xs)]) - ($.documentation /.of_list + ($.definition /.of_list "" [(of_list xs)]) - ($.documentation /.list + ($.definition /.list (format "Yields a list with every non-empty item in the array." \n "Can use the optional default value when encountering an empty cell in the array.") [(list {.#None} array) diff --git a/stdlib/source/documentation/lux/data/collection/bits.lux b/stdlib/source/documentation/lux/data/collection/bits.lux index 522f7eccd..648541759 100644 --- a/stdlib/source/documentation/lux/data/collection/bits.lux +++ b/stdlib/source/documentation/lux/data/collection/bits.lux @@ -21,26 +21,26 @@ ($.default /.or) ($.default /.xor) - ($.documentation /.Bits + ($.definition /.Bits "A bit-map.") - ($.documentation /.size + ($.definition /.size "Measures the size of a bit-map by counting all the 1s in the bit-map." [(size bits)]) - ($.documentation /.capacity + ($.definition /.capacity "" [(capacity bits)]) - ($.documentation /.bit + ($.definition /.bit "" [(bit index bits)]) - ($.documentation /.intersects? + ($.definition /.intersects? "" [(intersects? reference sample)]) - ($.documentation /.not + ($.definition /.not "" [(not input)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/dictionary.lux b/stdlib/source/documentation/lux/data/collection/dictionary.lux index 99f6342b4..6cc473b7f 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary.lux @@ -24,61 +24,61 @@ ($.default /.equivalence) ($.default /.functor) - ($.documentation (/.Dictionary key value) + ($.definition (/.Dictionary key value) "A dictionary implemented as a Hash-Array Mapped Trie (HAMT).") - ($.documentation /.empty + ($.definition /.empty "An empty dictionary." [(empty key_hash)]) - ($.documentation /.has + ($.definition /.has "" [(has key val dict)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks key dict)]) - ($.documentation /.value + ($.definition /.value "" [(value key dict)]) - ($.documentation /.key? + ($.definition /.key? "" [(key? dict key)]) - ($.documentation /.has' + ($.definition /.has' "Only puts the KV-pair if the key is not already present." [(has' key val dict)]) - ($.documentation /.revised + ($.definition /.revised "Transforms the value located at key (if available), using the given function." [(revised key f dict)]) - ($.documentation /.revised' + ($.definition /.revised' (format "Updates the value at the key; if it exists." \n "Otherwise, puts a value by applying the function to a default.") [(revised' key default f dict)]) - ($.documentation /.of_list + ($.definition /.of_list "" [(of_list key_hash kvs)]) - ($.documentation /.composite + ($.definition /.composite (format "Merges 2 dictionaries." \n "If any collisions with keys occur, the values of dict2 will overwrite those of dict1.") [(composite dict2 dict1)]) - ($.documentation /.composite_with + ($.definition /.composite_with (format "Merges 2 dictionaries." \n "If any collisions with keys occur, a new value will be computed by applying 'f' to the values of dict2 and dict1.") [(composite_with f dict2 dict1)]) - ($.documentation /.re_bound + ($.definition /.re_bound "If there is a value under 'from_key', remove 'from_key' and store the value under 'to_key'." [(re_bound from_key to_key dict)]) - ($.documentation /.sub + ($.definition /.sub "A sub-dictionary, with only the specified keys." [(sub keys dict)])] [/ordered.documentation])) diff --git a/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux b/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux index 64f18f260..232e3bcdf 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux @@ -21,46 +21,46 @@ ($.default /.values) ($.default /.equivalence) - ($.documentation (/.Dictionary key value) + ($.definition (/.Dictionary key value) "A dictionary data-structure with ordered entries.") - ($.documentation /.empty + ($.definition /.empty "An empty dictionary, employing the given order." [(empty order)]) - ($.documentation /.value + ($.definition /.value "" [(value key dict)]) - ($.documentation /.key? + ($.definition /.key? "" [(key? dict key)]) (,, (with_template [<name>] - [(`` ($.documentation <name> + [(`` ($.definition <name> (format "Yields value under the " (,, (template.text [<name>])) "imum key.")))] [/.min] [/.max] )) - ($.documentation /.size + ($.definition /.size "" [(size dict)]) - ($.documentation /.has + ($.definition /.has "" [(has key value dict)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks key dict)]) - ($.documentation /.revised + ($.definition /.revised "" [(revised key transform dict)]) - ($.documentation /.of_list + ($.definition /.of_list "" [(of_list order list)])] []))) diff --git a/stdlib/source/documentation/lux/data/collection/list.lux b/stdlib/source/documentation/lux/data/collection/list.lux index 60c60b480..0e413e1d7 100644 --- a/stdlib/source/documentation/lux/data/collection/list.lux +++ b/stdlib/source/documentation/lux/data/collection/list.lux @@ -32,133 +32,133 @@ ($.default /.every?) ($.default /.any?) - ($.documentation /.mixes + ($.definition /.mixes "" [(mixes f init inputs)]) - ($.documentation /.reversed + ($.definition /.reversed "" [(reversed xs)]) - ($.documentation /.only + ($.definition /.only "A list with only values that satisfy the predicate." [(only keep? xs)]) - ($.documentation /.partition + ($.definition /.partition "Divide the list into all elements that satisfy a predicate, and all elements that do not." [(partition satisfies? list)]) - ($.documentation /.pairs + ($.definition /.pairs "Cut the list into pairs of 2." [(pairs list)]) - ($.documentation /.split_at + ($.definition /.split_at "" [(split_at n xs)]) - ($.documentation /.split_when + ($.definition /.split_when "Segment the list by using a predicate to tell when to cut." [(split_when predicate xs)]) - ($.documentation /.sub + ($.definition /.sub "Segment the list into sub-lists of (at most) the given size." [(sub size list)]) - ($.documentation /.repeated + ($.definition /.repeated "A list of the value x, repeated n times." [(repeated n x)]) - ($.documentation /.iterations + ($.definition /.iterations "Generates a list element by element until the function returns .#None." [(iterations f x)]) - ($.documentation /.one + ($.definition /.one "" [(one check xs)]) - ($.documentation /.all + ($.definition /.all "" [(all check xs)]) - ($.documentation /.example + ($.definition /.example "Yields the first value in the list that satisfies the predicate." [(example predicate xs)]) - ($.documentation /.interposed + ($.definition /.interposed "Puts a value between every two elements in the list." [(interposed sep xs)]) - ($.documentation /.size + ($.definition /.size "" [(size list)]) - ($.documentation /.item + ($.definition /.item "Fetches the element at the specified index." [(item i xs)]) - ($.documentation /.sorted + ($.definition /.sorted "A list ordered by a comparison function." [(sorted < xs)]) - ($.documentation /.empty? + ($.definition /.empty? "" [(empty? xs)]) - ($.documentation /.member? + ($.definition /.member? "" [(member? eq xs x)]) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.head "Yields the first element of a list."] [/.tail "For a list of size N, yields the N-1 elements after the first one."] )) - ($.documentation /.indices + ($.definition /.indices "Produces all the valid indices for a given size." [(indices size)]) - ($.documentation /.zipped + ($.definition /.zipped "Create list zippers with the specified number of input lists." [(def zipped_2 (zipped 2)) (def zipped_3 (zipped 3)) (zipped_3 xs ys zs) ((zipped 3) xs ys zs)]) - ($.documentation /.zipped_with + ($.definition /.zipped_with "Create list zippers with the specified number of input lists." [(def zipped_with_2 (zipped_with 2)) (def zipped_with_3 (zipped_with 3)) (zipped_with_2 + xs ys) ((zipped_with 2) + xs ys)]) - ($.documentation /.last + ($.definition /.last "" [(last xs)]) - ($.documentation /.inits + ($.definition /.inits (format "For a list of size N, yields the first N-1 elements." \n "Will yield a .#None for empty lists.") [(inits xs)]) - ($.documentation /.together + ($.definition /.together "The sequential combination of all the lists.") - ($.documentation /.with + ($.definition /.with "Enhances a monad with List functionality." [(with monad)]) - ($.documentation /.lifted + ($.definition /.lifted "Wraps a monadic value with List machinery." [(lifted monad)]) - ($.documentation /.enumeration + ($.definition /.enumeration "Pairs every element in the list with its index, starting at 0." [(enumeration xs)]) - ($.documentation /.when + ($.definition /.when "Can be used as a guard in (co)monadic be/do expressions." [(do monad [value (do_something 1 2 3) diff --git a/stdlib/source/documentation/lux/data/collection/list/property.lux b/stdlib/source/documentation/lux/data/collection/list/property.lux index b94d44263..df68a5963 100644 --- a/stdlib/source/documentation/lux/data/collection/list/property.lux +++ b/stdlib/source/documentation/lux/data/collection/list/property.lux @@ -19,27 +19,27 @@ ($.default /.values) ($.default /.equivalence) - ($.documentation (/.List it) + ($.definition (/.List it) (format "A property list." \n "It's a simple dictionary-like structure with Text keys.")) - ($.documentation /.value + ($.definition /.value "" [(value key properties)]) - ($.documentation /.contains? + ($.definition /.contains? "" [(contains? key properties)]) - ($.documentation /.has + ($.definition /.has "" [(has key val properties)]) - ($.documentation /.revised + ($.definition /.revised "" [(revised key f properties)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks key properties)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/queue.lux b/stdlib/source/documentation/lux/data/collection/queue.lux index 935b0dfc3..5b96e8a10 100644 --- a/stdlib/source/documentation/lux/data/collection/queue.lux +++ b/stdlib/source/documentation/lux/data/collection/queue.lux @@ -17,29 +17,29 @@ ($.default /.equivalence) ($.default /.functor) - ($.documentation (/.Queue it) + ($.definition (/.Queue it) "A first-in, first-out sequential data-structure.") - ($.documentation /.of_list + ($.definition /.of_list "" [(of_list entries)]) - ($.documentation /.list + ($.definition /.list "" [(list queue)]) - ($.documentation /.front + ($.definition /.front "Yields the first value in the queue, if any.") - ($.documentation /.member? + ($.definition /.member? "" [(member? equivalence queue member)]) - ($.documentation /.next + ($.definition /.next "" [(next queue)]) - ($.documentation /.end + ($.definition /.end "" [(end val queue)])] [/priority.documentation])) diff --git a/stdlib/source/documentation/lux/data/collection/queue/priority.lux b/stdlib/source/documentation/lux/data/collection/queue/priority.lux index 4c6303902..36f889902 100644 --- a/stdlib/source/documentation/lux/data/collection/queue/priority.lux +++ b/stdlib/source/documentation/lux/data/collection/queue/priority.lux @@ -19,11 +19,11 @@ ($.default /.next) ($.default /.empty?) - ($.documentation /.member? + ($.definition /.member? "" [(member? equivalence queue member)]) - ($.documentation /.end + ($.definition /.end "" [(end priority value queue)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/sequence.lux b/stdlib/source/documentation/lux/data/collection/sequence.lux index 9bc09f736..fc8c6fab6 100644 --- a/stdlib/source/documentation/lux/data/collection/sequence.lux +++ b/stdlib/source/documentation/lux/data/collection/sequence.lux @@ -24,42 +24,42 @@ ($.default /.every?) ($.default /.any?) - ($.documentation (/.Sequence it) + ($.definition (/.Sequence it) "A sequential data-structure with fast random access.") - ($.documentation /.suffix + ($.definition /.suffix "" [(suffix val sequence)]) - ($.documentation /.within_bounds? + ($.definition /.within_bounds? "Determines whether the index is within the bounds of the sequence." [(within_bounds? sequence idx)]) - ($.documentation /.item + ($.definition /.item "" [(item idx sequence)]) - ($.documentation /.has + ($.definition /.has "" [(has idx val sequence)]) - ($.documentation /.revised + ($.definition /.revised "" [(revised idx f sequence)]) - ($.documentation /.prefix + ($.definition /.prefix "" [(prefix sequence)]) - ($.documentation /.list + ($.definition /.list "" [(list sequence)]) - ($.documentation /.member? + ($.definition /.member? "" [(member? equivalence sequence val)]) - ($.documentation /.sequence + ($.definition /.sequence "Sequence literals." [(is (Sequence Nat) (sequence 12 34 56 78 90))])] diff --git a/stdlib/source/documentation/lux/data/collection/set.lux b/stdlib/source/documentation/lux/data/collection/set.lux index 37024e63b..00d989bca 100644 --- a/stdlib/source/documentation/lux/data/collection/set.lux +++ b/stdlib/source/documentation/lux/data/collection/set.lux @@ -30,23 +30,23 @@ ($.default /.of_list) ($.default /.predicate) - ($.documentation /.has + ($.definition /.has "" [(has elem set)]) - ($.documentation /.difference + ($.definition /.difference "" [(difference sub base)]) - ($.documentation /.intersection + ($.definition /.intersection "" [(intersection filter base)]) - ($.documentation /.sub? + ($.definition /.sub? "" [(sub? super sub)]) - ($.documentation /.super? + ($.definition /.super? "" [(super? sub super)])] [/multi.documentation diff --git a/stdlib/source/documentation/lux/data/collection/set/multi.lux b/stdlib/source/documentation/lux/data/collection/set/multi.lux index d6d0947dc..3f06fe230 100644 --- a/stdlib/source/documentation/lux/data/collection/set/multi.lux +++ b/stdlib/source/documentation/lux/data/collection/set/multi.lux @@ -25,33 +25,33 @@ ($.default /.intersection) ($.default /.difference) - ($.documentation (/.Set it) + ($.definition (/.Set it) "A set that keeps track of repetition in its entries.") - ($.documentation /.has + ($.definition /.has "" [(has multiplicity elem set)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks multiplicity elem set)]) - ($.documentation /.multiplicity + ($.definition /.multiplicity "" [(multiplicity set elem)]) - ($.documentation /.sub? + ($.definition /.sub? "Is 'subject' a sub-set of 'reference'?" [(sub? reference subject)]) - ($.documentation /.support + ($.definition /.support "A set of the unique (non repeated) members." [(support set)]) - ($.documentation /.member? + ($.definition /.member? "" [(member? set elem)]) - ($.documentation /.super? + ($.definition /.super? "Is 'subject' a super-set of 'reference'?")] [])) diff --git a/stdlib/source/documentation/lux/data/collection/set/ordered.lux b/stdlib/source/documentation/lux/data/collection/set/ordered.lux index 0b8dba28e..6581303a4 100644 --- a/stdlib/source/documentation/lux/data/collection/set/ordered.lux +++ b/stdlib/source/documentation/lux/data/collection/set/ordered.lux @@ -23,30 +23,30 @@ ($.default /.intersection) ($.default /.equivalence) - ($.documentation (/.Set it) + ($.definition (/.Set it) "A set with ordered entries.") - ($.documentation /.member? + ($.definition /.member? "" [(member? set elem)]) - ($.documentation /.has + ($.definition /.has "" [(has elem set)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks elem set)]) - ($.documentation /.difference + ($.definition /.difference "" [(difference param subject)]) - ($.documentation /.sub? + ($.definition /.sub? "Is 'sub' a sub-set of 'super'?" [(sub? super sub)]) - ($.documentation /.super? + ($.definition /.super? "Is 'super' a super-set of 'sub'?" [(super? sub super)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/stack.lux b/stdlib/source/documentation/lux/data/collection/stack.lux index defa3f836..0faad223b 100644 --- a/stdlib/source/documentation/lux/data/collection/stack.lux +++ b/stdlib/source/documentation/lux/data/collection/stack.lux @@ -18,18 +18,18 @@ ($.default /.equivalence) ($.default /.functor) - ($.documentation (/.Stack it) + ($.definition (/.Stack it) "A first-in, last-out sequential data-structure.") - ($.documentation /.value + ($.definition /.value "Yields the top value in the stack, if any." [(value stack)]) - ($.documentation /.next + ($.definition /.next "" [(next stack)]) - ($.documentation /.top + ($.definition /.top "" [(top value stack)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/stream.lux b/stdlib/source/documentation/lux/data/collection/stream.lux index 393765c2f..7f6b412cf 100644 --- a/stdlib/source/documentation/lux/data/collection/stream.lux +++ b/stdlib/source/documentation/lux/data/collection/stream.lux @@ -23,36 +23,36 @@ ($.default /.split_when) ($.default /.split_at) - ($.documentation (/.Stream it) + ($.definition (/.Stream it) "An infinite sequence of values.") - ($.documentation /.iterations + ($.definition /.iterations "A stateful way of infinitely calculating the values of a stream." [(iterations step init)]) - ($.documentation /.repeated + ($.definition /.repeated "Repeat a value forever." [(repeated x)]) - ($.documentation /.cycle + ($.definition /.cycle "Go over the elements of a list forever." [(cycle [start next])]) - ($.documentation /.item + ($.definition /.item "" [(item idx stream)]) - ($.documentation /.only + ($.definition /.only "A new stream only with items that satisfy the predicate." [(only predicate stream)]) - ($.documentation /.partition + ($.definition /.partition (format "Split a stream in two based on a predicate." \n "The left side contains all entries for which the predicate is #1." \n "The right side contains all entries for which the predicate is #0.") [(partition left? xs)]) - ($.documentation /.pattern + ($.definition /.pattern (format "Allows destructuring of streams in pattern-matching expressions." \n "Caveat emptor: Only use it for destructuring, and not for testing values within the streams.") [(let [(pattern x y z _tail) (some_stream_func +1 +2 +3)] diff --git a/stdlib/source/documentation/lux/data/collection/tree.lux b/stdlib/source/documentation/lux/data/collection/tree.lux index fca76d251..4e063f788 100644 --- a/stdlib/source/documentation/lux/data/collection/tree.lux +++ b/stdlib/source/documentation/lux/data/collection/tree.lux @@ -18,22 +18,22 @@ "" [($.default \\parser.cannot_move_further) - ($.documentation (\\parser.Parser it) + ($.definition (\\parser.Parser it) "A parser of arbitrary trees.") - ($.documentation \\parser.result' + ($.definition \\parser.result' "Applies the parser against a tree zipper." [(result' parser zipper)]) - ($.documentation \\parser.result + ($.definition \\parser.result "Applies the parser against a tree." [(result parser tree)]) - ($.documentation \\parser.value + ($.definition \\parser.value "Yields the value inside the current tree node.") (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [\\parser.down "Move down."] @@ -61,22 +61,22 @@ ($.default /.functor) ($.default /.mix) - ($.documentation (/.Tree it) + ($.definition (/.Tree it) "A generic tree data-structure.") - ($.documentation /.flat + ($.definition /.flat "All the leaf values of the tree, in order." [(flat tree)]) - ($.documentation /.leaf + ($.definition /.leaf "" [(leaf value)]) - ($.documentation /.branch + ($.definition /.branch "" [(branch value children)]) - ($.documentation /.tree + ($.definition /.tree "Tree literals." [(is (Tree Nat) (tree 12 diff --git a/stdlib/source/documentation/lux/data/collection/tree/finger.lux b/stdlib/source/documentation/lux/data/collection/tree/finger.lux index fe0488db4..fbaac3b6f 100644 --- a/stdlib/source/documentation/lux/data/collection/tree/finger.lux +++ b/stdlib/source/documentation/lux/data/collection/tree/finger.lux @@ -15,33 +15,33 @@ [($.default /.tag) ($.default /.root) - ($.documentation (/.Tree @ tag value) + ($.definition (/.Tree @ tag value) "A finger tree.") - ($.documentation (/.Builder @ tag) + ($.definition (/.Builder @ tag) "A builder for finter tree structures.") - ($.documentation /.builder + ($.definition /.builder "A new builder using the given monoid." [(builder monoid)]) - ($.documentation /.value + ($.definition /.value "" [(value tree)]) - ($.documentation /.tags + ($.definition /.tags "" [(tags tree)]) - ($.documentation /.values + ($.definition /.values "" [(values tree)]) - ($.documentation /.one + ($.definition /.one "Finds one value that meets the predicate." [(one predicate tree)]) - ($.documentation /.exists? + ($.definition /.exists? "Verifies that a value exists which meets the predicate." [(exists? predicate tree)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/tree/zipper.lux b/stdlib/source/documentation/lux/data/collection/tree/zipper.lux index 317fd95ac..28535dac0 100644 --- a/stdlib/source/documentation/lux/data/collection/tree/zipper.lux +++ b/stdlib/source/documentation/lux/data/collection/tree/zipper.lux @@ -36,22 +36,22 @@ ($.default /.functor) ($.default /.comonad) - ($.documentation (/.Zipper it) + ($.definition (/.Zipper it) "Tree zippers, for easy navigation and editing of trees.") - ($.documentation /.set + ($.definition /.set "" [(set value zipper)]) - ($.documentation /.update + ($.definition /.update "" [(update transform zipper)]) - ($.documentation /.interpose + ($.definition /.interpose "" [(interpose value zipper)]) - ($.documentation /.adopt + ($.definition /.adopt "" [(adopt value zipper)])] [])) |