@stdlib/blas-ext-base-gfill-by 0.0.6 → 0.0.7

package/NOTICE

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

package/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # gfillBy
 
-[![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] -->
 
 > Fill a strided array according to a provided callback function.
 
@@ -60,7 +60,7 @@ gfillBy( x.length, x, 1, fill );
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
--   **x**: input [`Array`][mdn-array], [`typed array`][mdn-typed-array], or an array-like object (excluding strings and functions). 
+-   **x**: input array. 
 -   **stride**: index increment.
 -   **clbk**: callback function.
 -   **thisArg**: execution context (_optional_).
@@ -172,6 +172,7 @@ gfillBy.ndarray( 3, x, 1, x.length-3, fill );
 ## Notes
 
 -   If `N <= 0`, both functions return `x` unchanged.
+-   Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/complex64`][@stdlib/array/complex64]).
 -   When filling a strided array with a scalar constant, prefer using [`dfill`][@stdlib/blas/ext/base/dfill], [`sfill`][@stdlib/blas/ext/base/sfill], and/or [`gfill`][@stdlib/blas/ext/base/gfill], as, depending on the environment, these interfaces are likely to be significantly more performant.
 
 </section>
@@ -212,6 +213,22 @@ console.log( x );
 
 <!-- /.examples -->
 
+<!-- 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/blas/ext/base/gfill`][@stdlib/blas/ext/base/gfill]</span><span class="delimiter">: </span><span class="description">fill a strided array with a specified scalar constant.</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
 
 <section class="main-repo" >
 
@@ -236,7 +253,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -255,9 +272,20 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-ext-base-gfill-by/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/blas-ext-base-gfill-by?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/blas-ext-base-gfill-by.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/blas-ext-base-gfill-by/main
 
