fix: refactor sfill to arrays API

Author: Amansingh0807

lib/node_modules/@stdlib/blas/ext/base/ndarray/sfill/README.md

@@ -20,13 +20,7 @@ limitations under the License.
 
 # sfill
 
-> Fill a single-precision floating-point ndarray with a specified value.
-
-<section class="intro">
-
-</section>
-
-<!-- /.intro -->
+> Fill a one-dimensional single-precision floating-point ndarray with a specified value.
 
 <section class="usage">
 
@@ -36,59 +30,66 @@ limitations under the License.
 var sfill = require( '@stdlib/blas/ext/base/ndarray/sfill' );
 ```
 
-#### sfill( x, alpha )
+#### sfill( arrays )
 
-Fills a single-precision floating-point ndarray `x` with a specified value `alpha`.
+Fills a one-dimensional single-precision floating-point ndarray `x` with a specified value `alpha`.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
-var array = require( '@stdlib/ndarray/array' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+
+var xbuf = new Float32Array( [ 1.0, 2.0, 3.0 ] );
+var x = new ndarray( 'float32', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
 
-var x = array( new Float32Array( [ 1.0, 2.0, 3.0 ] ) );
+var alpha = scalar2ndarray( 5.0, {
+    'dtype': 'float32'
+});
+
+var out = sfill( [ x, alpha ] );
+// returns <ndarray>
 
-var out = sfill( x, 5.0 );
-// returns <ndarray>[ 5.0, 5.0, 5.0 ]
+var arr = ndarray2array( out );
+// returns [ 5.0, 5.0, 5.0 ]
 ```
 
 The function has the following parameters:
 
--   **x**: input ndarray.
--   **alpha**: fill value.
+-   **arrays**: array-like object containing a single one-dimensional input ndarray and a zero-dimensional ndarray containing a scalar constant.
 
 </section>
 
 <!-- /.usage -->
 
-<section class="notes">
-
-## Notes
-
--   If provided an ndarray with a length of `0`, the function returns the ndarray unchanged.
-
-</section>
-
-<!-- /.notes -->
-
 <section class="examples">
 
 ## Examples
 
-<!-- eslint no-undef: "error" -->
-
 ```javascript
 var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
 var Float32Array = require( '@stdlib/array/float32' );
-var array = require( '@stdlib/ndarray/array' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
 var sfill = require( '@stdlib/blas/ext/base/ndarray/sfill' );
 
-var xbuf = discreteUniform( 10, -100, 100, {
+var xbuf = new Float32Array( discreteUniform( 10, -50, 50, {
+    'dtype': 'float32'
+}));
+var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+
+console.log( 'Before:' );
+console.log( ndarray2array( x ) );
+
+var alpha = scalar2ndarray( 5.0, {
     'dtype': 'float32'
 });
-var x = array( xbuf );
-console.log( x.data );
 
-sfill( x, 5.0 );
-console.log( x.data );
+sfill( [ x, alpha ] );
+
+console.log( 'After:' );
+console.log( ndarray2array( x ) );
 ```
 
 </section>

lib/node_modules/@stdlib/blas/ext/base/ndarray/sfill/benchmark/benchmark.js

@@ -21,95 +21,88 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var pow = require( '@stdlib/math/base/special/pow' );
 var Float32Array = require( '@stdlib/array/float32' );
