Skip to content
Open
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
03283ec
feat: initial implementation of halfnormal/mean
shubham220420 Jan 7, 2026
078ba3b
Merge branch 'stdlib-js:develop' into shubham2204-halfnornmal
shubham220420 Jan 7, 2026
988e772
fix: add remaining dependency
shubham220420 Jan 7, 2026
325deda
fix: add remaining dependency
shubham220420 Jan 7, 2026
dc06fdd
Merge branch 'shubham2204-halfnornmal' of https://github.com/shubham2…
shubham220420 Jan 7, 2026
c760013
fix: incorrect imports
shubham220420 Jan 7, 2026
7590117
fix: addd missing semi-colon
shubham220420 Jan 7, 2026
1ae8640
fix: linting and header errors
shubham220420 Jan 7, 2026
d425601
fix: linting and header errors
shubham220420 Jan 7, 2026
14a6709
fix: JavaScript linting errors
shubham220420 Jan 7, 2026
7eba0df
fix: add missing import
shubham220420 Jan 7, 2026
67af003
fix indentation error in runner.jl
shubham220420 Jan 7, 2026
2cc7feb
fix indentation error in test.js
shubham220420 Jan 7, 2026
bfd355d
Merge branch 'shubham2204-halfnornmal' of https://github.com/shubham2…
shubham220420 Jan 7, 2026
456b330
Fix indentation in runner.jl for expected values
shubham220420 Jan 7, 2026
0237bde
fix indentation error in test.js
shubham220420 Jan 7, 2026
05b423b
update index.js
shubham220420 Jan 7, 2026
fb50db0
Merge branch 'shubham2204-halfnornmal' of https://github.com/shubham2…
shubham220420 Jan 7, 2026
ef5a2b4
fix: add requested changes
shubham220420 Jan 7, 2026
b67f00a
fix: add requested suggestions
shubham220420 Jan 8, 2026
844243e
fix: typo error
shubham220420 Jan 8, 2026
9aed15c
fix: add missing imports
shubham220420 Jan 8, 2026
15e42a2
fix: test.js
shubham220420 Jan 8, 2026
7781f33
fix: JavaScript linting error
shubham220420 Jan 8, 2026
c57ccb4
remove unused format in benchmark.native.js
shubham220420 Jan 8, 2026
724e7bd
fix: add requested suggestions
shubham220420 Jan 10, 2026
b9bd554
Merge branch 'stdlib-js:develop' into shubham2204-halfnornmal
shubham220420 Jan 10, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
245 changes: 245 additions & 0 deletions lib/node_modules/@stdlib/stats/base/dists/halfnormal/mean/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,245 @@
<!--

@license Apache-2.0

Copyright (c) 2026 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# Mean

> [Half-normal][half-normal-distribution] distribution [expected value][mean].

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

The [expected value][mean] for a [half-normal][half-normal-distribution] random variable with scale parameter `σ > 0` is

<!-- <equation class="equation" label="eq:halfnormal_expectation" align="center" raw="\mathbb{E}\left[ X \right] = \sigma \sqrt{\frac{2}{\pi}}" alt="Expected value for a half-normal distribution."> -->

```math
\mathbb{E}\left[ X \right] = \sigma \sqrt{\frac{2}{\pi}}
```

<!-- <div class="equation" align="center" data-raw-text="\mathbb{E}\left[ X \right] = \sigma \sqrt{\frac{2}{\pi}}" data-equation="eq:halfnormal_expectation">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/halfnormal/mean/docs/img/equation_halfnormal_expectation.svg" alt="Expected value for a half-normal distribution.">
<br>
</div> -->

<!-- </equation> -->

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var mean = require( '@stdlib/stats/base/dists/halfnormal/mean' );
```

#### mean( sigma )

Returns the [expected value][mean] for a [half-normal][half-normal-distribution] distribution with scale parameter `sigma`.

```javascript
var y = mean( 1.0 );
// returns ~0.798

y = mean( 4.0 );
// returns ~3.1915382432114616

y = mean( 0.5 );
// returns ~0.399
```

If provided `NaN` as any argument, the function returns `NaN`.

```javascript
var y = mean( NaN );
// returns NaN
```

If provided `sigma <= 0`, the function returns `NaN`.

```javascript
var y = mean( 0.0 );
// returns NaN

y = mean( -1.0 );
// returns NaN
```

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var mean = require( '@stdlib/stats/base/dists/halfnormal/mean' );

var opts = {
'dtype': 'float64'
};
var sigma = uniform( 10, 0.0, 20.0, opts );

logEachMap( 'σ: %0.4f, E(X;σ): %0.4f', sigma, mean );
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

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

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C API usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/stats/base/dists/halfnormal/mean.h"
```

#### stdlib_base_dists_halfnormal_mean( sigma )

Returns the expected value for a [half-normal][half-normal-distribution] distribution with scale parameter `sigma`.

- **sigma**: `[in] double` scale parameter.
- **return**: `[out] double` expected value.

```c
double stdlib_base_dists_halfnormal_mean( const double sigma );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/stats/base/dists/halfnormal/mean.h"
#include <stdlib.h>
#include <stdio.h>

static double random_uniform( const double min, const double max ) {
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
return min + ( v*(max-min) );
}

int main( void ) {
double sigma;
double y;
int i;

for ( i = 0; i < 10; i++ ) {
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_halfnormal_mean( sigma );
printf( "σ: %.4f, E(X;σ): %.4f\n", sigma, y );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[half-normal-distribution]: https://en.wikipedia.org/wiki/Half-normal_distribution

[mean]: https://en.wikipedia.org/wiki/Mean

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var EPS = require( '@stdlib/constants/float64/eps' );
var pkg = require( './../package.json' ).name;
var mean = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var sigma;
var y;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
sigma = ( randu()*20.0 ) + EPS;
y = mean( sigma );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var Float64Array = require( '@stdlib/array/float64' );
var uniform = require( '@stdlib/random/base/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var tryRequire = require( '@stdlib/utils/try-require' );
var EPS = require( '@stdlib/constants/float64/eps' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var mean = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( mean instanceof Error )
};


// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {

Check warning on line 43 in lib/node_modules/@stdlib/stats/base/dists/halfnormal/mean/benchmark/benchmark.native.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Use `@stdlib/string/format` instead of string concatenation for benchmark descriptions
var sigma;
var len;
var y;
var i;

len = 100;
sigma = new Float64Array( len );
for ( i = 0; i < len; i++ ) {
sigma[ i ] = uniform( EPS, 20.0 );
}
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = mean( sigma[ i % len ] );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Loading