Skip to content

Commit 013c80d

Browse files
committed
refactor: refactor implementation
--- 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: na - 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: na - task: lint_license_headers status: passed ---
1 parent 84b7614 commit 013c80d

File tree

12 files changed

+103
-204
lines changed

12 files changed

+103
-204
lines changed

lib/node_modules/@stdlib/stats/base/minabs/README.md

Lines changed: 15 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -36,33 +36,29 @@ limitations under the License.
3636
var minabs = require( '@stdlib/stats/base/minabs' );
3737
```
3838

39-
#### minabs( N, x, stride )
39+
#### minabs( N, x, strideX )
4040

4141
Computes the minimum absolute value of a strided array `x`.
4242

4343
```javascript
4444
var x = [ 1.0, -2.0, 2.0 ];
45-
var N = x.length;
4645

47-
var v = minabs( N, x, 1 );
46+
var v = minabs( x.length, x, 1 );
4847
// returns 1.0
4948
```
5049

5150
The function has the following parameters:
5251

5352
- **N**: number of indexed elements.
5453
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
55-
- **stride**: index increment for `x`.
54+
- **strideX**: stride length for `x`.
5655

57-
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the minimum absolute value of every other element in `x`,
56+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the minimum absolute value of every other element in `x`,
5857

5958
```javascript
60-
var floor = require( '@stdlib/math/base/special/floor' );
61-
6259
var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
63-
var N = floor( x.length / 2 );
6460

65-
var v = minabs( N, x, 2 );
61+
var v = minabs( 4, x, 2 );
6662
// returns 1.0
6763
```
6864

@@ -72,42 +68,35 @@ Note that indexing is relative to the first index. To introduce an offset, use [
7268

7369
```javascript
7470
var Float64Array = require( '@stdlib/array/float64' );
75-
var floor = require( '@stdlib/math/base/special/floor' );
7671

7772
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
7873
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
7974

80-
var N = floor( x0.length / 2 );
81-
82-
var v = minabs( N, x1, 2 );
75+
var v = minabs( 4, x1, 2 );
8376
// returns 1.0
8477
```
8578

86-
#### minabs.ndarray( N, x, stride, offset )
79+
#### minabs.ndarray( N, x, strideX, offsetX )
8780

8881
Computes the minimum absolute value of a strided array using alternative indexing semantics.
8982

9083
```javascript
9184
var x = [ 1.0, -2.0, 2.0 ];
92-
var N = x.length;
9385

94-
var v = minabs.ndarray( N, x, 1, 0 );
86+
var v = minabs.ndarray( x.length, x, 1, 0 );
9587
// returns 1.0
9688
```
9789

9890
The function has the following additional parameters:
9991

100-
- **offset**: starting index for `x`.
92+
- **offsetX**: starting index for `x`.
10193

102-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the minimum absolute value for every other value in `x` starting from the second value
94+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the minimum absolute value for every other element in `x` starting from the second element
10395

10496
```javascript
105-
var floor = require( '@stdlib/math/base/special/floor' );
106-
10797
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
108-
var N = floor( x.length / 2 );
10998

110-
var v = minabs.ndarray( N, x, 2, 1 );
99+
var v = minabs.ndarray( 4, x, 2, 1 );
111100
// returns 1.0
112101
```
113102

@@ -133,18 +122,12 @@ var v = minabs.ndarray( N, x, 2, 1 );
133122
<!-- eslint no-undef: "error" -->
134123

135124
```javascript
136-
var randu = require( '@stdlib/random/base/randu' );
137-
var round = require( '@stdlib/math/base/special/round' );
138-
var Float64Array = require( '@stdlib/array/float64' );
125+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
139126
var minabs = require( '@stdlib/stats/base/minabs' );
140127

141-
var x;
142-
var i;
143-
144-
x = new Float64Array( 10 );
145-
for ( i = 0; i < x.length; i++ ) {
146-
x[ i ] = round( (randu()*100.0) - 50.0 );
147-
}
128+
var x = discreteUniform( 10, -50, 50, {
129+
'dtype': 'float64'
130+
});
148131
console.log( x );
149132

