Skip to content

Commit a672c33

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 e70b7ac commit a672c33

File tree

6 files changed

+29
-45
lines changed

6 files changed

+29
-45
lines changed

lib/node_modules/@stdlib/stats/base/dists/logistic/pdf/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ for ( i = 0; i < 10; i++ ) {
170170

171171
#### stdlib_base_dists_logistic_pdf( x, mu, s )
172172

173-
Returns the pdf for a logistic distribution with input `x`, location `mu` and scale `s`.
173+
Evaluates the [probability density function][pdf] (PDF) for a [logistic][logistic-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter).
174174

175175
```c
176176
double out = stdlib_base_dists_logistic_pdf( 2.0, 0.0, 1.0 );
@@ -188,34 +188,46 @@ double stdlib_base_dists_logistic_pdf( const double x, const double mu, const do
188188
```
189189
190190
</section>
191+
191192
<!-- /.usage -->
193+
192194
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
195+
193196
<section class="notes">
197+
194198
</section>
199+
195200
<!-- /.notes -->
201+
196202
<!-- C API usage examples. -->
203+
197204
<section class="examples">
205+
198206
### Examples
207+
199208
```c
200209
#include "stdlib/stats/base/dists/logistic/pdf.h"
201210
#include <stdlib.h>
202211
#include <stdio.h>
212+
203213
static double random_uniform( const double min, const double max ) {
204214
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
205215
return min + ( v * ( max-min ) );
206216
}
217+
207218
int main( void ) {
208219
double mu;
209220
double s;
210221
double x;
211222
double y;
212223
int i;
224+
213225
for ( i = 0; i < 25; i++ ) {
214-
mu = random_uniform( 0.0, 10.0 ) - 5.0;
226+
mu = random_uniform( -5.0, 5.0 );
215227
s = random_uniform( 0.0, 20.0 );
216-
x = random_uniform( 0.0, 10.0 );
228+
x = random_uniform( -10.0, 10.0 );
217229
y = stdlib_base_dists_logistic_pdf( x, mu, s );
218-
printf( "x: %lf, µ: %lf, s: %lf, Pdf(X;x,µ,s): %lf\n", x, mu, s, y );
230+
printf( "x: %lf, µ: %lf, s: %lf, f(x;µ,s): %lf\n", x, mu, s, y );
219231
}
220232
}
221233
```

lib/node_modules/@stdlib/stats/base/dists/logistic/pdf/benchmark/benchmark.native.js

Lines changed: 4 additions & 4 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;
@@ -53,9 +53,9 @@ bench( pkg, opts, function benchmark( b ) {
5353
mu = new Float64Array( len );
5454
s = new Float64Array( len );
5555
for ( i = 0; i < len; i++ ) {
56-
x[ i ] = ( randu()*40.0 ) - 20.0;
57-
mu[ i ] = ( randu() * 100.0 ) - 50.0;
58-
s[ i ] = ( randu() * 20.0 ) + EPS;
56+
x[ i ] = uniform( -20.0, 20.0 );
57+
mu[ i ] = uniform( -50.0, 50.0 );
58+
s[ i ] = uniform( EPS, 20.0 );
5959
}
6060

6161
b.tic();

lib/node_modules/@stdlib/stats/base/dists/logistic/pdf/benchmark/c/benchmark.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,9 @@ static double benchmark( void ) {
102102
int i;
103103

104104
for ( i = 0; i < 100; i++ ) {
105-
x[ i ] = random_uniform( 0.0, 100.0 );
106-
mu[ i ] = random_uniform( 0.0, 100.0 );
107-
s[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
105+
x[ i ] = random_uniform( -100.0, 100.0 );
106+
mu[ i ] = random_uniform( -50.0, 50.0 );
107+
s[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
108108
}
109109

110110
t = tic();

lib/node_modules/@stdlib/stats/base/dists/logistic/pdf/examples/c/example.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,6 @@ int main( void ) {
3737
mu = random_uniform( 0.0, 10.0 );
3838
s = random_uniform( 0.0, 10.0 );
3939
y = stdlib_base_dists_logistic_pdf( x, mu, s );
40-
printf( "x: %lf, µ: %lf, s: %lf, pdf(X;x,µ,s): %lf\n", x, mu, s, y );
40+
printf( "x: %lf, µ: %lf, s: %lf, f(x;µ,s): %lf\n", x, mu, s, y );
4141
}
4242
}

lib/node_modules/@stdlib/stats/base/dists/logistic/pdf/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 probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`.
3030
*
31+
* @private
3132
* @param {number} x - input value
3233
* @param {number} mu - location parameter
3334
* @param {NonNegativeNumber} s - scale parameter

lib/node_modules/@stdlib/stats/base/dists/logistic/pdf/src/main.c

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -27,43 +27,14 @@
2727
/**
2828
* Evaluates the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`.
2929
*
30-
* @param {number} x - input value
31-
* @param {number} mu - location parameter
32-
* @param {NonNegativeNumber} s - scale parameter
33-
* @returns {number} evaluated PDF
30+
* @param x input value
31+
* @param mu location parameter
32+
* @param s scale parameter
33+
* @return evaluated PDF
3434
*
3535
* @example
3636
* double y = stdlib_base_dists_logistic_pdf( 2.0, 0.0, 1.0 );
3737
* // returns ~0.105
38-
*
39-
* @example
40-
* double y = stdlib_base_dists_logistic_pdf( -1.0, 4.0, 2.0 );
41-
* // returns ~0.035
42-
*
43-
* @example
44-
* double y = stdlib_base_dists_logistic_pdf( NaN, 0.0, 1.0 );
45-
* // returns NaN
46-
*
47-
* @example
48-
* double y = stdlib_base_dists_logistic_pdf( 0.0, NaN, 1.0 );
49-
* // returns NaN
50-
*
51-
* @example
52-
* double y = stdlib_base_dists_logistic_pdf( 0.0, 0.0, NaN );
53-
* // returns NaN
54-
*
55-
* @example
56-
* // Negative scale parameter:
57-
* double y = stdlib_base_dists_logistic_pdf( 2.0, 0.0, -1.0 );
58-
* // returns NaN
59-
*
60-
* @example
61-
* double y = stdlib_base_dists_logistic_pdf( 2.0, 8.0, 0.0 );
62-
* // returns 0.0
63-
*
64-
* @example
65-
* double y = stdlib_base_dists_logistic_pdf( 8.0, 8.0, 0.0 );
66-
* // returns Infinity
6738
*/
6839
double stdlib_base_dists_logistic_pdf( const double x, const double mu, const double s ) {
6940
double ez;

0 commit comments

Comments
 (0)