+-->
+
+[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/blas-ext-base-gfill-by/tree/deno
+[umd-url]: https://github.com/stdlib-js/blas-ext-base-gfill-by/tree/umd
+[esm-url]: https://github.com/stdlib-js/blas-ext-base-gfill-by/tree/esm
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
 [chat-url]: https://gitter.im/stdlib-js/stdlib/
 
@@ -267,15 +295,19 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/blas-ext-base-gfill-by/main/LICENSE
 
-[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
-
 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
 
+[@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/array-complex64
+
 [@stdlib/blas/ext/base/dfill]: https://www.npmjs.com/package/@stdlib/blas-ext-base-dfill
 
+[@stdlib/blas/ext/base/sfill]: https://www.npmjs.com/package/@stdlib/blas-ext-base-sfill
+
+<!-- <related-links> -->
+
 [@stdlib/blas/ext/base/gfill]: https://www.npmjs.com/package/@stdlib/blas-ext-base-gfill
 
-[@stdlib/blas/ext/base/sfill]: https://www.npmjs.com/package/@stdlib/blas-ext-base-sfill
+<!-- </related-links> -->
 
 </section>
 

package/docs/repl.txt

@@ -25,9 +25,8 @@
     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).
+    x: ArrayLikeObject
+        Input array.
 
     stride: integer
         Index increment for `x`.
@@ -40,8 +39,8 @@
 
     Returns
     -------
-    x: Array|TypedArray|Object
-        Input array/collection `x`.
+    x: ArrayLikeObject
+        Input array `x`.
 
     Examples
     --------
@@ -66,6 +65,7 @@
     > x0
     <Float64Array>[ 1.0, 5.0, 3.0, 5.0, 5.0, 5.0 ]
 
+
 {{alias}}.ndarray( N, x, stride, offset, clbk[, thisArg] )
     Fills a strided array according to a provided callback function and using
     alternative indexing semantics.
@@ -79,9 +79,8 @@
     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).
+    x: ArrayLikeObject
+        Input array.
 
     stride: integer
         Index increment for `x`.
@@ -97,8 +96,8 @@
 
     Returns
     -------
-    x: Array|TypedArray|Object
-        Input array/collection `x`.
+    x: ArrayLikeObject
+        Input array `x`.
 
     Examples
     --------

package/docs/types/index.d.ts

@@ -54,7 +54,7 @@ type Binary = ( value: any, aidx: number ) => any;
 * @param sidx - strided index (offset + aidx*stride)
 * @returns fill value
 */
-type Tertiary = ( value: any, aidx: number, sidx: number ) => any;
+type Ternary = ( value: any, aidx: number, sidx: number ) => any;
 
 /**
 * Returns a fill value.
@@ -76,7 +76,7 @@ type Quaternary = ( value: any, aidx: number, sidx: number, array: Collection )
 * @param array - input array
 * @returns fill value
 */
-type Callback = Nullary | Unary | Binary | Tertiary | Quaternary;
+type Callback = Nullary | Unary | Binary | Ternary | Quaternary;
 
 /**
 * Interface describing `gfillBy`.

package/lib/accessors.js

@@ -0,0 +1,93 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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';
+
+// MAIN //
+
+/**
+* Fills a strided array according to a provided callback function.
+*
+* @private
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Object} x - input array object
+* @param {Collection} x.data - input array data
+* @param {Function} x.set - setter
+* @param {Function} x.get - getter
+* @param {integer} stride - index increment
+* @param {NonNegativeInteger} offset - starting index
+* @param {Callback} clbk - callback
+* @param {*} thisArg - execution context
+* @returns {Object} input array object
+*
+* @example
+* var Complex64Array = require( '@stdlib/array-complex64' );
+* var Complex64 = require( '@stdlib/complex-float32' );
+* var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );
+*
+* function setter( data, idx, value ) {
+*     data.set( value, idx );
+* }
+*
+* function getter( data, idx ) {
+*     return data.get( idx );
+* }
+*
+* var data = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
+*
+* var x = {
+*     'data': data,
+*     'setter': setter,
+*     'getter': getter
+* };
+*
+* function clbk() {
+*     return new Complex64( 5.0, 5.0 );
+* }
+*
+* gfillBy( data.length, x, 1, 0, clbk, void 0 );
+*
+* var view = reinterpret64( x.data, 0 );
+* // view => <Float32Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
+*/
+function gfillBy( N, x, stride, offset, clbk, thisArg ) {
+	var xbuf;
+	var set;
+	var get;
+	var ix;
+	var i;
+
+	// Cache reference to array data:
+	xbuf = x.data;
+
+	// Cache a reference to the element accessors:
+	get = x.getter;
+	set = x.setter;
+
+	ix = offset;
+	for ( i = 0; i < N; i++ ) {
+		set( xbuf, ix, clbk.call( thisArg, get( xbuf, ix ), i, ix, x ) );
+		ix += stride;
+	}
+	return x;
+}
+
+
+// EXPORTS //
+
+module.exports = gfillBy;

package/lib/index.js

@@ -50,9 +50,16 @@
 
 // MODULES //
 
-var gfillBy = require( './main.js' );
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
+var main = require( './main.js' );
+var ndarray = require( './ndarray.js' );
+
+
+// MAIN //
+
+setReadOnly( main, 'ndarray', ndarray );
 
 
 // EXPORTS //
 
-module.exports = gfillBy;
+module.exports = main;

package/lib/main.js

@@ -20,14 +20,56 @@
 
 // MODULES //
 
-var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var gfillBy = require( './gfill_by.js' );
-var ndarray = require( './ndarray.js' );
+var arraylike2object = require( '@stdlib/array-base-arraylike2object' );
+var accessors = require( './accessors.js' );
 
 
 // MAIN //
 
-setReadOnly( gfillBy, 'ndarray', ndarray );
+/**
+* Fills a strided array according to a provided callback function.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Collection} x - input array
+* @param {integer} stride - index increment
+* @param {Callback} clbk - callback
+* @param {*} [thisArg] - execution context
+* @returns {Collection} input array
+*
+* @example
+* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
+*
+* function fill() {
+*     return 5.0;
+* }
+*
+* gfillBy( x.length, x, 1, fill );
+* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
+*/
+function gfillBy( N, x, stride, clbk, thisArg ) {
+	var ix;
+	var o;
+	var i;
+
+	if ( N <= 0 ) {
+		return x;
+	}
+	if ( stride < 0 ) {
+		ix = (1-N) * stride;
+	} else {
+		ix = 0;
+	}
+	o = arraylike2object( x );
+	if ( o.accessors ) {
+		accessors( N, o, stride, ix, clbk, thisArg );
+		return o.data;
+	}
+	for ( i = 0; i < N; i++ ) {
+		x[ ix ] = clbk.call( thisArg, x[ ix ], i, ix, x );
+		ix += stride;
+	}
+	return x;
+}
 
 
 // EXPORTS //

package/lib/ndarray.js

@@ -18,18 +18,24 @@
 
 'use strict';
 
+// MODULES //
+
+var arraylike2object = require( '@stdlib/array-base-arraylike2object' );
+var accessors = require( './accessors.js' );
+
+
 // MAIN //
 
 /**
 * Fills a strided array according to a provided callback function.
 *
 * @param {PositiveInteger} N - number of indexed elements
-* @param {Collection} x - input array/collection
+* @param {Collection} x - input array
 * @param {integer} stride - index increment
 * @param {NonNegativeInteger} offset - starting index
 * @param {Callback} clbk - callback
 * @param {*} [thisArg] - execution context
-* @returns {Collection} input array/collection
+* @returns {Collection} input array
 *
 * @example
 * var x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];
@@ -38,16 +44,22 @@
 *     return 5.0;
 * }
 *
-* gfillBy( 3, 5.0, x, 1, x.length-3 );
+* gfillBy( 3, x, 1, x.length-3, fill );
 * // x => [ 1.0, -2.0, 3.0, 5.0, 5.0, 5.0 ]
 */
 function gfillBy( N, x, stride, offset, clbk, thisArg ) {
 	var ix;
+	var o;
 	var i;
 
 	if ( N <= 0 ) {
 		return x;
 	}
+	o = arraylike2object( x );
+	if ( o.accessors ) {
+		accessors( N, o, stride, offset, clbk, thisArg );
+		return o.data;
+	}
 	ix = offset;
 	for ( i = 0; i < N; i++ ) {
 		x[ ix ] = clbk.call( thisArg, x[ ix ], i, ix, x );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/blas-ext-base-gfill-by",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Fill a strided array according to a provided callback function.",
   "license": "Apache-2.0",
   "author": {
@@ -37,16 +37,22 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
+    "@stdlib/array-base-arraylike2object": "^0.0.x",
     "@stdlib/types": "^0.0.x",
     "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
   },
   "devDependencies": {
+    "@stdlib/array-base-filled-by": "^0.0.x",
+    "@stdlib/array-complex128": "^0.0.x",
     "@stdlib/array-float64": "^0.0.x",
     "@stdlib/bench": "^0.0.x",
+    "@stdlib/complex-float64": "^0.0.x",
     "@stdlib/math-base-assert-is-nan": "^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/random-base-uniform": "^0.0.x",
+    "@stdlib/strided-base-reinterpret-complex128": "^0.0.x",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
     "tap-spec": "5.x.x"

package/lib/gfill_by.js

@@ -1,65 +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.
-*/
-
-'use strict';
-
-// MAIN //
-
-/**
-* Fills a strided array according to a provided callback function.
-*
-* @param {PositiveInteger} N - number of indexed elements
-* @param {Collection} x - input array/collection
-* @param {integer} stride - index increment
-* @param {Callback} clbk - callback
-* @param {*} [thisArg] - execution context
-* @returns {Collection} input array/collection
-*
-* @example
-* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
-*
-* function fill() {
-*     return 5.0;
-* }
-*
-* gfillBy( x.length, x, 1, fill );
-* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
-*/
-function gfillBy( N, x, stride, clbk, thisArg ) {
-	var ix;
-	var i;
-
-	if ( N <= 0 ) {
-		return x;
-	}
-	if ( stride < 0 ) {
-		ix = (1-N) * stride;
-	} else {
-		ix = 0;
-	}
-	for ( i = 0; i < N; i++ ) {
-		x[ ix ] = clbk.call( thisArg, x[ ix ], i, ix, x );
-		ix += stride;
-	}
-	return x;
-}
-
-
-// EXPORTS //
-
-module.exports = gfillBy;