Skip to content

Commit add5e31

Browse files
yuvimittalyuvimittal
committed
Readme update
--- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent a68fff2 commit add5e31

File tree

6 files changed

+97
-96
lines changed

6 files changed

+97
-96
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ for ( i = 0; i < lambda.length; i++ ) {
148148

149149
#### stdlib_base_dists_planck_stdev( lambda )
150150

151-
Evaluates the standard deviation for an planck distribution.
151+
Returns the standard deviation of a Planck distribution with shape parameter `λ`.
152152

153153
```c
154154
double out = stdlib_base_dists_planck_stdev( 0.1 );
@@ -180,6 +180,7 @@ double stdlib_base_dists_planck_stdev( const double lambda );
180180
<section class="examples">
181181
182182
### Examples
183+
183184
```c
184185
#include "stdlib/stats/base/dists/planck/stdev.h"
185186
#include <stdlib.h>

‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/base/uniform' );
2525
var Float64Array = require( '@stdlib/array/float64' );
2626
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2727
var pkg = require( './../package.json' ).name;
@@ -39,7 +39,7 @@ bench( pkg, function benchmark( b ) {
3939
len = 100;
4040
lambda = new Float64Array( len );
4141
for ( i = 0; i < len; i++ ) {
42-
lambda[ i ] = ( randu() * 10.0 ) + 1.0;
42+
lambda[ i ] = uniform(0.1, 11);
4343
}
4444

4545
b.tic();

‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js‎

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

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var uniform = require( '@stdlib/random/base/uniform' );
2626
var Float64Array = require( '@stdlib/array/float64' );
2727
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2828
var tryRequire = require( '@stdlib/utils/try-require' );
@@ -39,7 +39,7 @@ var opts = {
3939

4040
// MAIN //
4141

42-
bench( pkg+'::native', opts , function benchmark( b ) {
42+
bench( pkg+'::native', opts, function benchmark( b ) {
4343
var lambda;
4444
var len;
4545
var y;
@@ -48,7 +48,7 @@ bench( pkg+'::native', opts , function benchmark( b ) {
4848
len = 100;
4949
lambda = new Float64Array( len );
5050
for ( i = 0; i < len; i++ ) {
51-
lambda[ i ] = ( randu() * 10.0 ) + 1.0;
51+
lambda[ i ] = uniform(0.1, 11);
5252
}
5353

5454
b.tic();

‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.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 standard deviation (stdev) for an planck distribution with shape parameter lambda.
30+
* Returns the standard deviation of a Planck distribution with shape parameter `λ`.
3131
*/
3232
double stdlib_base_dists_planck_stdev( const double lambda );
3333

‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json‎

Lines changed: 88 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,91 @@
11
{
2-
"options": {
2+
"options": {
3+
"task": "build",
4+
"wasm": false
5+
},
6+
"fields": [
7+
{
8+
"field": "src",
9+
"resolve": true,
10+
"relative": true
11+
},
12+
{
13+
"field": "include",
14+
"resolve": true,
15+
"relative": true
16+
},
17+
{
18+
"field": "libraries",
19+
"resolve": false,
20+
"relative": false
21+
},
22+
{
23+
"field": "libpath",
24+
"resolve": true,
25+
"relative": false
26+
}
27+
],
28+
"confs": [
29+
{
330
"task": "build",
4-
"wasm": false
31+
"wasm": false,
32+
"src": [
33+
"./src/main.c"
34+
],
35+
"include": [
36+
"./include"
37+
],
38+
"libraries": [],
39+
"libpath": [],
40+
"dependencies": [
41+
"@stdlib/math/base/napi/unary",
42+
"@stdlib/math/base/assert/is-nan",
43+
"@stdlib/math/base/special/abs",
44+
"@stdlib/math/base/special/expm1",
45+
"@stdlib/math/base/special/sqrt",
46+
"@stdlib/math/base/special/exp",
47+
"@stdlib/constants/float64/pi"
48+
]
49+
},
50+
{
51+
"task": "benchmark",
52+
"wasm": false,
53+
"src": [
54+
"./src/main.c"
55+
],
56+
"include": [
57+
"./include"
58+
],
59+
"libraries": [],
60+
"libpath": [],
61+
"dependencies": [
62+
"@stdlib/math/base/assert/is-nan",
63+
"@stdlib/math/base/special/abs",
64+
"@stdlib/math/base/special/expm1",
65+
"@stdlib/math/base/special/sqrt",
66+
"@stdlib/math/base/special/exp",
67+
"@stdlib/constants/float64/pi"
68+
]
569
},
6-
"fields": [
7-
{
8-
"field": "src",
9-
"resolve": true,
10-
"relative": true
11-
},
12-
{
13-
"field": "include",
14-
"resolve": true,
15-
"relative": true
16-
},
17-
{
18-
"field": "libraries",
19-
"resolve": false,
20-
"relative": false
21-
},
22-
{
23-
"field": "libpath",
24-
"resolve": true,
25-
"relative": false
26-
}
27-
],
28-
"confs": [
29-
{
30-
"task": "build",
31-
"wasm": false,
32-
"src": [
33-
"./src/main.c"
34-
],
35-
"include": [
36-
"./include"
37-
],
38-
"libraries": [],
39-
"libpath": [],
40-
"dependencies": [
41-
"@stdlib/math/base/napi/unary",
42-
"@stdlib/math/base/assert/is-nan",
43-
"@stdlib/math/base/special/abs",
44-
"@stdlib/math/base/special/expm1",
45-
"@stdlib/math/base/special/sqrt",
46-
"@stdlib/math/base/special/exp",
47-
"@stdlib/constants/float64/pi"
48-
]
49-
},
50-
{
51-
"task": "benchmark",
52-
"wasm": false,
53-
"src": [
54-
"./src/main.c"
55-
],
56-
"include": [
57-
"./include"
58-
],
59-
"libraries": [],
60-
"libpath": [],
61-
"dependencies": [
62-
"@stdlib/math/base/assert/is-nan",
63-
"@stdlib/math/base/special/abs",
64-
"@stdlib/math/base/special/expm1",
65-
"@stdlib/math/base/special/sqrt",
66-
"@stdlib/math/base/special/exp",
67-
"@stdlib/constants/float64/pi"
68-
]
69-
},
70-
{
71-
"task": "examples",
72-
"wasm": false,
73-
"src": [
74-
"./src/main.c"
75-
],
76-
"include": [
77-
"./include"
78-
],
79-
"libraries": [],
80-
"libpath": [],
81-
"dependencies": [
82-
"@stdlib/math/base/assert/is-nan",
83-
"@stdlib/math/base/special/abs",
84-
"@stdlib/math/base/special/expm1",
85-
"@stdlib/math/base/special/sqrt",
86-
"@stdlib/math/base/special/exp",
87-
"@stdlib/constants/float64/pi"
88-
]
89-
}
90-
]
91-
}
70+
{
71+
"task": "examples",
72+
"wasm": false,
73+
"src": [
74+
"./src/main.c"
75+
],
76+
"include": [
77+
"./include"
78+
],
79+
"libraries": [],
80+
"libpath": [],
81+
"dependencies": [
82+
"@stdlib/math/base/assert/is-nan",
83+
"@stdlib/math/base/special/abs",
84+
"@stdlib/math/base/special/expm1",
85+
"@stdlib/math/base/special/sqrt",
86+
"@stdlib/math/base/special/exp",
87+
"@stdlib/constants/float64/pi"
88+
]
89+
}
90+
]
91+
}

‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
#include "stdlib/math/base/special/sqrt.h"
2424

2525
/**
26-
* Evaluates the standard deviation of a Planck distribution given a shape parameter `lambda`.
26+
* Returns the standard deviation of a Planck distribution with shape parameter `λ`.
2727
*
2828
* @param lambda shape parameter
2929
* @return standard deviation

0 commit comments

Comments
 (0)