Skip to content

Commit ad90536

Browse files
Snehil-Shahkgryte
authored and
Utkarsh Gupta
committed
refactor: update blas/ext/base/dfill to follow current project conventions
Closes: stdlib-js#1434 Ref: stdlib-js#1152 PR-URL: stdlib-js#1455 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Snehil Shah <[email protected]> Signed-off-by: Athan Reines <[email protected]>
1 parent 2192c36 commit ad90536

File tree

18 files changed

+150
-270
lines changed

18 files changed

+150
-270
lines changed

lib/node_modules/@stdlib/blas/ext/base/dfill/README.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -50,34 +50,30 @@ The function has the following parameters:
5050
- **x**: input [`Float64Array`][@stdlib/array/float64].
5151
- **stride**: index increment.
5252

53-
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to fill every other element
53+
The `N` and `stride` parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element
5454

5555
```javascript
5656
var Float64Array = require( '@stdlib/array/float64' );
57-
var floor = require( '@stdlib/math/base/special/floor' );
5857

5958
var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
60-
var N = floor( x.length / 2 );
6159

62-
dfill( N, 5.0, x, 2 );
60+
dfill( 4, 5.0, x, 2 );
6361
// x => <Float64Array>[ 5.0, 1.0, 5.0, -5.0, 5.0, 0.0, 5.0, -3.0 ]
6462
```
6563

6664
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
6765

6866
```javascript
6967
var Float64Array = require( '@stdlib/array/float64' );
70-
var floor = require( '@stdlib/math/base/special/floor' );
7168

7269
// Initial array...
7370
var x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
7471

7572
// Create an offset view...
7673
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
77-
var N = floor( x0.length/2 );
7874

7975
// Fill every other element...
80-
dfill( N, 5.0, x1, 2 );
76+
dfill( 3, 5.0, x1, 2 );
8177
// x0 => <Float64Array>[ 1.0, 5.0, 3.0, 5.0, 5.0, 5.0 ]
8278
```
8379

@@ -130,27 +126,13 @@ dfill.ndarray( 3, 5.0, x, 1, x.length-3 );
130126
<!-- eslint no-undef: "error" -->
131127

