Skip to content

Commit 55ca3e4

Browse files
committed
match exisiting template for variance docs
1 parent 2678965 commit 55ca3e4

2 files changed

Lines changed: 21 additions & 6 deletions

File tree

lib/node_modules/@stdlib/stats/base/dists/halfnormal/variance/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The [variance][variance] for a [half-normal][half-normal-distribution] random va
3131
<!-- <equation class="equation" label="eq:halfnormal_variance" align="center" raw="\operatorname{Var}\left[ X \right] = \sigma^{2} \left(1 - \frac{2}{\pi}\right)" alt="Variance for a half-normal distribution."> -->
3232

3333
```math
34-
\operatorname{Var}\left[ X \right] = \sigma^{2} \left(1 - \frac{2}{\pi}\right)
34+
\mathop{\mathrm{Var}}\left[ X \right] = \sigma^{2} \left(1 - \frac{2}{\pi}\right)
3535
```
3636

3737
<!-- <div class="equation" align="center" data-raw-text="\operatorname{Var}\left[ X \right] = \sigma^{2} \left(1 - \frac{2}{\pi}\right)" data-equation="eq:halfnormal_variance">
@@ -61,7 +61,7 @@ Returns the [variance][variance] for a [half-normal][half-normal-distribution] d
6161

6262
```javascript
6363
var y = variance( 1.0 );
64-
// returns ~0.363
64+
// returns ~0.3633802276
6565

6666
y = variance( 4.0 );
6767
// returns ~5.814083642118698
@@ -117,7 +117,7 @@ var opts = {
117117
};
118118
var sigma = uniform( 10, 0.0, 20.0, opts );
119119

120-
logEachMap( 'σ: %0.4f, Var(X;σ): %0.4f', sigma, variance );
120+
logEachMap( 'σ: %lf, Var(X;σ): %lf', sigma, variance );
121121
```
122122

123123
</section>
@@ -142,6 +142,8 @@ logEachMap( 'σ: %0.4f, Var(X;σ): %0.4f', sigma, variance );
142142

143143
<!-- Section for C API documentation. -->
144144

145+
* * *
146+
145147
<section class="c">
146148

147149
## C APIs
@@ -168,6 +170,12 @@ logEachMap( 'σ: %0.4f, Var(X;σ): %0.4f', sigma, variance );
168170

169171
Returns the variance for a [half-normal][half-normal-distribution] distribution with scale parameter `sigma`.
170172

173+
```c
174+
double out = stdlib_base_dists_halfnormal_variance( 1.0 );
175+
// returns ~0.3633802276
176+
```
177+
The function accepts the following arguments:
178+
171179
- **sigma**: `[in] double` scale parameter.
172180
- **return**: `[out] double` variance.
173181

@@ -211,7 +219,7 @@ int main( void ) {
211219
for ( i = 0; i < 10; i++ ) {
212220
sigma = random_uniform( 0.1, 20.0 );
213221
y = stdlib_base_dists_halfnormal_variance( sigma );
214-
printf( "σ: %.4f, Var(X;σ): %.4f\n", sigma, y );
222+
printf( "σ: %lf, Var(X;σ): %lf\n", sigma, y );
215223
}
216224
}
217225
```

lib/node_modules/@stdlib/stats/base/dists/halfnormal/variance/benchmark/benchmark.js

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

2323
var bench = require( '@stdlib/bench' );
24+
var Float64Array = require( '@stdlib/array/float64' );
2425
var randu = require( '@stdlib/random/base/randu' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var EPS = require( '@stdlib/constants/float64/eps' );
@@ -32,13 +33,19 @@ var variance = require( './../lib' );
3233

3334
bench( pkg, function benchmark( b ) {
3435
var sigma;
36+
var len;
3537
var y;
3638
var i;
3739

40+
len = 100;
41+
sigma = new Float64Array( len );
42+
for ( i = 0; i < len; i++ ) {
43+
sigma[ i ] = ( randu() * 20.0 ) + EPS;
44+
}
45+
3846
b.tic();
3947
for ( i = 0; i < b.iterations; i++ ) {
40-
sigma = ( randu()*20.0 ) + EPS;
41-
y = variance( sigma );
48+
y = variance( sigma[ i % len ] );
4249
if ( isnan( y ) ) {
4350
b.fail( 'should not return NaN' );
4451
}

0 commit comments

Comments
 (0)