Skip to content

Commit 837e86f

Browse files
kgrytekgryte
committed
feat: add array/base/fill
--- 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 ---
1 parent f910a92 commit 837e86f

File tree

10 files changed

+1122
-0
lines changed

10 files changed

+1122
-0
lines changed

‎lib/node_modules/@stdlib/array/base/fill/README.md

+136
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# fill
22+
23+
> Fill all elements within a portion of an array with a specified value.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var fill = require( '@stdlib/array/base/fill' );
41+
```
42+
43+
#### fill( x, value, start, end )
44+
45+
Fills all elements within a portion of an array from an inclusive `start` index to an exclusive `end` index with a specified `value`.
46+
47+
```javascript
48+
var x = [ 1, 2, 3, 4, 5, 6 ];
49+
50+
var out = fill( x, 10, 1, 4 );
51+
// returns [ 1, 10, 10, 10, 5, 6 ]
52+
53+
var bool = ( out === x );
54+
// returns true
55+
```
56+
57+
</section>
58+
59+
<!-- /.usage -->
60+
61+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
62+
63+
<section class="notes">
64+
65+
## Notes
66+
67+
- If provided an array-like object having a `fill` method, the function defers execution to that method and assumes that the method API has the following signature:
68+
69+
```text
70+
x.fill( value, start, end )
71+
```
72+
73+
- If provided an array-like object without a `fill` method, the function manually sets input array elements to a provided fill value.
74+
75+
- The function **mutates** the input array.
76+
77+
</section>
78+
79+
<!-- /.notes -->
80+
81+
<!-- Package usage examples. -->
82+
83+
<section class="examples">
84+
85+
## Examples
86+
87+
<!-- eslint no-undef: "error" -->
88+
89+
```javascript
90+
var Float64Array = require( '@stdlib/array/float64' );
91+
var zeroTo = require( '@stdlib/array/base/zero-to' );
92+
var fill = require( '@stdlib/array/base/fill' );
93+
94+
var x = new Float64Array( zeroTo( 6 ) );
95+
// returns <Float64Array>[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]
96+
97+
var y = fill( x, 10.0, 0, 6 );
98+
// returns <Float64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
99+
100+
y = fill( x, 0.0, 0, 4 );
101+
// returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 10.0, 10.0 ]
102+
103+
y = fill( x, 20.0, 2, 6 );
104+
// returns <Float64Array>[ 0.0, 0.0, 20.0, 20.0, 20.0, 20.0 ]
105+
106+
y = fill( x, 30.0, 2, 4 );
107+
// returns <Float64Array>[ 0.0, 0.0, 30.0, 30.0, 20.0, 20.0 ]
108+
```
109+
110+
</section>
111+
112+
<!-- /.examples -->
113+
114+
<!-- 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. -->
115+
116+
<section class="references">
117+
118+
</section>
119+
120+
<!-- /.references -->
121+
122+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
123+
124+
<section class="related">
125+
126+
</section>
127+
128+
<!-- /.related -->
129+
130+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
131+
132+
<section class="links">
133+
134+
</section>
135+
136+
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/fill/benchmark/benchmark.length.js

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var pow = require( '@stdlib/math/base/special/pow' );
25+
var isArray = require( '@stdlib/assert/is-array' );
26+
var ones = require( '@stdlib/array/base/ones' );
27+
var pkg = require( './../package.json' ).name;
28+
var fill = require( './../lib' );
29+
30+
31+
// FUNCTIONS //
32+
33+
/**
34+
* Creates a benchmark function.
35+
*
36+
* @private
37+
* @param {PositiveInteger} len - array length
38+
* @returns {Function} benchmark function
39+
*/
40+
function createBenchmark( len ) {
41+
var x = ones( len );
42+
return benchmark;
43+
44+
/**
45+
* Benchmark function.
46+
*
47+
* @private
48+
* @param {Benchmark} b - benchmark instance
49+
*/
50+
function benchmark( b ) {
51+
var out;
52+
var i;
53+
54+
b.tic();
55+
for ( i = 0; i < b.iterations; i++ ) {
56+
out = fill( x, i, 0, len );
57+
if ( out.length !== len ) {
58+
b.fail( 'unexpected length' );
59+
}
60+
}
61+
b.toc();
62+
if ( !isArray( out ) ) {
63+
b.fail( 'should return an array' );
64+
}
65+
b.pass( 'benchmark finished' );
66+
b.end();
67+
}
68+
}
69+
70+
71+
// MAIN //
72+
73+
/**
74+
* Main execution sequence.
75+
*
76+
* @private
77+
*/
78+
function main() {
79+
var len;
80+
var min;
81+
var max;
82+
var f;
83+
var i;
84+
85+
min = 1; // 10^min
86+
max = 6; // 10^max
87+
88+
for ( i = min; i <= max; i++ ) {
89+
len = pow( 10, i );
90+
91+
f = createBenchmark( len );
92+
bench( pkg+':dtype=generic,len='+len, f );
93+
}
94+
}
95+
96+
main();

‎lib/node_modules/@stdlib/array/base/fill/docs/repl.txt

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
{{alias}}( x, value, start, end )
3+
Fills all elements within a portion of an array with a specified value.
4+
5+
If provided an array-like object having a `fill` method, the function
6+
defers execution to that method and assumes that the method has the
7+
following signature:
8+
9+
x.fill( value, start, end )
10+
11+
If provided an array-like object without a `value` method, the function
12+
manually sets input array elements to the specified value.
13+
14+
Parameters
15+
----------
16+
x: ArrayLikeObject
17+
Input array.
18+
19+
value: any
20+
Fill value.
21+
22+
start: integer
23+
Starting index (inclusive).
24+
25+
end: integer
26+
Ending index (exclusive).
27+
28+
Returns
29+
-------
30+
out: ArrayLikeObject
31+
Modified input array.
32+
33+
Examples
34+
--------
35+
> var out = {{alias}}( [ 1, 2, 3, 4 ], 5, 1, 3 )
36+
[ 1, 5, 5, 4 ]
37+
38+
See Also
39+
--------
40+

0 commit comments

Comments
 (0)