Skip to content

Commit f372f82

Browse files
committed
chore: minor clean-up
--- 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: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 7c81929 commit f372f82

File tree

7 files changed

+18
-42
lines changed

7 files changed

+18
-42
lines changed

lib/node_modules/@stdlib/stats/base/dists/rayleigh/quantile/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ for ( i = 0; i < 10; i++ ) {
175175

176176
#### stdlib_base_dists_rayleigh_quantile( p, sigma )
177177

178-
Evaluates the quantile function for a Rayleigh distribution.
178+
Evaluates the [quantile function][quantile-function] for a [Rayleigh][rayleigh-distribution] distribution with parameter `sigma` (scale parameter).
179179

180180
```c
181181
double out = stdlib_base_dists_rayleigh_quantile( 0.8, 1.0 );
@@ -184,7 +184,7 @@ double out = stdlib_base_dists_rayleigh_quantile( 0.8, 1.0 );
184184

185185
The function accepts the following arguments:
186186

187-
- **p**: `[in] double` input value.
187+
- **p**: `[in] double` input probability.
188188
- **sigma**: `[in] double` scale parameter.
189189

190190
```c
@@ -214,10 +214,10 @@ int main( void ) {
214214
double y;
215215
int i;
216216
for ( i = 0; i < 25; i++ ) {
217-
p = random_uniform( 0.0, 10.0 );
218-
sigma = random_uniform( 0.0, 10.0 );
217+
p = random_uniform( 0.0, 1.0 );
218+
sigma = random_uniform( 0.1, 10.0 );
219219
y = stdlib_base_dists_rayleigh_quantile( p, sigma );
220-
printf( "p: %lf, σ: %lf, f(x;σ): %lf\n", p, sigma, y );
220+
printf( "p: %lf, σ: %lf, Q(p;σ): %lf\n", p, sigma, y );
221221
}
222222
}
223223
```

lib/node_modules/@stdlib/stats/base/dists/rayleigh/quantile/benchmark/benchmark.native.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
2525
var Float64Array = require( '@stdlib/array/float64' );
2626
var tryRequire = require( '@stdlib/utils/try-require' );
27-
var randu = require( '@stdlib/random/base/randu' );
27+
var uniform = require( '@stdlib/random/base/uniform' );
2828
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2929
var EPS = require( '@stdlib/constants/float64/eps' );
3030
var pkg = require( './../package.json' ).name;
@@ -51,8 +51,8 @@ bench( pkg, opts, function benchmark( b ) {
5151
p = new Float64Array( len );
5252
sigma = new Float64Array( len );
5353
for ( i = 0; i < len; i++ ) {
54-
p[ i ] = ( randu() * 100.0 ) - 100;
55-
sigma[ i ] = ( randu() * 20.0 ) + EPS;
54+
p[ i ] = uniform( 0.0, 1.0 );
55+
sigma[ i ] = uniform( EPS, 20.0 );
5656
}
5757

5858
b.tic();

lib/node_modules/@stdlib/stats/base/dists/rayleigh/quantile/benchmark/c/benchmark.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ static double benchmark( void ) {
101101
int i;
102102

103103
for ( i = 0; i < 100; i++ ) {
104-
p[ i ] = random_uniform( -100.0, 0.0 );
105-
sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS , STDLIB_CONSTANT_FLOAT64_EPS + 20.0 );
104+
p[ i ] = random_uniform( 0.0, 1.0 );
105+
sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
106106
}
107107

108108
t = tic();

lib/node_modules/@stdlib/stats/base/dists/rayleigh/quantile/examples/c/example.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ int main( void ) {
3232
int i;
3333

3434
for ( i = 0; i < 25; i++ ) {
35-
p = random_uniform( 0.0, 10.0 );
36-
sigma = random_uniform( 0.0, 10.0 );
35+
p = random_uniform( 0.0, 1.0 );
36+
sigma = random_uniform( 0.1, 10.0 );
3737
y = stdlib_base_dists_rayleigh_quantile( p, sigma );
38-
printf( "p: %lf, σ: %lf, f(x;σ): %lf\n", p, sigma, y );
38+
printf( "p: %lf, σ: %lf, Q(p;σ): %lf\n", p, sigma, y );
3939
}
4040
}

lib/node_modules/@stdlib/stats/base/dists/rayleigh/quantile/include/stdlib/stats/base/dists/rayleigh/quantile.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Evaluates the probability density function (QUANTILE) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.
30+
* Evaluates the quantile function for a Rayleigh distribution.
3131
*/
3232
double stdlib_base_dists_rayleigh_quantile( const double p, const double sigma );
3333

lib/node_modules/@stdlib/stats/base/dists/rayleigh/quantile/lib/native.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
2828
/**
2929
* Evaluates the quantile function for a Rayleigh distribution with scale parameter `sigma` at a probability `p`.
3030
*
31+
* @private
3132
* @param {Probability} p - input value
3233
* @param {NonNegativeNumber} sigma - scale parameter
3334
* @returns {number} evaluated quantile function

lib/node_modules/@stdlib/stats/base/dists/rayleigh/quantile/src/main.c

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -23,38 +23,13 @@
2323
/**
2424
* Evaluates the quantile function for a Rayleigh distribution with scale parameter `sigma` at a probability `p`.
2525
*
26-
* @param {Probability} p - input value
27-
* @param {NonNegativeNumber} sigma - scale parameter
28-
* @returns {number} evaluated quantile function
26+
* @param p input probability
27+
* @param sigma scale parameter
28+
* @return evaluated quantile function
2929
*
3030
* @example
3131
* double y = stdlib_base_dists_rayleigh_quantile( 0.8, 1.0 );
3232
* // returns ~1.794
33-
*
34-
* @example
35-
* double y = stdlib_base_dists_rayleigh_quantile( 0.5, 4.0 );
36-
* // returns ~4.71
37-
*
38-
* @example
39-
* double y = stdlib_base_dists_rayleigh_quantile( 1.1, 1.0 );
40-
* // returns NaN
41-
*
42-
* @example
43-
* double y = stdlib_base_dists_rayleigh_quantile( -0.2, 1.0 );
44-
* // returns NaN
45-
*
46-
* @example
47-
* double y = stdlib_base_dists_rayleigh_quantile( NaN, 1.0 );
48-
* // returns NaN
49-
*
50-
* @example
51-
* double y = stdlib_base_dists_rayleigh_quantile( 0.0, NaN );
52-
* // returns NaN
53-
*
54-
* @example
55-
* // Negative scale parameter:
56-
* double y = stdlib_base_dists_rayleigh_quantile( 0.5, -1.0 );
57-
* // returns NaN
5833
*/
5934
double stdlib_base_dists_rayleigh_quantile( const double p, const double sigma ) {
6035
double s2;

0 commit comments

Comments
 (0)