@stdlib/math-strided-special-abs-by 0.0.7 → 0.1.0

package/CITATION.cff

@@ -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/NOTICE

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

package/README.md

@@ -20,6 +20,17 @@ limitations under the License.
 
 <!-- lint disable maximum-heading-length -->
 
+
+<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>
+
 # absBy
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -210,8 +221,9 @@ absBy.ndarray( 3, x, 2, 1, y, -1, y.length-1, accessor );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
+var uniform = require( '@stdlib/random-base-uniform' ).factory;
 var filledarray = require( '@stdlib/array-filled' );
+var filledarrayBy = require( '@stdlib/array-filled-by' );
 var absBy = require( '@stdlib/math-strided-special-abs-by' );
 
 function accessor( v, i ) {
@@ -222,14 +234,10 @@ function accessor( v, i ) {
     return v;
 }
 
-var x = filledarray( 0.0, 10, 'generic' );
-var y = filledarray( null, 10, 'generic' );
-
-var i;
-for ( i = 0; i < x.length; i++ ) {
-    x[ i ] = discreteUniform( -100, 100 );
-}
+var x = filledarrayBy( 10, 'generic', uniform( -100.0, 100.0 ) );
 console.log( x );
+
+var y = filledarray( null, 10, 'generic' );
 console.log( y );
 
 absBy.ndarray( x.length, x, 1, 0, y, -1, y.length-1, accessor );
@@ -248,8 +256,8 @@ console.log( y );
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/math/strided/special/abs`][@stdlib/math/strided/special/abs]</span><span class="delimiter">: </span><span class="description">compute the absolute value for each element in a strided array.</span>
--   <span class="package-name">[`@stdlib/math/strided/special/abs2-by`][@stdlib/math/strided/special/abs2-by]</span><span class="delimiter">: </span><span class="description">compute the squared absolute value of each element retrieved from an input strided array via a callback function.</span>
+-   <span class="package-name">[`@stdlib/math-strided/special/abs`][@stdlib/math/strided/special/abs]</span><span class="delimiter">: </span><span class="description">compute the absolute value for each element in a strided array.</span>
+-   <span class="package-name">[`@stdlib/math-strided/special/abs2-by`][@stdlib/math/strided/special/abs2-by]</span><span class="delimiter">: </span><span class="description">compute the squared absolute value of each element retrieved from an input strided array via a callback function.</span>
 
 </section>
 
@@ -281,7 +289,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -294,8 +302,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/math-strided-special-abs-by.svg
 [npm-url]: https://npmjs.org/package/@stdlib/math-strided-special-abs-by
 
-[test-image]: https://github.com/stdlib-js/math-strided-special-abs-by/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/math-strided-special-abs-by/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/math-strided-special-abs-by/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/math-strided-special-abs-by/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-strided-special-abs-by/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-strided-special-abs-by?branch=main
@@ -308,7 +316,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 -->
 
 [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
 

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var q=n(function(h,y){
+var d=require('@stdlib/strided-base-map-by/dist'),B=require('@stdlib/math-base-special-abs/dist');function m(e,r,a,s,t,u,i){return d(e,r,a,s,t,B,u,i)}y.exports=m
+});var c=n(function(j,v){
+var x=require('@stdlib/strided-base-map-by/dist').ndarray,f=require('@stdlib/math-base-special-abs/dist');function l(e,r,a,s,t,u,i,p,b){return x(e,r,a,s,t,u,i,f,p,b)}v.exports=l
+});var O=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=q(),R=c();O(o,"ndarray",R);module.exports=o;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/ndarray.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2021 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar mapBy = require( '@stdlib/strided-base-map-by' );\nvar abs = require( '@stdlib/math-base-special-abs' );\n\n\n// MAIN //\n\n/**\n* Computes the absolute value of each element retrieved from a strided input array `x` via a callback function and assigns each result to an element in a strided output array `y`.\n*\n* @param {NonNegativeInteger} N - number of indexed elements\n* @param {Collection} x - input array/collection\n* @param {integer} strideX - `x` stride length\n* @param {Collection} y - destination array/collection\n* @param {integer} strideY - `y` stride length\n* @param {Callback} clbk - callback\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} `y`\n*\n* @example\n* function accessor( v ) {\n*     return v * 2.0;\n* }\n*\n* var x = [ 1.0, -2.0, 3.0, -4.0, 5.0 ];\n* var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];\n*\n* absBy( x.length, x, 1, y, 1, accessor );\n*\n* console.log( y );\n* // => [ 2.0, 4.0, 6.0, 8.0, 10.0 ]\n*/\nfunction absBy( N, x, strideX, y, strideY, clbk, thisArg ) {\n\treturn mapBy( N, x, strideX, y, strideY, abs, clbk, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = absBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2021 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar mapBy = require( '@stdlib/strided-base-map-by' ).ndarray;\nvar abs = require( '@stdlib/math-base-special-abs' );\n\n\n// MAIN //\n\n/**\n* Computes the absolute value of each element retrieved from a strided input array `x` via a callback function and assigns each result to an element in a strided output array `y`.\n*\n* @param {NonNegativeInteger} N - number of indexed elements\n* @param {Collection} x - input array/collection\n* @param {integer} strideX - `x` stride length\n* @param {NonNegativeInteger} offsetX - starting `x` index\n* @param {Collection} y - destination array/collection\n* @param {integer} strideY - `y` stride length\n* @param {NonNegativeInteger} offsetY - starting `y` index\n* @param {Callback} clbk - callback\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} `y`\n*\n* @example\n* function accessor( v ) {\n*     return v * 2.0;\n* }\n*\n* var x = [ 1.0, -2.0, 3.0, -4.0, 5.0 ];\n* var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];\n*\n* absBy( x.length, x, 1, 0, y, 1, 0, accessor );\n*\n* console.log( y );\n* // => [ 2.0, 4.0, 6.0, 8.0, 10.0 ]\n*/\nfunction absBy( N, x, strideX, offsetX, y, strideY, offsetY, clbk, thisArg ) {\n\treturn mapBy( N, x, strideX, offsetX, y, strideY, offsetY, abs, clbk, thisArg ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = absBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2021 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Compute the absolute value of each element retrieved from a strided input array `x` via a callback function and assign each result to an element in a strided output array `y`.\n*\n* @module @stdlib/math-strided-special-abs-by\n*\n* @example\n* var absBy = require( '@stdlib/math-strided-special-abs-by' );\n*\n* function accessor( v ) {\n*     return v * 2.0;\n* }\n*\n* var x = [ 1.0, -2.0, 3.0, -4.0, 5.0 ];\n* var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];\n*\n* absBy( x.length, x, 1, y, 1, accessor );\n*\n* console.log( y );\n* // => [ 2.0, 4.0, 6.0, 8.0, 10.0 ]\n*\n* @example\n* var absBy = require( '@stdlib/math-strided-special-abs-by' );\n*\n* function accessor( v ) {\n*     return v * 2.0;\n* }\n*\n* var x = [ 1.0, -2.0, 3.0, -4.0, 5.0 ];\n* var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];\n*\n* absBy.ndarray( x.length, x, 1, 0, y, 1, 0, accessor );\n*\n* console.log( y );\n* // => [ 2.0, 4.0, 6.0, 8.0, 10.0 ]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,6BAA8B,EAC/CC,EAAM,QAAS,+BAAgC,EA8BnD,SAASC,EAAOC,EAAGC,EAAGC,EAASC,EAAGC,EAASC,EAAMC,EAAU,CAC1D,OAAOT,EAAOG,EAAGC,EAAGC,EAASC,EAAGC,EAASN,EAAKO,EAAMC,CAAQ,CAC7D,CAKAV,EAAO,QAAUG,IC5DjB,IAAAQ,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,6BAA8B,EAAE,QACjDC,EAAM,QAAS,+BAAgC,EAgCnD,SAASC,EAAOC,EAAGC,EAAGC,EAASC,EAASC,EAAGC,EAASC,EAASC,EAAMC,EAAU,CAC5E,OAAOX,EAAOG,EAAGC,EAAGC,EAASC,EAASC,EAAGC,EAASC,EAASR,EAAKS,EAAMC,CAAQ,CAC/E,CAKAZ,EAAO,QAAUG,ICJjB,IAAIU,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "mapBy", "abs", "absBy", "N", "x", "strideX", "y", "strideY", "clbk", "thisArg", "require_ndarray", "__commonJSMin", "exports", "module", "mapBy", "abs", "absBy", "N", "x", "strideX", "offsetX", "y", "strideY", "offsetY", "clbk", "thisArg", "setReadOnly", "main", "ndarray"]
+}

package/docs/types/index.d.ts

@@ -16,18 +16,18 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/object';
+import { Collection } from '@stdlib/types/array';
 
 /**
 * Returns an accessed value.
 *
 * @returns accessed value
 */
-type Nullary = () => number | void;
+type Nullary<V> = ( this: V ) => number | void;
 
 /**
 * Returns an accessed value.
@@ -35,7 +35,7 @@ type Nullary = () => number | void;
 * @param value - array element
 * @returns accessed value
 */
-type Unary = ( value: any ) => number | void;
+type Unary<T, V> = ( this: V, value: T ) => number | void;
 
 /**
 * Returns an accessed value.
@@ -44,7 +44,7 @@ type Unary = ( value: any ) => number | void;
 * @param idx - iteration index
 * @returns accessed value
 */
-type Binary = ( value: any, idx: number ) => number | void;
+type Binary<T, V> = ( this: V, value: T, idx: number ) => number | void;
 
 /**
 * Returns an accessed value.
@@ -54,7 +54,7 @@ type Binary = ( value: any, idx: number ) => number | void;
 * @param xi - strided index (offsetX + idx*strideX)
 * @returns accessed value
 */
-type Ternary = ( value: any, idx: number, xi: number ) => number | void;
+type Ternary<T, V> = ( this: V, value: T, idx: number, xi: number ) => number | void;
 
 /**
 * Returns an accessed value.
@@ -65,8 +65,7 @@ type Ternary = ( value: any, idx: number, xi: number ) => number | void;
 * @param yi - strided index (offsetY + idx*strideY)
 * @returns accessed value
 */
-type Quaternary = ( value: any, idx: number, xi: number, yi: number ) => number | void; // tslint-disable-line max-line-length
-
+type Quaternary<T, V> = ( this: V, value: T, idx: number, xi: number, yi: number ) => number | void;
 /**
 * Returns an accessed value.
 *
@@ -77,8 +76,7 @@ type Quaternary = ( value: any, idx: number, xi: number, yi: number ) => number
 * @param x - input array
 * @returns accessed value
 */
-type Quinary = ( value: any, idx: number, xi: number, yi: number, x: Collection ) => number | void; // tslint-disable-line max-line-length
-
+type Quinary<T, V> = ( this: V, value: T, idx: number, xi: number, yi: number, x: Collection<T> ) => number | void;
 /**
 * Returns an accessed value.
 *
@@ -90,8 +88,7 @@ type Quinary = ( value: any, idx: number, xi: number, yi: number, x: Collection
 * @param y - output array
 * @returns accessed value
 */
-type Senary = ( value: any, idx: number, xi: number, yi: number, x: Collection, y: Collection ) => number | void; // tslint-disable-line max-line-length
-
+type Senary<T, U, V> = ( this: V, value: T, idx: number, xi: number, yi: number, x: Collection<T>, y: Collection<U> ) => number | void;
 /**
 * Returns an accessed value.
 *
@@ -103,7 +100,7 @@ type Senary = ( value: any, idx: number, xi: number, yi: number, x: Collection,
 * @param y - output array
 * @returns accessed value
 */
-type Callback = Nullary | Unary | Binary | Ternary | Quaternary | Quinary | Senary; // tslint-disable-line max-line-length
+type Callback<T, U, V> = Nullary<V> | Unary<T, V> | Binary<T, V> | Ternary<T, V> | Quaternary<T, V> | Quinary<T, V> | Senary<T, U, V>;
 
 /**
 * Interface describing `absBy`.
@@ -132,7 +129,7 @@ interface Routine {
 	* absBy( x.length, x, 1, y, 1, accessor );
 	* // y => [ 2.0, 4.0, 6.0, 8.0, 10.0 ]
 	*/
-	( N: number, x: Collection, strideX: number, y: Collection, strideY: number, clbk: Callback, thisArg?: any ): Collection; // tslint:disable-line:max-line-length
+	<T = unknown, U = unknown, V = unknown>( N: number, x: Collection<T>, strideX: number, y: Collection<U>, strideY: number, clbk: Callback<T, U, V>, thisArg?: ThisParameterType<Callback<T, U, V>> ): Collection<U | number>;
 
 	/**
 	* Computes the absolute value of each element retrieved from a strided input array `x` via a callback function and assigns each result to an element in a strided output array `y` using alternative indexing semantics.
@@ -159,7 +156,7 @@ interface Routine {
 	* absBy.ndarray( x.length, x, 1, 0, y, 1, 0, accessor );
 	* // y => [ 2.0, 4.0, 6.0, 8.0, 10.0 ]
 	*/
-	ndarray( N: number, x: Collection, strideX: number, offsetX: number, y: Collection, strideY: number, offsetY: number, clbk: Callback, thisArg?: any ): Collection; // tslint:disable-line:max-line-length
+	ndarray<T = unknown, U = unknown, V = unknown>( N: number, x: Collection<T>, strideX: number, offsetX: number, y: Collection<U>, strideY: number, offsetY: number, clbk: Callback<T, U, V>, thisArg?: ThisParameterType<Callback<T, U, V>> ): Collection<U | number>;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/math-strided-special-abs-by",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Compute the absolute value of each element retrieved from a strided input array via a callback function and assign each result to an element in a strided output array.",
   "license": "Apache-2.0",
   "author": {
@@ -37,23 +37,23 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-special-abs": "^0.0.x",
-    "@stdlib/strided-base-map-by": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/math-base-special-abs": "^0.1.0",
+    "@stdlib/strided-base-map-by": "^0.1.0",
+    "@stdlib/types": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-filled": "^0.0.x",
-    "@stdlib/array-float64": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-special-pow": "^0.0.x",
-    "@stdlib/math-strided-special-dabs": "^0.0.x",
-    "@stdlib/random-base-discrete-uniform": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/array-filled": "^0.0.6",
+    "@stdlib/array-filled-by": "^0.0.2",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-special-pow": "^0.1.0",
+    "@stdlib/math-strided-special-dabs": "^0.1.0",
+    "@stdlib/random-base-uniform": "^0.0.6",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -92,7 +92,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,142 +0,0 @@
-
-{{alias}}( N, x, sx, y, sy, clbk[, thisArg] )
-    Computes the absolute value of each element retrieved from a strided input
-    array `x` via a callback function and assigns each result to an element in a
-    strided output array `y`.
-
-    The `N` and stride parameters determine which elements in `x` and `y` are
-    accessed at runtime.
-
-    Indexing is relative to the first index. To introduce an offset, use typed
-    array views.
-
-    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
-
-    If the callback function does not return any value (or equivalently,
-    explicitly returns `undefined`), the value is ignored.
-
-    Parameters
-    ----------
-    N: integer
-        Number of indexed elements.
-
-    x: Array|TypedArray|Object
-        Input array/collection. If provided an object, the object must be array-
-        like (excluding strings and functions).
-
-    sx: integer
-        Index increment for `x`.
-
-    y: Array|TypedArray|Object
-        Destination array/collection. If provided an object, the object must be
-        array-like (excluding strings and functions).
-
-    sy: integer
-        Index increment for `y`.
-
-    clbk: Function
-        Callback function.
-
-    thisArg: any (optional)
-        Callback execution context.
-
-    Returns
-    -------
-    y: Array|TypedArray|Object
-        Destination array/collection.
-
-    Examples
-    --------
-    // Standard usage:
-    > var x = [ 1.0, -2.0, 3.0, -4.0 ];
-    > var y = [ 0.0, 0.0, 0.0, 0.0 ];
-    > function clbk( v ) { return v * 2.0; };
-    > {{alias}}( x.length, x, 1, y, 1, clbk )
-    [ 2.0, 4.0, 6.0, 8.0 ]
-
-    // Using `N` and stride parameters:
-    > y = [ 0.0, 0.0, 0.0, 0.0 ];
-    > {{alias}}( 2, x, 2, y, -1, clbk )
-    [ 6.0, 2.0, 0.0, 0.0 ]
-
-    // Using view offsets:
-    > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0 ] );
-    > var y0 = new {{alias:@stdlib/array/float64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
-    > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > var y1 = new {{alias:@stdlib/array/float64}}( y0.buffer, y0.BYTES_PER_ELEMENT*2 );
-    > {{alias}}( 2, x1, -2, y1, 1, clbk )
-    <Float64Array>[ 8.0, 4.0 ]
-    > y0
-    <Float64Array>[ 0.0, 0.0, 8.0, 4.0 ]
-
-
-{{alias}}.ndarray( N, x, sx, ox, y, sy, oy, clbk[, thisArg] )
-    Computes the absolute value of each element retrieved from a strided input
-    array `x` via a callback function and assigns each result to an element in a
-    strided output array `y` using alternative indexing semantics.
-
-    While typed array views mandate a view offset based on the underlying
-    buffer, the offset parameters support indexing semantics based on starting
-    indices.
-
-    Parameters
-    ----------
-    N: integer
-        Number of indexed elements.
-
-    x: Array|TypedArray|Object
-        Input array/collection. If provided an object, the object must be array-
-        like (excluding strings and functions).
-
-    sx: integer
-        Index increment for `x`.
-
-    ox: integer
-        Starting index for `x`.
-
-    y: Array|TypedArray|Object
-        Destination array/collection. If provided an object, the object must be
-        array-like (excluding strings and functions).
-
-    sy: integer
-        Index increment for `y`.
-
-    oy: integer
-        Starting index for `y`.
-
-    clbk: Function
-        Callback function.
-
-    thisArg: any (optional)
-        Callback execution context.
-
-    Returns
-    -------
-    y: Array|TypedArray|Object
-        Destination array/collection.
-
-    Examples
-    --------
-    // Standard usage:
-    > var x = [ 1.0, -2.0, 3.0, -4.0 ];
-    > var y = [ 0.0, 0.0, 0.0, 0.0 ];
-    > function clbk( v ) { return v * 2.0; };
-    > {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0, clbk )
-    [ 2.0, 4.0, 6.0, 8.0 ]
-
-    // Advanced indexing:
-    > x = [ 1.0, -2.0, 3.0, -4.0 ];
-    > y = [ 0.0, 0.0, 0.0, 0.0 ];
-    > {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1, clbk )
-    [ 0.0, 0.0, 8.0, 4.0 ]
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,279 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2021 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-import absBy = require( './index' );
-
-/**
-* Accessor callback.
-*
-* @returns accessed value
-*/
-function accessor(): number {
-	return 5.0;
-}
-
-
-// TESTS //
-
-// The function returns a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy( x.length, x, 1, y, 1, accessor ); // $ExpectType Collection
-	absBy( x.length, x, 1, y, 1, accessor, {} ); // $ExpectType Collection
-}
-
-// The compiler throws an error if the function is provided a first argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy( '10', x, 1, y, 1, accessor ); // $ExpectError
-	absBy( true, x, 1, y, 1, accessor ); // $ExpectError
-	absBy( false, x, 1, y, 1, accessor ); // $ExpectError
-	absBy( null, x, 1, y, 1, accessor ); // $ExpectError
-	absBy( undefined, x, 1, y, 1, accessor ); // $ExpectError
-	absBy( [], x, 1, y, 1, accessor ); // $ExpectError
-	absBy( {}, x, 1, y, 1, accessor ); // $ExpectError
-	absBy( ( x: number ): number => x, x, 1, y, 1, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy( x.length, 10, 1, y, 1, accessor ); // $ExpectError
-	absBy( x.length, true, 1, y, 1, accessor ); // $ExpectError
-	absBy( x.length, false, 1, y, 1, accessor ); // $ExpectError
-	absBy( x.length, null, 1, y, 1, accessor ); // $ExpectError
-	absBy( x.length, undefined, 1, y, 1, accessor ); // $ExpectError
-	absBy( x.length, {}, 1, y, 1, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a third argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy( x.length, x, '10', y, 1, accessor ); // $ExpectError
-	absBy( x.length, x, true, y, 1, accessor ); // $ExpectError
-	absBy( x.length, x, false, y, 1, accessor ); // $ExpectError
-	absBy( x.length, x, null, y, 1, accessor ); // $ExpectError
-	absBy( x.length, x, undefined, y, 1, accessor ); // $ExpectError
-	absBy( x.length, x, [], y, 1, accessor ); // $ExpectError
-	absBy( x.length, x, {}, y, 1, accessor ); // $ExpectError
-	absBy( x.length, x, ( x: number ): number => x, y, 1, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a fourth argument which is not a collection...
-{
-	const x = new Float64Array( 10 );
-
-	absBy( x.length, x, 1, 10, 1, accessor ); // $ExpectError
-	absBy( x.length, x, 1, true, 1, accessor ); // $ExpectError
-	absBy( x.length, x, 1, false, 1, accessor ); // $ExpectError
-	absBy( x.length, x, 1, null, 1, accessor ); // $ExpectError
-	absBy( x.length, x, 1, undefined, 1, accessor ); // $ExpectError
-	absBy( x.length, x, 1, {}, 1, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a fifth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy( x.length, x, 1, y, '10', accessor ); // $ExpectError
-	absBy( x.length, x, 1, y, true, accessor ); // $ExpectError
-	absBy( x.length, x, 1, y, false, accessor ); // $ExpectError
-	absBy( x.length, x, 1, y, null, accessor ); // $ExpectError
-	absBy( x.length, x, 1, y, undefined, accessor ); // $ExpectError
-	absBy( x.length, x, 1, y, [], accessor ); // $ExpectError
-	absBy( x.length, x, 1, y, {}, accessor ); // $ExpectError
-	absBy( x.length, x, 1, y, ( x: number ): number => x, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a sixth argument which is not a function...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy( x.length, x, 1, y, 1, '10' ); // $ExpectError
-	absBy( x.length, x, 1, y, 1, 0 ); // $ExpectError
-	absBy( x.length, x, 1, y, 1, true ); // $ExpectError
-	absBy( x.length, x, 1, y, 1, false ); // $ExpectError
-	absBy( x.length, x, 1, y, 1, null ); // $ExpectError
-	absBy( x.length, x, 1, y, 1, undefined ); // $ExpectError
-	absBy( x.length, x, 1, y, 1, [] ); // $ExpectError
-	absBy( x.length, x, 1, y, 1, {} ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy(); // $ExpectError
-	absBy( x.length ); // $ExpectError
-	absBy( x.length, x ); // $ExpectError
-	absBy( x.length, x, 1 ); // $ExpectError
-	absBy( x.length, x, 1, y ); // $ExpectError
-	absBy( x.length, x, 1, y, 1 ); // $ExpectError
-	absBy( x.length, x, 1, y, 1, accessor, 10, 10 ); // $ExpectError
-}
-
-// Attached to main export is an `ndarray` method which returns a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, accessor ); // $ExpectType Collection
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, accessor, {} ); // $ExpectType Collection
-}
-
-// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy.ndarray( '10', x, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( true, x, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( false, x, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( null, x, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( undefined, x, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( [], x, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( {}, x, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( ( x: number ): number => x, x, 1, 0, y, 1, 0, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a second argument which is not a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy.ndarray( x.length, 10, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, true, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, false, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, null, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, undefined, 1, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, {}, 1, 0, y, 1, 0, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy.ndarray( x.length, x, '10', 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, true, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, false, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, null, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, undefined, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, [], 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, {}, 0, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, ( x: number ): number => x, 0, y, 1, 0, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy.ndarray( x.length, x, 1, '10', y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, true, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, false, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, null, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, undefined, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, [], y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, {}, y, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a collection...
-{
-	const x = new Float64Array( 10 );
-
-	absBy.ndarray( x.length, x, 1, 0, 10, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, true, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, false, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, null, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, undefined, 1, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, {}, 1, 0, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy.ndarray( x.length, x, 1, 0, y, '10', 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, true, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, false, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, null, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, undefined, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, [], 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, {}, 0, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 0, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy.ndarray( x.length, x, 1, 0, y, 1, '10', accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, true, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, false, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, null, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, undefined, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, [], accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, {}, accessor ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, ( x: number ): number => x, accessor ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided an eighth argument which is not a function...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, '10' ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, 0 ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, true ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, false ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, null ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, undefined ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, [] ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, {} ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	absBy.ndarray(); // $ExpectError
-	absBy.ndarray( x.length ); // $ExpectError
-	absBy.ndarray( x.length, x ); // $ExpectError
-	absBy.ndarray( x.length, x, 1 ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0 ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectError
-	absBy.ndarray( x.length, x, 1, 0, y, 1, 0, accessor, 10, 10 ); // $ExpectError
-}