Skip to content

Commit 612293d

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 1593534 commit 612293d

File tree

6 files changed

+29
-30
lines changed

6 files changed

+29
-30
lines changed

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

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,32 +204,46 @@ double stdlib_base_dists_logistic_logcdf( const double x, const double mu, const
204204
```
205205
206206
</section>
207+
207208
<!-- /.usage -->
209+
208210
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
211+
209212
<section class="notes">
213+
210214
</section>
215+
211216
<!-- /.notes -->
217+
212218
<!-- C API usage examples. -->
219+
213220
<section class="examples">
221+
214222
### Examples
223+
215224
```c
216225
#include "stdlib/stats/base/dists/logistic/logcdf.h"
217226
#include <stdlib.h>
218227
#include <stdio.h>
228+
219229
static double random_uniform( const double min, const double max ) {
220230
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
221231
return min + ( v*(max-min) );
222232
}
233+
223234
int main( void ) {
224235
double mu;
225236
double s;
237+
double x;
226238
double y;
227239
int i;
240+
228241
for ( i = 0; i < 25; i++ ) {
229-
mu = random_uniform( 0.0, 10.0 ) - 5.0;
242+
mu = random_uniform( -5.0, 5.0 );
230243
s = random_uniform( 0.0, 20.0 );
244+
x = random_uniform( -10.0, 10.0 );
231245
y = stdlib_base_dists_logistic_logcdf( x, mu, s );
232-
printf( "x: %lf, µ: %lf, s: %lf, Var(X;µ,s): %lf\n", x, mu, s, y );
246+
printf( "x: %lf, µ: %lf, s: %lf, ln(F(x;µ,s)): %lf\n", x, mu, s, y );
233247
}
234248
}
235249
```

lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/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
s = new Float64Array( len );
5454
x = new Float64Array( len );
5555
for ( i = 0; i < len; i++ ) {
56-
x[ i ] = ( randu()*100.0 ) - 100;
57-
mu[ i ] = ( randu()*100.0 ) - 50.0;
58-
s[ i ] = ( randu()*20.0 ) + EPS;
56+
x[ i ] = uniform( -100.0, 100.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/logcdf/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-
mu[ i ] = random_uniform( 0.0, 10.0 );
106-
s[ i ] = random_uniform( 0.0, 10.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
107-
x[ i ] = random_uniform( 0.0, 10.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
105+
mu[ i ] = random_uniform( -50.0, 50.0 );
106+
s[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
107+
x[ i ] = random_uniform( -100.0, 100.0 );
108108
}
109109

110110
t = tic();

lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/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
s = random_uniform( 0.0, 10.0 );
3838
x = random_uniform( 0.0, 10.0 );
3939
y = stdlib_base_dists_logistic_logcdf( x, mu, s );
40-
printf( "x: %lf, µ: %lf, s: %lf, LOGCDF(X;x,µ,s): %lf\n", x, mu, s, y );
40+
printf( "x: %lf, µ: %lf, s: %lf, ln(F(x;µ,s)): %lf\n", x, mu, s, y );
4141
}
4242
}

lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/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 logarithm of the cumulative distribution function (CDF) 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/logcdf/src/main.c

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,30 +36,14 @@ double log1pexp( const double x ) {
3636
/**
3737
* Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`.
3838
*
39-
* @param {number} x - input value
40-
* @param {number} mu - location parameter
41-
* @param {NonNegativeNumber} s - scale parameter
42-
* @returns {number} evaluated logCDF
39+
* @param x input value
40+
* @param mu location parameter
41+
* @param s scale parameter
42+
* @return evaluated logCDF
4343
*
4444
* @example
4545
* double y = stdlib_base_dists_logistic_logcdf( 2.0, 0.0, 1.0 );
4646
* // returns ~-0.127
47-
*
48-
* @example
49-
* double y = stdlib_base_dists_logistic_logcdf( 5.0, 10.0, 3.0 );
50-
* // returns ~-1.84
51-
*
52-
* @example
53-
* double y = stdlib_base_dists_logistic_logcdf( 2.0, 0.0, NaN );
54-
* // returns NaN
55-
*
56-
* @example
57-
* double y = stdlib_base_dists_logistic_logcdf( 2, NaN, 1.0 );
58-
* // returns NaN
59-
*
60-
* @example
61-
* double y = stdlib_base_dists_logistic_logcdf( NaN, 0.0, 1.0 );
62-
* // returns NaN
6347
*/
6448
double stdlib_base_dists_logistic_logcdf( const double x, const double mu, const double s ) {
6549
double z;

0 commit comments

Comments
 (0)