Skip to content

Commit 8a1514d

Browse files
kgrytekgryte
committed
chore: update descriptions and benchmarks
--- 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 e158863 commit 8a1514d

19 files changed

Lines changed: 84 additions & 64 deletions

‎lib/node_modules/@stdlib/random/uniform/README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Uniform Random Numbers
2222

23-
> Generate pseudorandom numbers drawn from a [uniform][@stdlib/random/base/uniform] distribution.
23+
> Generate pseudorandom numbers drawn from a [continuous uniform][@stdlib/random/base/uniform] distribution.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var uniform = require( '@stdlib/random/uniform' );
3232

3333
#### uniform( shape, a, b\[, options] )
3434

35-
Returns an [ndarray][@stdlib/ndarray/ctor] containing pseudorandom numbers drawn from a [uniform][@stdlib/random/base/uniform] distribution.
35+
Returns an [ndarray][@stdlib/ndarray/ctor] containing pseudorandom numbers drawn from a [continuous uniform][@stdlib/random/base/uniform] distribution.
3636

3737
```javascript
3838
var arr = uniform( [ 3, 3 ], 0.0, 1.0 );
@@ -55,7 +55,7 @@ var array = require( '@stdlib/ndarray/array' );
5555
var a = array( [ [ [ 0.0 ] ], [ [ 10.0 ] ] ] );
5656
// returns <ndarray>
5757

58-
var b = array( [ [ [ 10.0 ] ], [ [ 20.0 ] ] ] );
58+
var b = array( [ [ [ 1.0 ] ], [ [ 20.0 ] ] ] );
5959
// returns <ndarray>
6060

6161
var shape = getShape( a );
@@ -100,13 +100,13 @@ var opts = {
100100
var arr = uniform( [ 3, 3 ], 0.0, 1.0, opts );
101101
// returns <ndarray>
102102

103-
var dt = getDType( arr );
103+
var dt = String( getDType( arr ) );
104104
// returns 'generic'
105105
```
106106

107107
#### uniform.assign( a, b, out )
108108

109-
Fills an [ndarray][@stdlib/ndarray/ctor] with pseudorandom numbers drawn from a [uniform][@stdlib/random/base/uniform] distribution.
109+
Fills an [ndarray][@stdlib/ndarray/ctor] with pseudorandom numbers drawn from a [continuous uniform][@stdlib/random/base/uniform] distribution.
110110

111111
```javascript
112112
var zeros = require( '@stdlib/ndarray/zeros' );
@@ -129,7 +129,7 @@ The method has the following parameters:
129129

130130
#### uniform.factory( \[options] )
131131

132-
Returns a function for generating pseudorandom numbers drawn from a [uniform][@stdlib/random/base/uniform] distribution.
132+
Returns a function for generating pseudorandom numbers drawn from a [continuous uniform][@stdlib/random/base/uniform] distribution.
133133

134134
```javascript
135135
var getShape = require( '@stdlib/ndarray/shape' );
@@ -321,7 +321,7 @@ var sz = random.byteLength;
321321

