npm - @stdlib/utils-reduce - Versions diffs - 0.0.7 → 0.1.0 - Mend

@stdlib/utils-reduce 0.0.7 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

package/CITATION.cff ADDED Viewed

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+abstract: |
+  Standard library for JavaScript and Node.js.
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+license: Apache-2.0 AND BSL-1.0
+date-released: 2016

package/LICENSE CHANGED Viewed

@@ -175,307 +175,3 @@
       of your accepting any such warranty or additional liability.
    END OF TERMS AND CONDITIONS
-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.
-DEPENDENCIES
-The library links against the following external libraries, which have their own
-licenses:
-* OpenBLAS <https://raw.githubusercontent.com/xianyi/OpenBLAS/
-def146efed8d5908ea04e22668feeab7099599a0/LICENSE>
-Copyright (c) 2011-2014, The OpenBLAS Project
-All rights reserved.
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-   1. Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-   2. Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in
-      the documentation and/or other materials provided with the
-      distribution.
-   3. Neither the name of the OpenBLAS project nor the names of
-      its contributors may be used to endorse or promote products
-      derived from this software without specific prior written
-      permission.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY 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.
-* Electron <https://raw.githubusercontent.com/electron/electron/
-c4cfb3e7110266b9d7ad80e1ae097c4db564501c/LICENSE>
-Copyright (c) 2013-2017 GitHub Inc.
-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.
-* Boost <http://www.boost.org/LICENSE_1_0.txt>
-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.
-* Cephes <http://www.netlib.org/cephes/readme>
-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
-ATTRIBUTION
-The library contains implementations from the following external libraries,
-which have their own licenses:
-* FreeBSD <https://svnweb.freebsd.org/>
-Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved.
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-* FDLIBM <http://www.netlib.org/fdlibm/>
-Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
-Copyright (c) 2009 The Go Authors. All rights reserved.
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-   * Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-copyright notice, this list of conditions and the following disclaimer
-in the documentation and/or other materials provided with the
-distribution.
-   * Neither the name of Google Inc. nor the names of its
-contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-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 <http://www.netlib.no/netlib/slatec/>
-Public domain.
-* ESLint <https://raw.githubusercontent.com/eslint/eslint/master/LICENSE>
-Copyright JS Foundation and other contributors, https://js.foundation
-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.
-* StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
-e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
-Copyright (c) 2015: Dahua Lin.
-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.
-* SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
-SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
-The MIT License (MIT)
-Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others:
-https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors
-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.
-* MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
-mt19937ar.c>
-Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
-All rights reserved.
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
- 1. Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
- 2. Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
- 3. The names of its contributors may not be used to endorse or promote
-    products derived from this software without specific prior written
-    permission.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-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.

package/NOTICE CHANGED Viewed

	@@ -1 +1 @@
1	- Copyright (c) 2016-~~2021~~ The Stdlib Authors.
1	+ Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md CHANGED Viewed

