refactor!: remove support for non-ndarray arguments

This commit refactors the API to be more in line with recent work
for reduction dispatch (e.g., see `ndarray/base/unary-strided1d-dispatch`.
As such, non-ndarray argument support has been dropped. If such
generalized support is still desired, users should create a wrapper
which performs dispatch to specialized array and scalar implementations.

BREAKING CHANGE: remove support for non-ndarray arguments

To migrate, users will need to create higher-level wrappers which
perform argument dispatch.

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/math/tools/unary/README.md

@@ -21,18 +21,23 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var uniform = require( '@stdlib/random/uniform' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+var getData = require( '@stdlib/ndarray/data-buffer' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var format = require( '@stdlib/string/format' );
 var pkg = require( './../package.json' ).name;
 var abs = require( './fixtures/dispatcher.js' );
 
 
 // VARIABLES //
 
-var rand = uniform( -100.0, 100.0 );
+var DTYPES = [
+	'float64',
+	'float32',
+	'generic'
+];
 
 
 // FUNCTIONS //
@@ -41,21 +46,20 @@ var rand = uniform( -100.0, 100.0 );
 * Creates a benchmark function.
 *
 * @private
-* @param {PositiveInteger} len - array length
+* @param {PositiveInteger} size - array size
+* @param {string} dtype - data type
 * @returns {Function} benchmark function
 */
-function createBenchmark( len ) {
-	var buf;
+function createBenchmark( size, dtype ) {
+	var options;
 	var x;
 	var y;
-	var i;
 
-	buf = new Float32Array( len );
-	for ( i = 0; i < len; i++ ) {
-		buf[ i ] = rand();
-	}
-	x = ndarray( 'float32', buf, [ len ], [ 1 ], 0, 'row-major' );
-	y = ndarray( x.dtype, new Float32Array( len ), x.shape, x.strides, x.offset, x.order ); // eslint-disable-line max-len
+	options = {
+		'dtype': dtype
+	};
+	x = uniform( [], -10.0, 10.0, options );
+	y = zeros( [ size ], options );
 
 	return benchmark;
 
@@ -66,17 +70,18 @@ function createBenchmark( len ) {
 	* @param {Benchmark} b - benchmark instance
 	*/
 	function benchmark( b ) {
+		var out;
 		var i;
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			abs.assign( x, y );
-			if ( isnan( y.data[ i%len ] ) ) {
-				b.fail( 'should not return NaN' );
+			out = abs.assign( x, y );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an ndarray' );
 			}
 		}
 		b.toc();
-		if ( isnan( y.data[ i%len ] ) ) {
+		if ( isnan( getData( out )[ i%size ] ) ) {
 			b.fail( 'should not return NaN' );
 		}
 		b.pass( 'benchmark finished' );
@@ -93,19 +98,24 @@ function createBenchmark( len ) {
 * @private
 */
 function main() {
-	var len;
+	var size;
 	var min;
 	var max;
+	var dt;
 	var f;
 	var i;
+	var j;
 
 	min = 1; // 10^min
 	max = 6; // 10^max
 
-	for ( i = min; i <= max; i++ ) {
-		len = pow( 10, i );
-		f = createBenchmark( len );
-		bench( pkg+'::ndarray:assign:contiguous=true,ndims=1,dtype=float32,len='+len, f );
+	for ( j = 0; j < DTYPES.length; j++ ) {
+		dt = DTYPES[ j ];
+		for ( i = min; i <= max; i++ ) {
+			size = pow( 10, i );
+			f = createBenchmark( size, dt );
+			bench( format( '%s::broadcast:assign:contiguous=true,ndims=0,dtype=%s,size=%d', pkg, dt, size ), f );
+		}
 	}
 }
 

lib/node_modules/@stdlib/math/tools/unary/benchmark/benchmark.ndarray_1d_contiguous_float32.assign.js renamed to lib/node_modules/@stdlib/math/tools/unary/benchmark/benchmark.0d_broadcast.assign.js

@@ -0,0 +1,122 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/uniform' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+var getData = require( '@stdlib/ndarray/data-buffer' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var abs = require( './fixtures/dispatcher.js' );
+
+
+// VARIABLES //
+
+var DTYPES = [
+	'float64',
+	'float32',
+	'generic'
+];
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} size - array size
+* @param {string} dtype - data type
+* @returns {Function} benchmark function
+*/
+function createBenchmark( size, dtype ) {
+	var options;
+	var x;
+	var y;
+
+	options = {
+		'dtype': dtype
+	};
+	x = uniform( [ size ], -10.0, 10.0, options );
+	y = zeros( [ size ], options );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = abs.assign( x, y );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an ndarray' );
+			}
+		}
+		b.toc();
+		if ( isnan( getData( out )[ i%size ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var size;
+	var min;
+	var max;
+	var dt;
+	var f;
+	var i;
+	var j;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( j = 0; j < DTYPES.length; j++ ) {
+		dt = DTYPES[ j ];
+		for ( i = min; i <= max; i++ ) {
+			size = pow( 10, i );
+			f = createBenchmark( size, dt );
+			bench( format( '%s::broadcast:assign:contiguous=true,ndims=1,dtype=%s,size=%d', pkg, dt, size ), f );
+		}
+	}
+}
+
+main();

lib/node_modules/@stdlib/math/tools/unary/benchmark/benchmark.1d_contiguous.assign.js

@@ -21,18 +21,22 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var uniform = require( '@stdlib/random/uniform' );
+var getData = require( '@stdlib/ndarray/data-buffer' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var format = require( '@stdlib/string/format' );
 var pkg = require( './../package.json' ).name;
 var abs = require( './fixtures/dispatcher.js' );
 
 
 // VARIABLES //
 
-var rand = uniform( -100.0, -1.0 );
+var DTYPES = [
+	'float64',
+	'float32',
+	'generic'
+];
 
 
 // FUNCTIONS //
@@ -41,17 +45,18 @@ var rand = uniform( -100.0, -1.0 );
 * Creates a benchmark function.
 *
 * @private
-* @param {PositiveInteger} len - array length
+* @param {PositiveInteger} size - array size
+* @param {string} dtype - data type
 * @returns {Function} benchmark function
 */
-function createBenchmark( len ) {
-	var buf;
+function createBenchmark( size, dtype ) {
+	var options;
 	var x;
-	var y;
 
-	buf = new Float32Array( [ rand() ] );
-	x = ndarray( 'float32', buf, [], [ 0 ], 0, 'row-major' );
-	y = ndarray( x.dtype, new Float32Array( len ), [ len ], [ 1 ], 0, 'row-major' );
+	options = {
+		'dtype': dtype
+	};
+	x = uniform( [ size ], -10.0, 10.0, options );
 
 	return benchmark;
 
@@ -62,17 +67,18 @@ function createBenchmark( len ) {
 	* @param {Benchmark} b - benchmark instance
 	*/
 	function benchmark( b ) {
+		var out;
 		var i;
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			abs.assign( x, y );
-			if ( isnan( y.data[ i%len ] ) ) {
-				b.fail( 'should not return NaN' );
+			out = abs( x );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an ndarray' );
 			}
 		}
 		b.toc();
-		if ( isnan( y.data[ i%len ] ) ) {
+		if ( isnan( getData( out )[ i%size ] ) ) {
 			b.fail( 'should not return NaN' );
 		}
 		b.pass( 'benchmark finished' );
@@ -89,19 +95,24 @@ function createBenchmark( len ) {
 * @private
 */
 function main() {
-	var len;
+	var size;
 	var min;
 	var max;
+	var dt;
 	var f;
 	var i;
+	var j;
 
 	min = 1; // 10^min
 	max = 6; // 10^max
 
-	for ( i = min; i <= max; i++ ) {
-		len = pow( 10, i );
-		f = createBenchmark( len );
-		bench( pkg+'::ndarray,broadcast:contiguous=true,ndims=1,dtype=float32,len='+len, f );
+	for ( j = 0; j < DTYPES.length; j++ ) {
+		dt = DTYPES[ j ];
+		for ( i = min; i <= max; i++ ) {
+			size = pow( 10, i );
+			f = createBenchmark( size, dt );
+			bench( format( '%s:contiguous=true,ndims=1,dtype=%s,size=%d', pkg, dt, size ), f );
+		}
 	}
 }