150133
var v = minabs( x.length, x, 1 );

lib/node_modules/@stdlib/stats/base/minabs/benchmark/benchmark.js

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,18 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
2525
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2626
var pow = require( '@stdlib/math/base/special/pow' );
2727
var pkg = require( './../package.json' ).name;
28-
var minabs = require( './../lib/minabs.js' );
28+
var minabs = require( './../lib/main.js' );
29+
30+
31+
// VARIABLES //
32+
33+
var options = {
34+
'dtype': 'generic'
35+
};
2936

3037

3138
// FUNCTIONS //
@@ -38,13 +45,7 @@ var minabs = require( './../lib/minabs.js' );
3845
* @returns {Function} benchmark function
3946
*/
4047
function createBenchmark( len ) {
41-
var x;
42-
var i;
43-
44-
x = [];
45-
for ( i = 0; i < len; i++ ) {
46-
x.push( ( randu()*20.0 ) - 10.0 );
47-
}
48+
var x = uniform( len, -10, 10, options );
4849
return benchmark;
4950

5051
function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/minabs/benchmark/benchmark.ndarray.js

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

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
2525
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2626
var pow = require( '@stdlib/math/base/special/pow' );
2727
var pkg = require( './../package.json' ).name;
2828
var minabs = require( './../lib/ndarray.js' );
2929

3030

31+
// VARIABLES //
32+
33+
var options = {
34+
'dtype': 'generic'
35+
};
36+
37+
3138
// FUNCTIONS //
3239

3340
/**
@@ -38,13 +45,7 @@ var minabs = require( './../lib/ndarray.js' );
3845
* @returns {Function} benchmark function
3946
*/
4047
function createBenchmark( len ) {
41-
var x;
42-
var i;
43-
44-
x = [];
45-
for ( i = 0; i < len; i++ ) {
46-
x.push( ( randu()*20.0 ) - 10.0 );
47-
}
48+
var x = uniform( len, -10, 10, options );
4849
return benchmark;
4950

5051
function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/minabs/docs/repl.txt

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

2-
{{alias}}( N, x, stride )
2+
{{alias}}( N, x, strideX )
33
Computes the minimum absolute value of a strided array.
44

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

88
Indexing is relative to the first index. To introduce an offset, use a typed
99
array view.
@@ -18,8 +18,8 @@
1818
x: Array<number>|TypedArray
1919
Input array.
2020

21-
stride: integer
22-
Index increment.
21+
strideX: integer
22+
Stride length.
2323

2424
Returns
2525
-------
@@ -33,22 +33,19 @@
3333
> {{alias}}( x.length, x, 1 )
3434
1.0
3535

36-
// Using `N` and `stride` parameters:
36+
// Using `N` and stride parameters:
3737
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];
38-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
39-
> var stride = 2;
40-
> {{alias}}( N, x, stride )
38+
> {{alias}}( 3, x, 2 )
4139
1.0
4240

4341
// Using view offsets:
4442
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
4543
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
46-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
47-
> stride = 2;
48-
> {{alias}}( N, x1, stride )
44+
> {{alias}}( 3, x1, 2 )
4945
1.0
5046

51-
{{alias}}.ndarray( N, x, stride, offset )
47+
48+
{{alias}}.ndarray( N, x, strideX, offsetX )
5249
Computes the minimum absolute value of a strided array using alternative
5350
indexing semantics.
5451

@@ -64,10 +61,10 @@
6461
x: Array<number>|TypedArray
6562
Input array.
6663

67-
stride: integer
68-
Index increment.
64+
strideX: integer
65+
Stride length.
6966

70-
offset: integer
67+
offsetX: integer
7168
Starting index.
7269

7370
Returns
@@ -84,8 +81,7 @@
8481

8582
// Using offset parameter:
8683
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];
87-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
88-
> {{alias}}.ndarray( N, x, 2, 1 )
84+
> {{alias}}.ndarray( 3, x, 2, 1 )
8985
1.0
9086