-var array = require( '@stdlib/ndarray/array' );
-var isFloat32Array = require( '@stdlib/assert/is-float32array' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray = require( '@stdlib/ndarray/ctor' );
 var pkg = require( './../package.json' ).name;
 var sfill = require( './../lib' );
 
 
-// MAIN //
+// VARIABLES //
 
-bench( pkg, function benchmark( b ) {
-	var x;
-	var i;
+var options = {
+	'dtype': 'float32'
+};
 
-	x = array( new Float32Array( 10 ) );
 
-	b.tic();
-	for ( i = 0; i < b.iterations; i++ ) {
-		sfill( x, 5.0 );
-		if ( x.data[ 0 ] !== 5.0 ) {
-			b.fail( 'should fill ndarray' );
-		}
-	}
-	b.toc();
-	if ( !isFloat32Array( x.data ) ) {
-		b.fail( 'should return an ndarray' );
-	}
-	b.pass( 'benchmark finished' );
-	b.end();
-});
+// FUNCTIONS //
 
-bench( pkg+'::ndarray,len=10', function benchmark( b ) {
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var alpha;
+	var xbuf;
+	var buf;
 	var x;
-	var i;
 
-	x = array( new Float32Array( 10 ) );
+	buf = uniform( len, 0.0, 100.0, options );
+	xbuf = new Float32Array( buf );
+	x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
 
-	b.tic();
-	for ( i = 0; i < b.iterations; i++ ) {
-		sfill( x, 5.0 );
-		if ( x.data[ 0 ] !== 5.0 ) {
-			b.fail( 'should fill ndarray' );
-		}
-	}
-	b.toc();
-	if ( !isFloat32Array( x.data ) ) {
-		b.fail( 'should return an ndarray' );
-	}
-	b.pass( 'benchmark finished' );
-	b.end();
-});
+	alpha = scalar2ndarray( 5.0, options );
 
-bench( pkg+'::ndarray,len=100', function benchmark( b ) {
-	var x;
-	var i;
+	return benchmark;
 
-	x = array( new Float32Array( 100 ) );
+	function benchmark( b ) {
+		var out;
+		var i;
 
-	b.tic();
-	for ( i = 0; i < b.iterations; i++ ) {
-		sfill( x, 5.0 );
-		if ( x.data[ 0 ] !== 5.0 ) {
-			b.fail( 'should fill ndarray' );
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = sfill( [ x, alpha ] );
+			if ( out !== out ) {
+				b.fail( 'should not return NaN' );
+			}
 		}
+		b.toc();
+		if ( out !== out ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
 	}
-	b.toc();
-	if ( !isFloat32Array( x.data ) ) {
-		b.fail( 'should return an ndarray' );
-	}
-	b.pass( 'benchmark finished' );
-	b.end();
-});
+}
 
-bench( pkg+'::ndarray,len=1000', function benchmark( b ) {
-	var x;
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
 	var i;
 
-	x = array( new Float32Array( 1000 ) );
+	min = 1; // 10^min
+	max = 6; // 10^max
 
-	b.tic();
-	for ( i = 0; i < b.iterations; i++ ) {
-		sfill( x, 5.0 );
-		if ( x.data[ 0 ] !== 5.0 ) {
-			b.fail( 'should fill ndarray' );
-		}
-	}
-	b.toc();
-	if ( !isFloat32Array( x.data ) ) {
-		b.fail( 'should return an ndarray' );
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );
 	}
-	b.pass( 'benchmark finished' );
-	b.end();
-});
+}
+
+main();

lib/node_modules/@stdlib/blas/ext/base/ndarray/sfill/docs/repl.txt

@@ -1,14 +1,13 @@
 
-{{alias}}( x, alpha )
-    Fills a single-precision floating-point ndarray with a specified value.
+{{alias}}( arrays )
+    Fills a one-dimensional single-precision floating-point ndarray with a
+    specified value.
 
     Parameters
     ----------
-    x: float32ndarray
-        Input ndarray.
-
-    alpha: number
-        Fill value.
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing a single one-dimensional input ndarray
+        and a zero-dimensional ndarray containing a scalar constant.
 
     Returns
     -------
@@ -17,10 +16,12 @@
 
     Examples
     --------
-    > var x = {{alias:@stdlib/ndarray/array}}( new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0 ] ) );
-    > {{alias}}( x, 5.0 )
+    > var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0 ] );
+    > var x = {{alias:@stdlib/ndarray/ctor}}( 'float32', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
+    > var s2n = {{alias:@stdlib/ndarray/from-scalar}};
+    > var alpha = s2n( 5.0, { 'dtype': 'float32' } );
+    > {{alias}}( [ x, alpha ] )
     <ndarray>[ 5.0, 5.0, 5.0 ]
 
     See Also
     --------
-

lib/node_modules/@stdlib/blas/ext/base/ndarray/sfill/docs/types/index.d.ts

@@ -25,20 +25,29 @@ import { float32ndarray } from '@stdlib/types/ndarray';
 /**
 * Fills a single-precision floating-point ndarray with a specified value.
 *
-* @param x - input ndarray
-* @param alpha - fill value
+* @param arrays - array-like object containing a single one-dimensional input ndarray and a zero-dimensional ndarray containing a scalar constant
 * @returns input ndarray
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
-* var array = require( '@stdlib/ndarray/array' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+* var ndarray2array = require( '@stdlib/ndarray/to-array' );
+* var ndarray = require( '@stdlib/ndarray/base/ctor' );
 *
-* var x = array( new Float32Array( [ 1.0, 2.0, 3.0 ] ) );
+* var xbuf = new Float32Array( [ 1.0, 2.0, 3.0 ] );
+* var x = new ndarray( 'float32', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
 *
-* var out = sfill( x, 5.0 );
-* // returns <ndarray>[ 5.0, 5.0, 5.0 ]
+* var alpha = scalar2ndarray( 5.0, {
+*     'dtype': 'float32'
+* });
+*
+* var out = sfill( [ x, alpha ] );
+* // returns <ndarray>
+*
+* var arr = ndarray2array( out );
+* // returns [ 5.0, 5.0, 5.0 ]
 */
-declare function sfill( x: float32ndarray, alpha: number ): float32ndarray;
+declare function sfill( arrays: [ float32ndarray, float32ndarray ] ): float32ndarray;
 
 
 // EXPORTS //