@@ -18,11 +18,22 @@ limitations under the License.
 -->
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
 # reduce
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
-> Apply a function against an accumulator and each element in a collection and return the accumulated result.
+> Apply a function against an accumulator and each element in an array and return the accumulated result.
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
@@ -52,9 +63,9 @@ npm install @stdlib/utils-reduce
 var reduce = require( '@stdlib/utils-reduce' );
 ```
-#### reduce( collection, initial, reducer\[, thisArg ] )
+#### reduce( arr, initial, reducer\[, thisArg ] )
-Applies a `function` against an accumulator and each element in a `collection` and returns the accumulated result.
+Applies a function against an accumulator and each element in an array and returns the accumulated result.
 ```javascript
 function sum( accumulator, value ) {
@@ -67,40 +78,34 @@ var out = reduce( arr, 0, sum );
 // returns 10
 ```
-The `reducer` function is provided four arguments:
--   `accumulator`: accumulated value
--   `value`: collection element
--   `index`: collection index
--   `collection`: input collection
-Basic support for dynamic collections is provided. Note, however, that index incrementation is monotonically increasing.
+The function accepts both array-like objects and [`ndarray`][@stdlib/ndarray/ctor]-like objects.
 ```javascript
-function sum1( accumulator, value, index, collection ) {
-    if ( index === collection.length-1 && collection.length < 10 ) {
-        collection.push( index+2 );
-    }
+var array = require( '@stdlib/ndarray-array' );
+function sum( accumulator, value ) {
     return accumulator + value;
 }
-var arr = [ 1, 2, 3, 4 ];
+var opts = {
+    'dtype': 'generic'
+};
+var arr = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], opts );
-var out = reduce( arr, 0, sum1 );
-// returns 55
+var out = reduce( arr, 0, sum );
+// returns 21
+```
-function sum2( accumulator, value, index, collection ) {
-    collection.shift();
-    return accumulator + value;
-}
+The applied function is provided the following arguments:
-arr = [ 1, 2, 3, 4 ];
+-   **accumulator**: accumulated value.
+-   **value**: array element.
+-   **index**: element index.
+-   **arr**: input array.
-out = reduce( arr, 0, sum2 );
-// returns 4
-```
+To set the `this` context when invoking the input function, provide a `thisArg`.
-To set the function execution context, provide a `thisArg`.
+<!-- eslint-disable no-invalid-this -->
 ```javascript
 function sum( accumulator, value ) {
@@ -110,14 +115,14 @@ function sum( accumulator, value ) {
 var arr = [ 1, 2, 3, 4 ];
-var context = {
+var ctx = {
     'count': 0
 };
-var out = reduce( arr, 0, sum, context );
+var out = reduce( arr, 0, sum, ctx );
 // returns 10
-var mean = out / context.count;
+var mean = out / ctx.count;
 // returns 2.5
 ```
@@ -131,36 +136,44 @@ var mean = out / context.count;
 ## Notes
--   A `collection` may be either an [`Array`][mdn-array], [`Typed Array`][mdn-typed-array], or an array-like [`Object`][mdn-object] (excluding `strings` and `functions`).
--   The function differs from [`Array.prototype.reduce`][mdn-array-reduce] in the following ways:
+-   For input arrays, the function differs from [`Array.prototype.reduce`][mdn-array-reduce] in the following ways:
     -   The function **requires** an `initial` value for the `accumulator`. The `initial` value is used during the first invocation of the `reducer` function.
-    -   The function does **not** skip the first element in the `collection`.
+    -   The function does **not** skip the first array element.
     -   The function does **not** skip `undefined` elements.
+    -   The function does **not** support dynamic array-like objects (i.e., array-like objects whose `length` changes during execution).
+-   The function supports array-like objects exposing getters and setters for array element access (e.g., [`Complex64Array`][@stdlib/array/complex64], [`Complex128Array`][@stdlib/array/complex128], etc).
+    ```javascript
+    var Complex64Array = require( '@stdlib/array-complex64' );
+    var Complex64 = require( '@stdlib/complex-float32' );
+    var realf = require( '@stdlib/complex-realf' );
+    var imagf = require( '@stdlib/complex-imagf' );
+    function sum( acc, z ) {
+        var re1 = realf( acc );
+        var im1 = imagf( acc );
+        var re2 = realf( z );
+        var im2 = imagf( z );
+        return new Complex64( re1+re2, im1+im2 );
+    }
-        <!-- eslint-disable no-sparse-arrays, stdlib/doctest-marker -->
+    var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
-        ```javascript
-        function log( accumulator, value, index ) {
-            console.log( '%s: %s', index, value );
-            return accumulator;
-        }
+    var v = reduce( x, new Complex64( 0.0, 0.0 ), sum );
+    // returns <Complex64>
-        var arr = [ 1, , , 4 ];
+    var re = realf( v );
+    // returns 16.0
-        var out = reduce( arr, 0, log );
-        /* =>
-            0: 1
-            1: undefined
-            2: undefined
-            3: 4
-        */
-        ```
+    var im = imagf( v );
+    // returns 20.0
+    ```
-    -   The function provides limited support for dynamic collections (i.e., collections whose `length` changes during execution).
+-   For [`ndarray`][@stdlib/ndarray/ctor]-like objects, the function performs a reduction over the entire input [`ndarray`][@stdlib/ndarray/ctor] (i.e., higher-order [`ndarray`][@stdlib/ndarray/ctor] dimensions are flattened to a single-dimension).
+-   When applying a function to [`ndarray`][@stdlib/ndarray/ctor]-like objects, performance will be best for [`ndarray`][@stdlib/ndarray/ctor]-like objects which are single-segment contiguous.
 </section>