132128
```javascript
133-
var round = require( '@stdlib/math/base/special/round' );
134-
var randu = require( '@stdlib/random/base/randu' );
135-
var Float64Array = require( '@stdlib/array/float64' );
129+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
130+
var filledarrayBy = require( '@stdlib/array/filled-by' );
136131
var dfill = require( '@stdlib/blas/ext/base/dfill' );
137132

138-
var rand;
139-
var sign;
140-
var x;
141-
var i;
142-
143-
x = new Float64Array( 10 );
144-
for ( i = 0; i < x.length; i++ ) {
145-
rand = round( randu()*100.0 );
146-
sign = randu();
147-
if ( sign < 0.5 ) {
148-
sign = -1.0;
149-
} else {
150-
sign = 1.0;
151-
}
152-
x[ i ] = sign * rand;
153-
}
133+
var rand = discreteUniform( -100, 100 );
134+
135+
var x = filledarrayBy( 10, 'float64', rand );
154136
console.log( x );
155137

156138
dfill( x.length, 5.0, x, 1 );

lib/node_modules/@stdlib/blas/ext/base/dfill/benchmark/benchmark.js

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,19 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
25+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
2828
var pkg = require( './../package.json' ).name;
2929
var dfill = require( './../lib/dfill.js' );
3030

3131

32+
// VARIABLES //
33+
34+
var rand = uniform( -10.0, 10.0 );
35+
36+
3237
// FUNCTIONS //
3338

3439
/**
@@ -39,13 +44,7 @@ var dfill = require( './../lib/dfill.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var x;
43-
var i;
44-
45-
x = new Float64Array( len );
46-
for ( i = 0; i < len; i++ ) {
47-
x[ i ] = ( randu()*20.0 ) - 10.0;
48-
}
47+
var x = filledarrayBy( len, 'float64', rand );
4948
return benchmark;
5049

5150
function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/dfill/benchmark/benchmark.native.js

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2627
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2728
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float64Array = require( '@stdlib/array/float64' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

@@ -36,6 +36,7 @@ var dfill = tryRequire( resolve( __dirname, './../lib/dfill.native.js' ) );
3636
var opts = {
3737
'skip': ( dfill instanceof Error )
3838
};
39+
var rand = uniform( -10.0, 10.0 );
3940

4041

4142
// FUNCTIONS //
@@ -48,13 +49,7 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var i;
53-
54-
x = new Float64Array( len );
55-
for ( i = 0; i < len; i++ ) {
56-
x[ i ] = ( randu()*20.0 ) - 10.0;
57-
}
52+
var x = filledarrayBy( len, 'float64', rand );
5853
return benchmark;
5954

6055
function benchmark( b ) {

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,19 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
25+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
2828
var pkg = require( './../package.json' ).name;
2929
var dfill = require( './../lib/ndarray.js' );
3030

3131

32+
// VARIABLES //
33+
34+
var rand = uniform( -10.0, 10.0 );
35+
36+
3237
// FUNCTIONS //
3338

3439
/**
@@ -39,13 +44,7 @@ var dfill = require( './../lib/ndarray.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var x;
43-
var i;
44-
45-
x = new Float64Array( len );
46-
for ( i = 0; i < len; i++ ) {
47-
x[ i ] = ( randu()*20.0 ) - 10.0;
48-
}
47+
var x = filledarrayBy( len, 'float64', rand );
4948
return benchmark;
5049

5150
function benchmark( b ) {

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

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2627
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2728
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float64Array = require( '@stdlib/array/float64' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

@@ -36,6 +36,7 @@ var dfill = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
3636
var opts = {
3737
'skip': ( dfill instanceof Error )
3838
};
39+
var rand = uniform( -10.0, 10.0 );
3940

4041

4142
// FUNCTIONS //
@@ -48,13 +49,7 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var i;
53-
54-
x = new Float64Array( len );
55-
for ( i = 0; i < len; i++ ) {
56-
x[ i ] = ( randu()*20.0 ) - 10.0;
57-
}
52+
var x = filledarrayBy( len, 'float64', rand );
5853
return benchmark;
5954

6055
function benchmark( b ) {

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Fills a double-precision floating-point strided array with a specified
44
scalar value.
55

6-
The `N` and `stride` parameters determine which elements in `x` are accessed
7-
at runtime.
6+
The `N` and `stride` parameters determine which elements in the strided
7+
array are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce an offset, use typed
1010
array views.
@@ -28,7 +28,7 @@
2828
Returns
2929
-------
3030
x: Float64Array
31-
Input array `x`.
31+
Input array.
3232

3333
Examples
3434
--------
@@ -39,19 +39,18 @@
3939

4040
// Using `N` and `stride` parameters:
4141
> x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
42-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
43-
> {{alias}}( N, 5.0, x, 2 )
42+
> {{alias}}( 3, 5.0, x, 2 )
4443
<Float64Array>[ 5.0, 1.0, 5.0, -5.0, 5.0, -1.0, -3.0 ]
4544

4645
// Using view offsets:
4746
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
4847
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
49-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
50-
> {{alias}}( N, 5.0, x1, 2 )
48+
> {{alias}}( 3, 5.0, x1, 2 )
5149
<Float64Array>[ 5.0, 3.0, 5.0, 5.0, 5.0 ]
5250
> x0
5351
<Float64Array>[ 1.0, 5.0, 3.0, 5.0, 5.0, 5.0 ]
5452

53+
5554
{{alias}}.ndarray( N, alpha, x, stride, offset )
5655
Fills a double-precision floating-point strided array with a specified
5756
scalar value using alternative indexing semantics.
@@ -80,7 +79,7 @@
8079
Returns
8180
-------
8281
x: Float64Array
83-
Input array `x`.
82+
Input array.
8483

8584
Examples
8685
--------
@@ -91,8 +90,7 @@
9190

9291
// Using an index offset:
9392
> x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
94-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
95-
> {{alias}}.ndarray( N, 5.0, x, 2, 1 )
93+
> {{alias}}.ndarray( 3, 5.0, x, 2, 1 )
9694
<Float64Array>[ 1.0, 5.0, 3.0, 5.0, 5.0, 5.0 ]
9795

9896
See Also

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ interface Routine {
2929
* @param alpha - constant
3030
* @param x - input array
3131
* @param stride - stride length
32-
* @returns `x`
32+
* @returns input array
3333
*
3434
* @example
3535
* var Float64Array = require( '@stdlib/array/float64' );
@@ -49,7 +49,7 @@ interface Routine {
4949
* @param x - input array
5050
* @param stride - stride length
5151
* @param offset - starting index
52-
* @returns `x`
52+
* @returns input array
5353
*
5454
* @example
5555
* var Float64Array = require( '@stdlib/array/float64' );
@@ -69,7 +69,7 @@ interface Routine {
6969
* @param alpha - constant
7070
* @param x - input array
7171
* @param stride - stride length
72-
* @returns `x`
72+
* @returns input array
7373
*
7474
* @example
7575
* var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/blas/ext/base/dfill/examples/index.js

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,13 @@
1818

1919
'use strict';
2020

21-
var round = require( '@stdlib/math/base/special/round' );
22-
var randu = require( '@stdlib/random/base/randu' );
23-
var Float64Array = require( '@stdlib/array/float64' );
21+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
22+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2423
var dfill = require( './../lib' );
2524

26-
var rand;
27-
var sign;
28-
var x;
29-
var i;
25+
var rand = discreteUniform( -100, 100 );
3026

31-
x = new Float64Array( 10 );
32-
for ( i = 0; i < x.length; i++ ) {
33-
rand = round( randu()*100.0 );
34-
sign = randu();
35-
if ( sign < 0.5 ) {
36-
sign = -1.0;
37-
} else {
38-
sign = 1.0;
39-
}
40-
x[ i ] = sign * rand;
41-
}
27+
var x = filledarrayBy( 10, 'float64', rand );
4228
console.log( x );
4329

4430
dfill( x.length, 5.0, x, 1 );

lib/node_modules/@stdlib/blas/ext/base/dfill/include.gypi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
# Source files:
3838
'src_files': [
39-
'<(src_dir)/addon.cpp',
39+
'<(src_dir)/addon.c',
4040
'<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).src; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")',
4141
],
4242

lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.native.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020

2121
// MODULES //
2222

23-
var Float64Array = require( '@stdlib/array/float64' );
23+
var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' );
24+
var offsetView = require( '@stdlib/strided/base/offset-view' );
2425
var addon = require( './dfill.native.js' );
2526

2627

@@ -46,10 +47,10 @@ var addon = require( './dfill.native.js' );
4647
*/
4748
function dfill( N, alpha, x, stride, offset ) {
4849
var view;
49-
if ( stride < 0 ) {
50-
offset += (N-1) * stride;
51-
}
52-
view = new Float64Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offset), x.length-offset ); // eslint-disable-line max-len
50+
51+
offset = minViewBufferIndex( N, stride, offset );
52+
view = offsetView( x, offset );
53+
5354
addon( N, alpha, view, stride );
5455
return x;
5556
}

0 commit comments

Comments
 (0)