9187
See Also

lib/node_modules/@stdlib/stats/base/minabs/docs/types/index.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ interface Routine {
3131
*
3232
* @param N - number of indexed elements
3333
* @param x - input array
34-
* @param stride - stride length
34+
* @param strideX - stride length
3535
* @returns minimum absolute value
3636
*
3737
* @example
@@ -40,15 +40,15 @@ interface Routine {
4040
* var v = minabs( x.length, x, 1 );
4141
* // returns 1.0
4242
*/
43-
( N: number, x: NumericArray, stride: number ): number;
43+
( N: number, x: NumericArray, strideX: number ): number;
4444

4545
/**
4646
* Computes the minimum absolute value of a strided array using alternative indexing semantics.
4747
*
4848
* @param N - number of indexed elements
4949
* @param x - input array
50-
* @param stride - stride length
51-
* @param offset - starting index
50+
* @param strideX - stride length
51+
* @param offsetX - starting index
5252
* @returns minimum absolute value
5353
*
5454
* @example
@@ -57,15 +57,15 @@ interface Routine {
5757
* var v = minabs.ndarray( x.length, x, 1, 0 );
5858
* // returns 1.0
5959
*/
60-
ndarray( N: number, x: NumericArray, stride: number, offset: number ): number;
60+
ndarray( N: number, x: NumericArray, strideX: number, offsetX: number ): number;
6161
}
6262

6363
/**
6464
* Computes the minimum absolute value of a strided array.
6565
*
6666
* @param N - number of indexed elements
6767
* @param x - input array
68-
* @param stride - stride length
68+
* @param strideX - stride length
6969
* @returns minimum absolute value
7070
*
7171
* @example

lib/node_modules/@stdlib/stats/base/minabs/examples/index.js

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

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
23-
var Float64Array = require( '@stdlib/array/float64' );
21+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
2422
var minabs = require( './../lib' );
2523

26-
var x;
27-
var i;
28-
29-
x = new Float64Array( 10 );
30-
for ( i = 0; i < x.length; i++ ) {
31-
x[ i ] = round( (randu()*100.0) - 50.0 );
32-
}
24+
var x = discreteUniform( 10, -50, 50, {
25+
'dtype': 'float64'
26+
});
3327
console.log( x );
3428

3529
var v = minabs( x.length, x, 1 );

lib/node_modules/@stdlib/stats/base/minabs/lib/index.js

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,29 +27,33 @@
2727
* var minabs = require( '@stdlib/stats/base/minabs' );
2828
*
2929
* var x = [ 1.0, -2.0, 2.0 ];
30-
* var N = x.length;
3130
*
32-
* var v = minabs( N, x, 1 );
31+
* var v = minabs( x.length, x, 1 );
3332
* // returns 1.0
3433
*
3534
* @example
36-
* var floor = require( '@stdlib/math/base/special/floor' );
3735
* var minabs = require( '@stdlib/stats/base/minabs' );
3836
*
3937
* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
40-
* var N = floor( x.length / 2 );
4138
*
42-
* var v = minabs.ndarray( N, x, 2, 1 );
39+
* var v = minabs.ndarray( 4, x, 2, 1 );
4340
* // returns 1.0
4441
*/
4542

4643
// MODULES //
4744

48-
var minabs = require( './main.js' );
45+
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
46+
var main = require( './main.js' );
47+
var ndarray = require( './ndarray.js' );
48+
49+
50+
// MAIN //
51+
52+
setReadOnly( main, 'ndarray', ndarray );
4953

5054

5155
// EXPORTS //
5256

53-
module.exports = minabs;
57+
module.exports = main;
5458

55-
// exports: { "ndarray": "minabs.ndarray" }
59+
// exports: { "ndarray": "main.ndarray" }

0 commit comments

Comments
 (0)