diff --git a/CHANGELOG.md b/CHANGELOG.md index d5088d7ef..a5fa1fa94 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@
-## Unreleased (2024-09-17) +## Unreleased (2024-09-21)
@@ -387,6 +387,7 @@ A total of 4 people contributed to this release. Thank you to the following cont
+- [`6e9f42e`](https://github.com/stdlib-js/stdlib/commit/6e9f42e4c912485d9896eaa16c88b70fd3688e97) - **docs:** harmonize list formatting in repl.txt and ensure starting newline _(by Philipp Burckhardt)_ - [`f387603`](https://github.com/stdlib-js/stdlib/commit/f387603e739f88a38af3263ce6ff675ad903ee8c) - **docs:** consistently use declarative instead of imperative sentences outside of intros _(by Philipp Burckhardt)_ - [`ed44fee`](https://github.com/stdlib-js/stdlib/commit/ed44feecb9eaa5e0849d1a533e5415624d0aa338) - **style:** use imperative in package.json description and end with period _(by Philipp Burckhardt)_ - [`0c994ee`](https://github.com/stdlib-js/stdlib/commit/0c994ee22c77c217aa48d6833e4e11ffe733e9bb) - **docs:** update descriptions and add structured package data [(#2914)](https://github.com/stdlib-js/stdlib/pull/2914) _(by Gunj Joshi, Athan Reines)_ diff --git a/LICENSE b/LICENSE index 674484ef6..c552d1acb 100644 --- a/LICENSE +++ b/LICENSE @@ -181,6 +181,32 @@ The library links against the following external libraries or contains implementations from the following external libraries, which have their own licenses: +* Boost + +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + * FreeBSD Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved. @@ -190,19 +216,6 @@ Permission to use, copy, modify, and distribute this software is freely granted, provided that this notice is preserved. -* Cephes - -Copyright (c) 1984-2000 Stephen L. Moshier - -Some software in this archive may be from the book _Methods and Programs for -Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989) -or from the Cephes Mathematical Library, a commercial product. In either event, -it is copyrighted by the author. What you see here may be used freely but it -comes with no support or guarantee. - -Stephen L. Moshier -moshier@na-net.ornl.gov - * SpecialFunctions.jl @@ -230,66 +243,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* FDLIBM - -Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved. - -* Boost - -Boost Software License - Version 1.0 - August 17th, 2003 - -Permission is hereby granted, free of charge, to any person or organization -obtaining a copy of the software and accompanying documentation covered by -this license (the "Software") to use, reproduce, display, distribute, -execute, and transmit the Software, and to prepare derivative works of the -Software, and to permit third-parties to whom the Software is furnished to -do so, all subject to the following: - -The copyright notices in the Software and this entire statement, including -the above license grant, this restriction and the following disclaimer, -must be included in all copies of the Software, in whole or in part, and -all derivative works of the Software, unless such copies or derivative -works are solely in the form of machine-executable object code generated by -a source language processor. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT -SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE -FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, -ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. - -* SLATEC Common Mathematical Library - -Public domain. - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - -* Faddeeva - -Copyright (c) 2012 Massachusetts Institute of Technology - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * Go Copyright (c) 2009 The Go Authors. All rights reserved. @@ -320,11 +273,26 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +* SLATEC Common Mathematical Library + +Public domain. + +* FDLIBM + +Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved. + +* Cephes + +Copyright (c) 1984-2000 Stephen L. Moshier + +Some software in this archive may be from the book _Methods and Programs for +Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989) +or from the Cephes Mathematical Library, a commercial product. In either event, +it is copyrighted by the author. What you see here may be used freely but it +comes with no support or guarantee. + Stephen L. Moshier moshier@na-net.ornl.gov - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ Developed at SunPro, a Sun Microsystems, Inc. business. Permission to use, copy, modify, and distribute this @@ -334,6 +302,29 @@ is preserved. Version 2.0, January 2004 http://www.apache.org/licenses/ +* Faddeeva + +Copyright (c) 2012 Massachusetts Institute of Technology + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT diff --git a/iter/tools/map/docs/repl.txt b/iter/tools/map/docs/repl.txt index b4b475315..01d06b177 100644 --- a/iter/tools/map/docs/repl.txt +++ b/iter/tools/map/docs/repl.txt @@ -5,7 +5,7 @@ When invoked, the input function is provided one argument: - - value: iterated value + - value: iterated value. If an environment supports Symbol.iterator and a provided iterator is iterable, the returned iterator is iterable. diff --git a/iter/tools/map2/docs/repl.txt b/iter/tools/map2/docs/repl.txt index e37f32e2e..1055fa86d 100644 --- a/iter/tools/map2/docs/repl.txt +++ b/iter/tools/map2/docs/repl.txt @@ -5,8 +5,8 @@ When invoked, the input function is provided two arguments: - - x: iterated value from first input iterator - - y: iterated value from second input iterator + - x: iterated value from first input iterator. + - y: iterated value from second input iterator. The length of the returned iterator is equal to the length of the shortest provided iterator. In other words, the returned iterator ends once *one* of diff --git a/iter/tools/map3/docs/repl.txt b/iter/tools/map3/docs/repl.txt index a6e584f04..c90599b93 100644 --- a/iter/tools/map3/docs/repl.txt +++ b/iter/tools/map3/docs/repl.txt @@ -5,9 +5,9 @@ When invoked, the input function is provided three arguments: - - x: iterated value from first input iterator - - y: iterated value from second input iterator - - z: iterated value from third input iterator + - x: iterated value from first input iterator. + - y: iterated value from second input iterator. + - z: iterated value from third input iterator. The length of the returned iterator is equal to the length of the shortest provided iterator. In other words, the returned iterator ends once *one* of diff --git a/strided/ops/add-by/docs/repl.txt b/strided/ops/add-by/docs/repl.txt index 6acc0a099..7aaad51b6 100644 --- a/strided/ops/add-by/docs/repl.txt +++ b/strided/ops/add-by/docs/repl.txt @@ -11,10 +11,10 @@ The callback function is provided four arguments: - - values: input array elements - - idx: iteration index - - indices: strided array indices (offset + idx*stride) - - arrays: input and output arrays + - values: input array elements. + - idx: iteration index. + - indices: strided array indices (offset + idx*stride). + - arrays: input and output arrays. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/ops/mul-by/docs/repl.txt b/strided/ops/mul-by/docs/repl.txt index 11fb073bf..1bee0c561 100644 --- a/strided/ops/mul-by/docs/repl.txt +++ b/strided/ops/mul-by/docs/repl.txt @@ -11,10 +11,10 @@ The callback function is provided four arguments: - - values: input array elements - - idx: iteration index - - indices: strided array indices (offset + idx*stride) - - arrays: input and output arrays + - values: input array elements. + - idx: iteration index. + - indices: strided array indices (offset + idx*stride). + - arrays: input and output arrays. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/ops/sub-by/docs/repl.txt b/strided/ops/sub-by/docs/repl.txt index 4a3490710..82cb15ad0 100644 --- a/strided/ops/sub-by/docs/repl.txt +++ b/strided/ops/sub-by/docs/repl.txt @@ -11,10 +11,10 @@ The callback function is provided four arguments: - - values: input array elements - - idx: iteration index - - indices: strided array indices (offset + idx*stride) - - arrays: input and output arrays + - values: input array elements. + - idx: iteration index. + - indices: strided array indices (offset + idx*stride). + - arrays: input and output arrays. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/abs-by/docs/repl.txt b/strided/special/abs-by/docs/repl.txt index b1ce33a18..ad7d37cae 100644 --- a/strided/special/abs-by/docs/repl.txt +++ b/strided/special/abs-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/abs2-by/docs/repl.txt b/strided/special/abs2-by/docs/repl.txt index 2741e8e4f..25e2a2c7a 100644 --- a/strided/special/abs2-by/docs/repl.txt +++ b/strided/special/abs2-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/acos-by/docs/repl.txt b/strided/special/acos-by/docs/repl.txt index 496335a67..14c3a1f7a 100644 --- a/strided/special/acos-by/docs/repl.txt +++ b/strided/special/acos-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/acosh-by/docs/repl.txt b/strided/special/acosh-by/docs/repl.txt index 1d7cdc5a8..59e173a2b 100644 --- a/strided/special/acosh-by/docs/repl.txt +++ b/strided/special/acosh-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/acot-by/docs/repl.txt b/strided/special/acot-by/docs/repl.txt index 4ba580945..8d6952b19 100644 --- a/strided/special/acot-by/docs/repl.txt +++ b/strided/special/acot-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/acoth-by/docs/repl.txt b/strided/special/acoth-by/docs/repl.txt index 0ebfe44bc..5463cc817 100644 --- a/strided/special/acoth-by/docs/repl.txt +++ b/strided/special/acoth-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/acovercos-by/docs/repl.txt b/strided/special/acovercos-by/docs/repl.txt index cd75a3163..5eb480d8a 100644 --- a/strided/special/acovercos-by/docs/repl.txt +++ b/strided/special/acovercos-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/acoversin-by/docs/repl.txt b/strided/special/acoversin-by/docs/repl.txt index 83974a0d7..0cb896423 100644 --- a/strided/special/acoversin-by/docs/repl.txt +++ b/strided/special/acoversin-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/ahavercos-by/docs/repl.txt b/strided/special/ahavercos-by/docs/repl.txt index ac4eb60a3..c948e8583 100644 --- a/strided/special/ahavercos-by/docs/repl.txt +++ b/strided/special/ahavercos-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/ahaversin-by/docs/repl.txt b/strided/special/ahaversin-by/docs/repl.txt index be67380f7..5ce14873e 100644 --- a/strided/special/ahaversin-by/docs/repl.txt +++ b/strided/special/ahaversin-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/asin-by/docs/repl.txt b/strided/special/asin-by/docs/repl.txt index d6a50214c..a9546a7f9 100644 --- a/strided/special/asin-by/docs/repl.txt +++ b/strided/special/asin-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/asinh-by/docs/repl.txt b/strided/special/asinh-by/docs/repl.txt index b81e7bf03..028ec2a42 100644 --- a/strided/special/asinh-by/docs/repl.txt +++ b/strided/special/asinh-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/atan-by/docs/repl.txt b/strided/special/atan-by/docs/repl.txt index 3661b9884..5bc316007 100644 --- a/strided/special/atan-by/docs/repl.txt +++ b/strided/special/atan-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/atanh-by/docs/repl.txt b/strided/special/atanh-by/docs/repl.txt index 0b7204560..64dd03448 100644 --- a/strided/special/atanh-by/docs/repl.txt +++ b/strided/special/atanh-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/avercos-by/docs/repl.txt b/strided/special/avercos-by/docs/repl.txt index 42673421c..53ee26862 100644 --- a/strided/special/avercos-by/docs/repl.txt +++ b/strided/special/avercos-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/aversin-by/docs/repl.txt b/strided/special/aversin-by/docs/repl.txt index 3d194b0e3..8c56f064f 100644 --- a/strided/special/aversin-by/docs/repl.txt +++ b/strided/special/aversin-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/besselj0-by/docs/repl.txt b/strided/special/besselj0-by/docs/repl.txt index 9e8eecbd8..a6a4b2000 100644 --- a/strided/special/besselj0-by/docs/repl.txt +++ b/strided/special/besselj0-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/besselj1-by/docs/repl.txt b/strided/special/besselj1-by/docs/repl.txt index cefaf9c00..fde06b4fd 100644 --- a/strided/special/besselj1-by/docs/repl.txt +++ b/strided/special/besselj1-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/bessely0-by/docs/repl.txt b/strided/special/bessely0-by/docs/repl.txt index 2c7c92519..3fa9f8e52 100644 --- a/strided/special/bessely0-by/docs/repl.txt +++ b/strided/special/bessely0-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/bessely1-by/docs/repl.txt b/strided/special/bessely1-by/docs/repl.txt index 5b0ef2a1e..b7135b559 100644 --- a/strided/special/bessely1-by/docs/repl.txt +++ b/strided/special/bessely1-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/binet-by/docs/repl.txt b/strided/special/binet-by/docs/repl.txt index 31a67a273..c9544d816 100644 --- a/strided/special/binet-by/docs/repl.txt +++ b/strided/special/binet-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/cbrt-by/docs/repl.txt b/strided/special/cbrt-by/docs/repl.txt index 7ae2dffd7..80ce41596 100644 --- a/strided/special/cbrt-by/docs/repl.txt +++ b/strided/special/cbrt-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/cos-by/docs/repl.txt b/strided/special/cos-by/docs/repl.txt index e8dcaf927..a2349592e 100644 --- a/strided/special/cos-by/docs/repl.txt +++ b/strided/special/cos-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/dcbrt-by/docs/repl.txt b/strided/special/dcbrt-by/docs/repl.txt index 0eaba82e6..c59403749 100644 --- a/strided/special/dcbrt-by/docs/repl.txt +++ b/strided/special/dcbrt-by/docs/repl.txt @@ -13,10 +13,10 @@ The callback function is provided four arguments: - - value: array element - - idx: iteration index - - indices: strided array indices (offset + idx*stride) - - arrays: input and output arrays + - value: array element. + - idx: iteration index. + - indices: strided array indices (offset + idx*stride). + - arrays: input and output arrays. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. @@ -86,10 +86,10 @@ The callback function is provided four arguments: - - value: array element - - idx: iteration index - - indices: strided array indices (offset + idx*stride) - - arrays: input and output arrays + - value: array element. + - idx: iteration index. + - indices: strided array indices (offset + idx*stride). + - arrays: input and output arrays. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/sin-by/docs/repl.txt b/strided/special/sin-by/docs/repl.txt index 364f5b140..0fcb0bf36 100644 --- a/strided/special/sin-by/docs/repl.txt +++ b/strided/special/sin-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. diff --git a/strided/special/sqrt-by/docs/repl.txt b/strided/special/sqrt-by/docs/repl.txt index 65bfc8bd7..236a89ed9 100644 --- a/strided/special/sqrt-by/docs/repl.txt +++ b/strided/special/sqrt-by/docs/repl.txt @@ -12,12 +12,12 @@ The callback function is provided six arguments: - - value: array element - - idx: iteration index - - xi: strided index (offsetX + idx*sx) - - yi: strided index (offsetY + idx*sy) - - x: the input array - - y: the destination array + - value: array element. + - idx: iteration index. + - xi: strided index (offsetX + idx*sx). + - yi: strided index (offsetY + idx*sy). + - x: the input array. + - y: the destination array. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored.