-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat: add implementation of median for halfnormal distribution
#9686
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
shubham220420
wants to merge
8
commits into
stdlib-js:develop
Choose a base branch
from
shubham220420:shubham2204-median
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,959
−0
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b20177f
feat: add implementation for median calculation of half-normal distri…
shubham220420 c860c1e
fix: update incorrect file name
shubham220420 80233c2
fix: update manifest and repl file
shubham220420 c7413c4
fix: update incorrect relative path
shubham220420 52f4070
update manifest
shubham220420 ec3e0b1
fix: add suggested changes
shubham220420 2d99a35
fix: apply requested suggestions
shubham220420 95a1e24
fix: add requested changes
shubham220420 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
246 changes: 246 additions & 0 deletions
246
lib/node_modules/@stdlib/stats/base/dists/halfnormal/median/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,246 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # Median | ||
|
|
||
| > [Half-normal][half-normal-distribution] distribution [median][median]. | ||
|
|
||
| <!-- 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 [median][median] for a [half-normal][half-normal-distribution] random variable with scale parameter `σ > 0` is | ||
|
|
||
| <!-- <equation class="equation" label="eq:halfnormal_median" align="center" raw="\operatorname{Median}\left[ X \right] = \sigma \Phi^{-1}(0.75)" alt="Median for a half-normal distribution."> --> | ||
|
|
||
| ```math | ||
| \mathop{\mathrm{Median}}\left[ X \right] = \sigma \Phi^{-1}(0.75) | ||
| ``` | ||
|
|
||
| <!-- <div class="equation" align="center" data-raw-text="\operatorname{Median}\left[ X \right] = \sigma \Phi^{-1}(0.75)" data-equation="eq:halfnormal_median"> | ||
| <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/halfnormal/median/docs/img/equation_halfnormal_median.svg" alt="Median for a half-normal distribution."> | ||
| <br> | ||
| </div> --> | ||
|
|
||
| <!-- </equation> --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <!-- Package usage documentation. --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var median = require( '@stdlib/stats/base/dists/halfnormal/median' ); | ||
| ``` | ||
|
|
||
| #### median( sigma ) | ||
|
|
||
| Returns the [median][median] for a [half-normal][half-normal-distribution] distribution with scale parameter `sigma`. | ||
|
|
||
| ```javascript | ||
| var y = median( 1.0 ); | ||
| // returns ~0.6744897501960818 | ||
|
|
||
| y = median( 4.0 ); | ||
| // returns ~2.6979590007843268 | ||
|
|
||
| y = median( 0.5 ); | ||
| // returns ~0.33724487509804085 | ||
| ``` | ||
|
|
||
| If provided `NaN` as any argument, the function returns `NaN`. | ||
|
|
||
| ```javascript | ||
| var y = median( NaN ); | ||
| // returns NaN | ||
| ``` | ||
|
|
||
| If provided `sigma <= 0`, the function returns `NaN`. | ||
|
|
||
| ```javascript | ||
| var y = median( 0.0 ); | ||
| // returns NaN | ||
|
|
||
| y = median( -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 median = require( '@stdlib/stats/base/dists/halfnormal/median' ); | ||
|
|
||
| var opts = { | ||
| 'dtype': 'float64' | ||
| }; | ||
| var sigma = uniform( 10, 0.0, 20.0, opts ); | ||
|
|
||
| logEachMap( 'σ: %lf, Median(X;σ): %lf', sigma, median ); | ||
| ``` | ||
|
|
||
| </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 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/median.h" | ||
| ``` | ||
|
|
||
| #### stdlib_base_dists_halfnormal_median( sigma ) | ||
|
|
||
| Returns the median for a [half-normal][half-normal-distribution] distribution with scale parameter `sigma`. | ||
|
|
||
| ```c | ||
| double out = stdlib_base_dists_halfnormal_median( 4.0 ); | ||
| // returns ~2.6979590007843268 | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **sigma**: `[in] double` scale parameter. | ||
| - **return**: `[out] double` median. | ||
|
|
||
| ```c | ||
| double stdlib_base_dists_halfnormal_median( 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/median.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_median( sigma ); | ||
| printf( "σ: %lf, Median(X;σ): %lf\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 | ||
|
|
||
| [median]: https://en.wikipedia.org/wiki/Median | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
59 changes: 59 additions & 0 deletions
59
lib/node_modules/@stdlib/stats/base/dists/halfnormal/median/benchmark/benchmark.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /** | ||
| * @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 Float64Array = require( '@stdlib/array/float64' ); | ||
| 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 median = require( './../lib' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg, function benchmark( b ) { | ||
| var sigma; | ||
| var len; | ||
| var y; | ||
| var i; | ||
|
|
||
| len = 100; | ||
| sigma = new Float64Array( len ); | ||
| for ( i = 0; i < len; i++ ) { | ||
| sigma[ i ] = ( randu() * 20.0 ) + EPS; | ||
| } | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| y = median( 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(); | ||
| }); |
67 changes: 67 additions & 0 deletions
67
lib/node_modules/@stdlib/stats/base/dists/halfnormal/median/benchmark/benchmark.native.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 median = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||
| var opts = { | ||
| 'skip': ( median instanceof Error ) | ||
| }; | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg+'::native', opts, function benchmark( b ) { | ||
| 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 = median( 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(); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.