feat: add ndarray/base/full-by

Author: headlessNode

lib/node_modules/@stdlib/ndarray/base/full-by/README.md

@@ -0,0 +1,161 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2026 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.
+
+-->
+
+# fullBy
+
+> Create an [ndarray][@stdlib/ndarray/base/ctor] filled according to a callback function and having a specified shape and [data type][@stdlib/ndarray/dtypes].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var fullBy = require( '@stdlib/ndarray/base/full-by' );
+```
+
+#### fullBy( dtype, shape, order, clbk\[, thisArg] )
+
+Returns an [ndarray][@stdlib/ndarray/base/ctor] filled according to a callback function and having a specified shape and [data type][@stdlib/ndarray/dtypes].
+
+```javascript
+var getDType = require( '@stdlib/ndarray/dtype' );
+
+function clbk() {
+    return 10.0;
+}
+
+var arr = fullBy( 'float64', [ 2, 2 ], 'row-major', clbk );
+// returns <ndarray>[ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ]
+
+var dt = String( getDType( arr ) );
+// returns 'float64'
+```
+
+This function accepts the following arguments:
+
+-   **dtype**: underlying [data type][@stdlib/ndarray/dtypes].
+-   **shape**: array shape.
+-   **order**: specifies whether an [ndarray][@stdlib/ndarray/base/ctor] is `'row-major'` (C-style) or `'column-major'` (Fortran-style).
+-   **clbk**: callback function.
+-   **thisArg**: callback function execution context (_optional_).
+
+The callback function is provided the following arguments:
+
+-   **indices**: current array element indices.
+
+To set the callback function execution context, provide a `thisArg`.
+
+```javascript
+var getDType = require( '@stdlib/ndarray/dtype' );
+
+function clbk( indices ) {
+    return this.value * ( indices[ 0 ] + indices[ 1 ] ); // eslint-disable-line no-invalid-this
+}
+
+var ctx = {
+    'value': 10.0
+};
+
+var arr = fullBy( 'float64', [ 2, 2 ], 'row-major', clbk, ctx );
+// returns <ndarray>[ [ 0.0, 10.0 ], [ 10.0, 20.0 ] ]
+
+var dt = String( getDType( arr ) );
+// returns 'float64'
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var dtypes = require( '@stdlib/ndarray/dtypes' );
+var fullBy = require( '@stdlib/ndarray/base/full-by' );
+
+// Get a list of data types:
+var dt = dtypes( 'integer_and_generic' );
+
+// Generate filled arrays...
+var arr;
+var i;
+for ( i = 0; i < dt.length; i++ ) {
+    arr = fullBy( dt[ i ], [ 2, 2 ], 'row-major', discreteUniform( -100, 100 ) );
+    console.log( ndarray2array( arr ) );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</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="links">
+
+[@stdlib/ndarray/base/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ctor
+
+[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
+
+</section>
+
+<!-- /.links -->