@stdlib/math-strided-special-sabs2 0.0.9 → 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

@@ -18,6 +18,17 @@ 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>
+
 # sabs2
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -255,7 +266,7 @@ void stdlib_strided_sabs2( const int64_t N, const float *X, const int64_t stride
 #include <stdint.h>
 #include <stdio.h>
 
-int main() {
+int main( void ) {
     // Create an input strided array:
     float X[] = { -1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0 };
 
@@ -295,9 +306,9 @@ int main() {
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/math/strided/special/abs2`][@stdlib/math/strided/special/abs2]</span><span class="delimiter">: </span><span class="description">compute the squared absolute value for each element in a strided array.</span>
--   <span class="package-name">[`@stdlib/math/strided/special/dabs2`][@stdlib/math/strided/special/dabs2]</span><span class="delimiter">: </span><span class="description">compute the squared absolute value for each element in a double-precision floating-point strided array.</span>
--   <span class="package-name">[`@stdlib/math/strided/special/sabs`][@stdlib/math/strided/special/sabs]</span><span class="delimiter">: </span><span class="description">compute the absolute value for each element in a single-precision floating-point strided array.</span>
+-   <span class="package-name">[`@stdlib/math-strided/special/abs2`][@stdlib/math/strided/special/abs2]</span><span class="delimiter">: </span><span class="description">compute the squared absolute value for each element in a strided array.</span>
+-   <span class="package-name">[`@stdlib/math-strided/special/dabs2`][@stdlib/math/strided/special/dabs2]</span><span class="delimiter">: </span><span class="description">compute the squared absolute value for each element in a double-precision floating-point strided array.</span>
+-   <span class="package-name">[`@stdlib/math-strided/special/sabs`][@stdlib/math/strided/special/sabs]</span><span class="delimiter">: </span><span class="description">compute the absolute value for each element in a single-precision floating-point strided array.</span>
 
 </section>
 
@@ -329,7 +340,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>
 
@@ -342,8 +353,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/math-strided-special-sabs2.svg
 [npm-url]: https://npmjs.org/package/@stdlib/math-strided-special-sabs2
 
-[test-image]: https://github.com/stdlib-js/math-strided-special-sabs2/actions/workflows/test.yml/badge.svg?branch=v0.0.9
-[test-url]: https://github.com/stdlib-js/math-strided-special-sabs2/actions/workflows/test.yml?query=branch:v0.0.9
+[test-image]: https://github.com/stdlib-js/math-strided-special-sabs2/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/math-strided-special-sabs2/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-strided-special-sabs2/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-strided-special-sabs2?branch=main
@@ -356,7 +367,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 sabs2 from '../docs/types/index';
+export = sabs2;

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";var t=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var v=t(function(z,n){
+var y=require('@stdlib/strided-base-smap/dist'),j=require('@stdlib/math-base-special-abs2f/dist');function x(e,r,a,s,i){return y(e,r,a,s,i,j)}n.exports=x
+});var o=t(function(A,q){
+var l=require('@stdlib/strided-base-smap/dist').ndarray,R=require('@stdlib/math-base-special-abs2f/dist');function _(e,r,a,s,i,d,m){return l(e,r,a,s,i,d,m,R)}q.exports=_
+});var f=t(function(B,p){
+var E=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),c=v(),O=o();E(c,"ndarray",O);p.exports=c
+});var g=require("path").join,h=require('@stdlib/utils-try-require/dist'),k=f(),u,b=h(g(__dirname,"./native.js"));b instanceof Error?u=k:u=b;module.exports=u;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/sabs2.js", "../lib/ndarray.js", "../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 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 smap = require( '@stdlib/strided-base-smap' );\nvar abs2f = require( '@stdlib/math-base-special-abs2f' );\n\n\n// MAIN //\n\n/**\n* Computes the squared absolute value for each element in a single-precision floating-point strided array `x` and assigns the results to elements in a single-precision floating-point strided array `y`.\n*\n* @param {NonNegativeInteger} N - number of indexed elements\n* @param {Float32Array} x - input array\n* @param {integer} strideX - `x` stride length\n* @param {Float32Array} y - destination array\n* @param {integer} strideY - `y` stride length\n* @returns {Float32Array} `y`\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n*\n* var x = new Float32Array( [ -1.0, -2.0, -3.0, -4.0, -5.0 ] );\n* var y = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );\n*\n* sabs2( x.length, x, 1, y, 1 );\n* // y => <Float32Array>[ 1.0, 4.0, 9.0, 16.0, 25.0 ]\n*/\nfunction sabs2( N, x, strideX, y, strideY ) {\n\treturn smap( N, x, strideX, y, strideY, abs2f );\n}\n\n\n// EXPORTS //\n\nmodule.exports = sabs2;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 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 smap = require( '@stdlib/strided-base-smap' ).ndarray;\nvar abs2f = require( '@stdlib/math-base-special-abs2f' );\n\n\n// MAIN //\n\n/**\n* Computes the squared absolute value for each element in a single-precision floating-point strided array `x` and assigns the results to elements in a single-precision floating-point strided array `y`.\n*\n* @param {NonNegativeInteger} N - number of indexed elements\n* @param {Float32Array} x - input array\n* @param {integer} strideX - `x` stride length\n* @param {NonNegativeInteger} offsetX - starting `x` index\n* @param {Float32Array} y - destination array\n* @param {integer} strideY - `y` stride length\n* @param {NonNegativeInteger} offsetY - starting `y` index\n* @returns {Float32Array} `y`\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n*\n* var x = new Float32Array( [ -1.0, -2.0, -3.0, -4.0, -5.0 ] );\n* var y = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );\n*\n* sabs2( x.length, x, 1, 0, y, 1, 0 );\n* // y => <Float32Array>[ 1.0, 4.0, 9.0, 16.0, 25.0 ]\n*/\nfunction sabs2( N, x, strideX, offsetX, y, strideY, offsetY ) {\n\treturn smap( N, x, strideX, offsetX, y, strideY, offsetY, abs2f );\n}\n\n\n// EXPORTS //\n\nmodule.exports = sabs2;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 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 setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar sabs2 = require( './sabs2.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( sabs2, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = sabs2;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 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 squared absolute value for each element in a single-precision floating-point strided array `x` and assign the results to elements in a single-precision floating-point strided array `y`.\n*\n* @module @stdlib/math-strided-special-sabs2\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var sabs2 = require( '@stdlib/math-strided-special-sabs2' );\n*\n* var x = new Float32Array( [ -1.0, -2.0, -3.0, -4.0, -5.0 ] );\n* var y = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );\n*\n* sabs2( x.length, x, 1, y, 1 );\n* // y => <Float32Array>[ 1.0, 4.0, 9.0, 16.0, 25.0 ]\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var sabs2 = require( '@stdlib/math-strided-special-sabs2' );\n*\n* var x = new Float32Array( [ -1.0, -2.0, -3.0, -4.0, -5.0 ] );\n* var y = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );\n*\n* sabs2.ndarray( x.length, x, 1, 0, y, 1, 0 );\n* // y => <Float32Array>[ 1.0, 4.0, 9.0, 16.0, 25.0 ]\n*/\n\n// MODULES //\n\nvar join = require( 'path' ).join;\nvar tryRequire = require( '@stdlib/utils-try-require' );\nvar javascript = require( './main.js' );\n\n\n// MAIN //\n\nvar main;\nvar tmp = tryRequire( join( __dirname, './native.js' ) );\nif ( tmp instanceof Error ) {\n\tmain = javascript;\n} else {\n\tmain = tmp;\n}\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"ndarray\": \"main.ndarray\" }\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAO,QAAS,2BAA4B,EAC5CC,EAAQ,QAAS,iCAAkC,EAwBvD,SAASC,EAAOC,EAAGC,EAAGC,EAASC,EAAGC,EAAU,CAC3C,OAAOP,EAAMG,EAAGC,EAAGC,EAASC,EAAGC,EAASN,CAAM,CAC/C,CAKAF,EAAO,QAAUG,ICtDjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAO,QAAS,2BAA4B,EAAE,QAC9CC,EAAQ,QAAS,iCAAkC,EA0BvD,SAASC,EAAOC,EAAGC,EAAGC,EAASC,EAASC,EAAGC,EAASC,EAAU,CAC7D,OAAOT,EAAMG,EAAGC,EAAGC,EAASC,EAASC,EAAGC,EAASC,EAASR,CAAM,CACjE,CAKAF,EAAO,QAAUG,ICxDjB,IAAAQ,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAQ,IACRC,EAAU,IAKdF,EAAaC,EAAO,UAAWC,CAAQ,EAKvCH,EAAO,QAAUE,ICcjB,IAAIE,EAAO,QAAS,MAAO,EAAE,KACzBC,EAAa,QAAS,2BAA4B,EAClDC,EAAa,IAKbC,EACAC,EAAMH,EAAYD,EAAM,UAAW,aAAc,CAAE,EAClDI,aAAe,MACnBD,EAAOD,EAEPC,EAAOC,EAMR,OAAO,QAAUD",
+  "names": ["require_sabs2", "__commonJSMin", "exports", "module", "smap", "abs2f", "sabs2", "N", "x", "strideX", "y", "strideY", "require_ndarray", "__commonJSMin", "exports", "module", "smap", "abs2f", "sabs2", "N", "x", "strideX", "offsetX", "y", "strideY", "offsetY", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "sabs2", "ndarray", "join", "tryRequire", "javascript", "main", "tmp"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Interface describing `sabs2`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/math-strided-special-sabs2",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "description": "Compute the squared absolute value for each element in a single-precision floating-point strided array.",
   "license": "Apache-2.0",
   "author": {
@@ -41,26 +41,26 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-special-abs2f": "^0.0.x",
-    "@stdlib/strided-base-smap": "^0.0.x",
-    "@stdlib/strided-napi-smap": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
-    "@stdlib/utils-library-manifest": "^0.0.x",
-    "@stdlib/utils-try-require": "^0.0.x"
+    "@stdlib/math-base-special-abs2f": "^0.1.0",
+    "@stdlib/strided-base-smap": "^0.1.0",
+    "@stdlib/strided-napi-smap": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
+    "@stdlib/utils-library-manifest": "^0.1.0",
+    "@stdlib/utils-try-require": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-float32": "^0.0.x",
-    "@stdlib/assert-is-browser": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/math-base-assert-is-nanf": "^0.0.x",
-    "@stdlib/math-base-special-floor": "^0.0.x",
-    "@stdlib/math-base-special-pow": "^0.0.x",
-    "@stdlib/math-base-special-round": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/array-float32": "^0.1.0",
+    "@stdlib/assert-is-browser": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-assert-is-nanf": "^0.1.0",
+    "@stdlib/math-base-special-floor": "^0.1.0",
+    "@stdlib/math-base-special-pow": "^0.0.7",
+    "@stdlib/math-base-special-round": "^0.1.0",
+    "@stdlib/random-base-randu": "^0.0.8",
     "proxyquire": "^2.0.0",
     "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",
@@ -99,7 +99,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,116 +0,0 @@
-
-{{alias}}( N, x, strideX, y, strideY )
-    Computes the squared absolute value for each element in a single-precision
-    floating-point strided array `x` and assigns the results to elements in a
-    single-precision floating-point strided 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.
-
-    Parameters
-    ----------
-    N: integer
-        Number of indexed elements.
-
-    x: Float32Array
-        Input array.
-
-    strideX: integer
-        Index increment for `x`.
-
-    y: Float32Array
-        Destination array.
-
-    strideY: integer
-        Index increment for `y`.
-
-    Returns
-    -------
-    y: Float32Array
-        Input array `y`.
-
-    Examples
-    --------
-    // Standard usage:
-    > var x = new {{alias:@stdlib/array/float32}}( [ -1.0, -2.0, -3.0, -4.0 ] );
-    > var y = new {{alias:@stdlib/array/float32}}( [ 0.0, 0.0, 0.0, 0.0 ] );
-    > {{alias}}( x.length, x, 1, y, 1 )
-    <Float32Array>[ 1.0, 4.0, 9.0, 16.0 ]
-
-    // Using `N` and `stride` parameters:
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > y = new {{alias:@stdlib/array/float32}}( [ 0.0, 0.0, 0.0, 0.0 ] );
-    > {{alias}}( N, x, 2, y, -1 )
-    <Float32Array>[ 9.0, 1.0, 0.0, 0.0 ]
-
-    // Using view offsets:
-    > var x0 = new {{alias:@stdlib/array/float32}}( [ -1.0, -2.0, -3.0, -4.0 ] );
-    > var y0 = new {{alias:@stdlib/array/float32}}( [ 0.0, 0.0, 0.0, 0.0 ] );
-    > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > var y1 = new {{alias:@stdlib/array/float32}}( y0.buffer, y0.BYTES_PER_ELEMENT*2 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > {{alias}}( N, x1, -2, y1, 1 )
-    <Float32Array>[ 16.0, 4.0 ]
-    > y0
-    <Float32Array>[ 0.0, 0.0, 16.0, 4.0 ]
-
-
-{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
-    Computes the squared absolute value for each element in a single-precision
-    floating-point strided array `x` and assigns the results to elements in a
-    single-precision floating-point strided array `y` using alternative indexing
-    semantics.
-
-    While typed array views mandate a view offset based on the underlying
-    buffer, the `offsetX` and `offsetY` parameters support indexing semantics
-    based on starting indices.
-
-    Parameters
-    ----------
-    N: integer
-        Number of indexed elements.
-
-    x: Float32Array
-        Input array.
-
-    strideX: integer
-        Index increment for `x`.
-
-    offsetX: integer
-        Starting index for `x`.
-
-    y: Float32Array
-        Destination array.
-
-    strideY: integer
-        Index increment for `y`.
-
-    offsetY: integer
-        Starting index for `y`.
-
-    Returns
-    -------
-    y: Float32Array
-        Input array `y`.
-
-    Examples
-    --------
-    // Standard usage:
-    > var x = new {{alias:@stdlib/array/float32}}( [ -1.0, -2.0, -3.0, -4.0 ] );
-    > var y = new {{alias:@stdlib/array/float32}}( [ 0.0, 0.0, 0.0, 0.0 ] );
-    > {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 )
-    <Float32Array>[ 1.0, 4.0, 9.0, 16.0 ]
-
-    // Advanced indexing:
-    > x = new {{alias:@stdlib/array/float32}}( [ -1.0, -2.0, -3.0, -4.0 ] );
-    > y = new {{alias:@stdlib/array/float32}}( [ 0.0, 0.0, 0.0, 0.0 ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, x, 2, 1, y, -1, y.length-1 )
-    <Float32Array>[ 0.0, 0.0, 16.0, 4.0 ]
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,248 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2020 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 sabs2 = require( './index' );
-
-
-// TESTS //
-
-// The function returns a Float32Array...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2( x.length, x, 1, y, 1 ); // $ExpectType Float32Array
-}
-
-// The compiler throws an error if the function is provided a first argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2( '10', x, 1, y, 1 ); // $ExpectError
-	sabs2( true, x, 1, y, 1 ); // $ExpectError
-	sabs2( false, x, 1, y, 1 ); // $ExpectError
-	sabs2( null, x, 1, y, 1 ); // $ExpectError
-	sabs2( undefined, x, 1, y, 1 ); // $ExpectError
-	sabs2( [], x, 1, y, 1 ); // $ExpectError
-	sabs2( {}, x, 1, y, 1 ); // $ExpectError
-	sabs2( ( x: number ): number => x, x, 1, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a Float32Array...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2( x.length, 10, 1, y, 1 ); // $ExpectError
-	sabs2( x.length, '10', 1, y, 1 ); // $ExpectError
-	sabs2( x.length, true, 1, y, 1 ); // $ExpectError
-	sabs2( x.length, false, 1, y, 1 ); // $ExpectError
-	sabs2( x.length, null, 1, y, 1 ); // $ExpectError
-	sabs2( x.length, undefined, 1, y, 1 ); // $ExpectError
-	sabs2( x.length, [ '1' ], 1, y, 1 ); // $ExpectError
-	sabs2( x.length, {}, 1, y, 1 ); // $ExpectError
-	sabs2( x.length, ( x: number ): number => x, 1, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a third argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2( x.length, x, '10', y, 1 ); // $ExpectError
-	sabs2( x.length, x, true, y, 1 ); // $ExpectError
-	sabs2( x.length, x, false, y, 1 ); // $ExpectError
-	sabs2( x.length, x, null, y, 1 ); // $ExpectError
-	sabs2( x.length, x, undefined, y, 1 ); // $ExpectError
-	sabs2( x.length, x, [], y, 1 ); // $ExpectError
-	sabs2( x.length, x, {}, y, 1 ); // $ExpectError
-	sabs2( x.length, x, ( x: number ): number => x, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a fourth argument which is not a Float32Array...
-{
-	const x = new Float32Array( 10 );
-
-	sabs2( x.length, x, 1, 10, 1 ); // $ExpectError
-	sabs2( x.length, x, 1, '10', 1 ); // $ExpectError
-	sabs2( x.length, x, 1, true, 1 ); // $ExpectError
-	sabs2( x.length, x, 1, false, 1 ); // $ExpectError
-	sabs2( x.length, x, 1, null, 1 ); // $ExpectError
-	sabs2( x.length, x, 1, undefined, 1 ); // $ExpectError
-	sabs2( x.length, x, 1, [ '1' ], 1 ); // $ExpectError
-	sabs2( x.length, x, 1, {}, 1 ); // $ExpectError
-	sabs2( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a fifth argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2( x.length, x, 1, y, '10' ); // $ExpectError
-	sabs2( x.length, x, 1, y, true ); // $ExpectError
-	sabs2( x.length, x, 1, y, false ); // $ExpectError
-	sabs2( x.length, x, 1, y, null ); // $ExpectError
-	sabs2( x.length, x, 1, y, undefined ); // $ExpectError
-	sabs2( x.length, x, 1, y, [] ); // $ExpectError
-	sabs2( x.length, x, 1, y, {} ); // $ExpectError
-	sabs2( x.length, x, 1, y, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2(); // $ExpectError
-	sabs2( x.length ); // $ExpectError
-	sabs2( x.length, x ); // $ExpectError
-	sabs2( x.length, x, 1 ); // $ExpectError
-	sabs2( x.length, x, 1, y ); // $ExpectError
-	sabs2( x.length, x, 1, y, 1, 10 ); // $ExpectError
-}
-
-// Attached to main export is an `ndarray` method which returns a Float32Array...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType Float32Array
-}
-
-// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( ( x: number ): number => x, x, 1, 0, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Float32Array...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, [ '1' ], 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, ( x: number ): number => x, 1, 0, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, ( x: number ): number => x, 0, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a Float32Array...
-{
-	const x = new Float32Array( 10 );
-
-	sabs2.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, [ '1' ], 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments...
-{
-	const x = new Float32Array( 10 );
-	const y = new Float32Array( 10 );
-
-	sabs2.ndarray(); // $ExpectError
-	sabs2.ndarray( x.length ); // $ExpectError
-	sabs2.ndarray( x.length, x ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError
-	sabs2.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError
-}