@@ -175,23 +188,34 @@ var mean = out / context.count;
 <!-- eslint no-undef: "error" -->
 ```javascript
+var filledarrayBy = require( '@stdlib/array-filled-by' );
+var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
+var naryFunction = require( '@stdlib/utils-nary-function' );
+var add = require( '@stdlib/math-base-ops-add' );
+var array = require( '@stdlib/ndarray-array' );
 var reduce = require( '@stdlib/utils-reduce' );
-var arr;
-var s;
-var i;
-function sum( acc, value ) {
-    return acc + value;
+function fill( i ) {
+    var rand = discreteUniform( -10*(i+1), 10*(i+1) );
+    return filledarrayBy( 10, 'generic', rand );
 }
-arr = new Array( 1000 );
-for ( i = 0; i < arr.length; i++ ) {
-    arr[ i ] = i;
-}
+// Create a two-dimensional ndarray (i.e., a matrix):
+var x = array( filledarrayBy( 10, 'generic', fill ), {
+    'dtype': 'generic',
+    'flatten': true
+});
+// Create an explicit binary function:
+var f = naryFunction( add, 2 );
+// Compute the sum:
+var out = reduce( x, 0, f );
-s = reduce( arr, 0, sum );
-console.log( s );
+console.log( 'x:' );
+console.log( x.data );
+console.log( 'sum: %d', out );
 ```
 </section>
@@ -206,6 +230,22 @@ console.log( s );
 <!-- /.references -->
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+<section class="related">
+* * *
+## See Also
+-   <span class="package-name">[`@stdlib/utils-for-each`][@stdlib/utils/for-each]</span><span class="delimiter">: </span><span class="description">invoke a function for each element in a collection.</span>
+-   <span class="package-name">[`@stdlib/utils-async/reduce`][@stdlib/utils/async/reduce]</span><span class="delimiter">: </span><span class="description">apply a function against an accumulator and each element in a collection and return the accumulated result.</span>
+-   <span class="package-name">[`@stdlib/utils-reduce-right`][@stdlib/utils/reduce-right]</span><span class="delimiter">: </span><span class="description">apply a function against an accumulator and each element in a collection and return the accumulated result, iterating from right to left.</span>
+</section>
+<!-- /.related -->
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
@@ -232,7 +272,7 @@ See [LICENSE][stdlib-license].
 ## Copyright
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 </section>
@@ -245,31 +285,53 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-reduce.svg
 [npm-url]: https://npmjs.org/package/@stdlib/utils-reduce
-[test-image]: https://github.com/stdlib-js/utils-reduce/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/utils-reduce/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/utils-reduce/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/utils-reduce/actions/workflows/test.yml?query=branch:v0.1.0
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-reduce/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/utils-reduce?branch=main
+<!--
 [dependencies-image]: https://img.shields.io/david/stdlib-js/utils-reduce.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/utils-reduce/main
+-->
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 [stdlib]: https://github.com/stdlib-js/stdlib
 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+[deno-url]: https://github.com/stdlib-js/utils-reduce/tree/deno
+[umd-url]: https://github.com/stdlib-js/utils-reduce/tree/umd
+[esm-url]: https://github.com/stdlib-js/utils-reduce/tree/esm
+[branches-url]: https://github.com/stdlib-js/utils-reduce/blob/main/branches.md
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-reduce/main/LICENSE
-[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
+[mdn-array-reduce]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce
-[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/stdlib
-[mdn-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
+[@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/stdlib
-[mdn-array-reduce]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce
+[@stdlib/array/complex128]: https://www.npmjs.com/package/@stdlib/stdlib
+<!-- <related-links> -->
+[@stdlib/utils/for-each]: https://www.npmjs.com/package/@stdlib/utils-for-each
+[@stdlib/utils/async/reduce]: https://www.npmjs.com/package/@stdlib/utils-async-reduce
+[@stdlib/utils/reduce-right]: https://www.npmjs.com/package/@stdlib/utils-reduce-right
+<!-- </related-links> -->
 </section>

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import reduce from '../docs/types/index';
+export = reduce;