mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2024-11-28 19:19:53 +00:00
Code Issues 1 Releases Wiki Activity

Update docstrings in boot.janet (#506)

Browse Source 
Elaborate on usage of reduce and accumulate.
This commit is contained in:
Calvin Rose 2020-11-26 10:32:05 -06:00
parent a3e812b86d
commit 451340e4c0
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/boot/boot.janet
View File

@ -811,11 +811,15 @@
(defn reduce (defn reduce
"Reduce, also know as fold-left in many languages, transforms "Reduce, also know as fold-left in many languages, transforms
an indexed type (array, tuple) with a function to produce a value." an indexed type (array, tuple) with a function to produce a value by applying f to
each element in order. f is a function of 2 arguments, (f accum el), where
accum is the initial value and el is the next value in the indexed type ind.
f returns a value that will be used as accum in the next call to f. reduce
returns the value of the final call to f."
[f init ind] [f init ind]
(var res init) (var accum init)
(each x ind (set res (f res x))) (each el ind (set accum (f accum el)))
res) accum)
(defn reduce2 (defn reduce2
"The 2-argument version of reduce that does not take an initialization value. "The 2-argument version of reduce that does not take an initialization value.
@ -833,7 +837,8 @@
(defn accumulate (defn accumulate
"Similar to reduce, but accumulates intermediate values into an array. "Similar to reduce, but accumulates intermediate values into an array.
The last element in the array is what would be the return value from reduce. The last element in the array is what would be the return value from reduce.
The init value is not added to the array. The init value is not added to the array (the return value will have the same
number of elements as ind).
Returns a new array." Returns a new array."
[f init ind] [f init ind]
(var res init) (var res init)
@ -842,7 +847,9 @@
ret) ret)
(defn accumulate2 (defn accumulate2
"The 2-argument version of accumulate that does not take an initialization value." "The 2-argument version of accumulate that does not take an initialization value.
The first value in ind will be added to the array as is, so the length of the
return value will be (length ind)."
[f ind] [f ind]
(var k (next ind)) (var k (next ind))
(def ret (array/new (length ind))) (def ret (array/new (length ind)))