322322
```javascript
323323
var logEach = require( '@stdlib/console/log-each' );
324-
var toArray = require( '@stdlib/ndarray/to-array' );
324+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
325325
var uniform = require( '@stdlib/random/uniform' );
326326

327327
// Create a function for generating random arrays originating from the same state:
@@ -336,7 +336,7 @@ var x2 = random( [ 5 ], 0.0, 1.0 );
336336
var x3 = random( [ 5 ], 0.0, 1.0 );
337337

338338
// Print the contents:
339-
logEach( '%f, %f, %f', toArray( x1 ), toArray( x2 ), toArray( x3 ) );
339+
logEach( '%f, %f, %f', ndarray2array( x1 ), ndarray2array( x2 ), ndarray2array( x3 ) );
340340

341341
// Create another function for generating random arrays with the original state:
342342
random = uniform.factory({
@@ -348,7 +348,7 @@ random = uniform.factory({
348348
var x4 = random( [ 3, 5 ], 0.0, 1.0 );
349349

350350
// Convert to a list of nested arrays:
351-
var arr = toArray( x4 );
351+
var arr = ndarray2array( x4 );
352352

353353
// Print the contents:
354354
console.log( '' );

‎lib/node_modules/@stdlib/random/uniform/benchmark/benchmark.1d.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ var bench = require( '@stdlib/bench' );
2424
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2525
var pow = require( '@stdlib/math/base/special/pow' );
2626
var orders = require( '@stdlib/ndarray/orders' );
27+
var format = require( '@stdlib/string/format' );
2728
var pkg = require( './../package.json' ).name;
2829
var random = require( './../lib' );
2930

@@ -116,7 +117,7 @@ function main() {
116117

117118
sh = [ len ];
118119
f = createBenchmark( len, sh, t1, ord );
119-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
120+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
120121
}
121122
}
122123
}

‎lib/node_modules/@stdlib/random/uniform/benchmark/benchmark.2d.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ var pow = require( '@stdlib/math/base/special/pow' );
2626
var sqrt = require( '@stdlib/math/base/special/sqrt' );
2727
var floor = require( '@stdlib/math/base/special/floor' );
2828
var orders = require( '@stdlib/ndarray/orders' );
29+
var format = require( '@stdlib/string/format' );
2930
var pkg = require( './../package.json' ).name;
3031
var random = require( './../lib' );
3132

@@ -118,17 +119,17 @@ function main() {
118119

119120
sh = [ len/2, 2 ];
120121
f = createBenchmark( len, sh, t1, ord );
121-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
122+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
122123

123124
sh = [ 2, len/2 ];
124125
f = createBenchmark( len, sh, t1, ord );
125-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
126+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
126127

127128
len = floor( sqrt( len ) );
128129
sh = [ len, len ];
129130
len *= len;
130131
f = createBenchmark( len, sh, t1, ord );
131-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
132+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
132133
}
133134
}
134135
}

‎lib/node_modules/@stdlib/random/uniform/benchmark/benchmark.3d.assign.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ var cbrt = require( '@stdlib/math/base/special/cbrt' );
2727
var floor = require( '@stdlib/math/base/special/floor' );
2828
var zeros = require( '@stdlib/ndarray/zeros' );
2929
var orders = require( '@stdlib/ndarray/orders' );
30+
var format = require( '@stdlib/string/format' );
3031
var pkg = require( './../package.json' ).name;
3132
var random = require( './../lib' ).assign;
3233

@@ -119,17 +120,17 @@ function main() {
119120

120121
sh = [ len/2, 2, 1 ];
121122
f = createBenchmark( len, sh, t1, ord );
122-
bench( pkg+':assign:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
123+
bench( format( '%s:assign:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
123124

124125
sh = [ 1, 2, len/2 ];
125126
f = createBenchmark( len, sh, t1, ord );
126-
bench( pkg+':assign:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
127+
bench( format( '%s:assign:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
127128

128129
len = floor( cbrt( len ) );
129130
sh = [ len, len, len ];
130131
len *= len * len;
131132
f = createBenchmark( len, sh, t1, ord );
132-
bench( pkg+':assign:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
133+
bench( format( '%s:assign:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
133134
}
134135
}
135136
}

‎lib/node_modules/@stdlib/random/uniform/benchmark/benchmark.3d.broadcast.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ var floor = require( '@stdlib/math/base/special/floor' );
2828
var array = require( '@stdlib/ndarray/array' );
2929
var filledarray = require( '@stdlib/array/filled' );
3030
var orders = require( '@stdlib/ndarray/orders' );
31+
var format = require( '@stdlib/string/format' );
3132
var pkg = require( './../package.json' ).name;
3233
var random = require( './../lib' );
3334

@@ -135,17 +136,17 @@ function main() {
135136

136137
sh = [ len/2, 2, 1 ];
137138
f = createBenchmark( len, sh, t1, ord );
138-
bench( pkg+'::broadcast:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
139+
bench( format( '%s::broadcast:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
139140

140141
sh = [ 1, 2, len/2 ];
141142
f = createBenchmark( len, sh, t1, ord );
142-
bench( pkg+'::broadcast:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
143+
bench( format( '%s::broadcast:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
143144

144145
len = floor( cbrt( len ) );
145146
sh = [ len, len, len ];
146147
len *= len * len;
147148
f = createBenchmark( len, sh, t1, ord );
148-
bench( pkg+'::broadcast:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
149+
bench( format( '%s::broadcast:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
149150
}
150151
}
151152
}

‎lib/node_modules/@stdlib/random/uniform/benchmark/benchmark.3d.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ var pow = require( '@stdlib/math/base/special/pow' );
2626
var cbrt = require( '@stdlib/math/base/special/cbrt' );
2727
var floor = require( '@stdlib/math/base/special/floor' );
2828
var orders = require( '@stdlib/ndarray/orders' );
29+
var format = require( '@stdlib/string/format' );
2930
var pkg = require( './../package.json' ).name;
3031
var random = require( './../lib' );
3132

@@ -118,17 +119,17 @@ function main() {
118119

119120
sh = [ len/2, 2, 1 ];
120121
f = createBenchmark( len, sh, t1, ord );
121-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
122+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
122123

123124
sh = [ 1, 2, len/2 ];
124125
f = createBenchmark( len, sh, t1, ord );
125-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
126+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
126127

127128
len = floor( cbrt( len ) );
128129
sh = [ len, len, len ];
129130
len *= len * len;
130131
f = createBenchmark( len, sh, t1, ord );
131-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
132+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
132133
}
133134
}
134135
}

‎lib/node_modules/@stdlib/random/uniform/benchmark/benchmark.3d.same_shape.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ var floor = require( '@stdlib/math/base/special/floor' );
2828
var array = require( '@stdlib/ndarray/array' );
2929
var filledarray = require( '@stdlib/array/filled' );
3030
var orders = require( '@stdlib/ndarray/orders' );
31+
var format = require( '@stdlib/string/format' );
3132
var pkg = require( './../package.json' ).name;
3233
var random = require( './../lib' );
3334

@@ -134,17 +135,17 @@ function main() {
134135

135136
sh = [ len/2, 2, 1 ];
136137
f = createBenchmark( len, sh, t1, ord );
137-
bench( pkg+'::same_shape:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
138+
bench( format( '%s::same_shape:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
138139

139140
sh = [ 1, 2, len/2 ];
140141
f = createBenchmark( len, sh, t1, ord );
141-
bench( pkg+'::same_shape:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
142+
bench( format( '%s::same_shape:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
142143

143144
len = floor( cbrt( len ) );
144145
sh = [ len, len, len ];
145146
len *= len * len;
146147
f = createBenchmark( len, sh, t1, ord );
147-
bench( pkg+'::same_shape:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
148+
bench( format( '%s::same_shape:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
148149
}
149150
}
150151
}

‎lib/node_modules/@stdlib/random/uniform/benchmark/benchmark.4d.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
2525
var pow = require( '@stdlib/math/base/special/pow' );
2626
var floor = require( '@stdlib/math/base/special/floor' );
2727
var orders = require( '@stdlib/ndarray/orders' );
28+
var format = require( '@stdlib/string/format' );
2829
var pkg = require( './../package.json' ).name;
2930
var random = require( './../lib' );
3031

@@ -117,17 +118,17 @@ function main() {
117118

118119
sh = [ len/2, 2, 1, 1 ];
119120
f = createBenchmark( len, sh, t1, ord );
120-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
121+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
121122

122123
sh = [ 1, 1, 2, len/2 ];
123124
f = createBenchmark( len, sh, t1, ord );
124-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
125+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
125126

126127
len = floor( pow( len, 1.0/4.0 ) );
127128
sh = [ len, len, len, len ];
128129
len *= len * len * len;
129130
f = createBenchmark( len, sh, t1, ord );
130-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
131+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
131132
}
132133
}
133134
}

‎lib/node_modules/@stdlib/random/uniform/benchmark/benchmark.5d.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
2525
var pow = require( '@stdlib/math/base/special/pow' );
2626
var floor = require( '@stdlib/math/base/special/floor' );
2727
var orders = require( '@stdlib/ndarray/orders' );
28+
var format = require( '@stdlib/string/format' );
2829
var pkg = require( './../package.json' ).name;
2930
var random = require( './../lib' );
3031

@@ -117,17 +118,17 @@ function main() {
117118

118119
sh = [ len/2, 2, 1, 1, 1 ];
119120
f = createBenchmark( len, sh, t1, ord );
120-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
121+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
121122

122123
sh = [ 1, 1, 1, 2, len/2 ];
123124
f = createBenchmark( len, sh, t1, ord );
124-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
125+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
125126

126127
len = floor( pow( len, 1.0/5.0 ) );
127128
sh = [ len, len, len, len, len ];
128129
len *= pow( len, 4 );
129130
f = createBenchmark( len, sh, t1, ord );
130-
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
131+
bench( format( '%s:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join( ',' ), ord, t1 ), f );
131132
}
132133
}
133134
}

‎lib/node_modules/@stdlib/random/uniform/benchmark/benchmark.factory.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,14 @@
2222

2323
var bench = require( '@stdlib/bench' );
2424
var isFunction = require( '@stdlib/assert/is-function' );
25+
var format = require( '@stdlib/string/format' );
2526
var pkg = require( './../package.json' ).name;
2627
var factory = require( './../lib' ).factory;
2728

2829

2930
// MAIN //
3031

31-
bench( pkg+'::no_options:factory', function benchmark( b ) {
32+
bench( format( '%s::no_options:factory', pkg ), function benchmark( b ) {
3233
var out;
3334
var i;
3435

@@ -47,7 +48,7 @@ bench( pkg+'::no_options:factory', function benchmark( b ) {
4748
b.end();
4849
});
4950

50-
bench( pkg+'::options:factory', function benchmark( b ) {
51+
bench( format( '%s::options:factory', pkg ), function benchmark( b ) {
5152
var out;
5253
var i;
5354

0 commit comments

Comments
 (0)