feat: add Wald distribution mean package by manit2004 · Pull Request #9502 · stdlib-js/stdlib

manit2004 · 2026-01-02T13:11:36Z

Progresses #209

Description

This is a WIP pull request. Currently the core functionalities of Wald Distribution mean package has been implemented. Feedback needed on this implementation.

Tests, docs, examples and benchmark is yet to added, pending approval of the core implementation.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

RFC: add the Wald distribution #209

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

I have used this Wiki page as a reference.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

Yes
No

If you answered "yes" above, how did you use AI assistance?

Code generation (e.g., when writing an implementation or fixing a bug)
Test/benchmark generation
Documentation (including examples)
Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

@stdlib-js/reviewers

Planeshifter · 2026-01-04T06:42:09Z

lib/node_modules/@stdlib/stats/base/dists/wald/mean/lib/main.js

+* @example
+* var y = mean( 0.0, 1.0 );
+* // returns NaN
+*
+* @example
+* var y = mean( 1.0, 0.0 );
+* // returns NaN


First examples should always showcase valid inputs (this is something that should be addressed in various files).

Planeshifter · 2026-01-04T06:42:42Z

lib/node_modules/@stdlib/stats/base/dists/wald/mean/lib/main.js

+// MAIN //
+
+/**
+* Returns the expected value for a wald distribution with mean `mu` and standard deviation `sigma`.


Suggested change

* Returns the expected value for a wald distribution with mean `mu` and standard deviation `sigma`.

* Returns the expected value for a Wald distribution with mean `mu` and standard deviation `sigma`.

Planeshifter · 2026-01-04T06:44:13Z

lib/node_modules/@stdlib/stats/base/dists/wald/mean/lib/native.js

+// MAIN //
+
+/**
+* Evaluates the expected value for a Wald distribution with mean `mu` and standard deviation `sigma`.


Suggested change

* Evaluates the expected value for a Wald distribution with mean `mu` and standard deviation `sigma`.

* Returns the expected value for a Wald distribution with mean `mu` and standard deviation `sigma`.

Planeshifter

As in #9324, the Wald distribution has a second shape parameter lambda and not standard deviation sigma, so this will have to be updated across this PR.

stdlib-bot · 2026-01-04T13:45:51Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/dists/wald/mean	$\color{green}184/184$ $\color{green}+0.00%$	$\color{green}10/10$ $\color{green}+0.00%$	$\color{green}2/2$ $\color{green}+0.00%$	$\color{green}184/184$ $\color{green}+0.00%$

The above coverage report was generated for the changes in this PR.

Planeshifter

Thanks for the edits!

The PR is currently missing README.md, benchmarks, and also contains extraneous changes to normal/mean that should be reverted.

lib/node_modules/@stdlib/stats/base/dists/wald/mean/docs/repl.txt

lib/node_modules/@stdlib/stats/base/dists/wald/mean/src/main.c

lib/node_modules/@stdlib/stats/base/dists/normal/mean/docs/types/index.d.ts

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Planeshifter · 2026-01-07T04:33:32Z

lib/node_modules/@stdlib/stats/base/dists/wald/mean/lib/index.js

+* y = mean( 4.0, 2.0 );
+* // returns 4.0
+*
+* var y = mean( 0.0, 1.0 );


Suggested change

* y = mean( 4.0, 2.0 );

* // returns 4.0

*

* var y = mean( 0.0, 1.0 );

* var y = mean( 4.0, 2.0 );

* // returns 4.0

*

* y = mean( 0.0, 1.0 );

Planeshifter · 2026-01-07T04:34:40Z

lib/node_modules/@stdlib/stats/base/dists/wald/mean/docs/repl.txt

+    > y = {{alias}}( 4.0, 2.0 )
+    4.0
+    > var y = {{alias}}( 0.0, 1.0 )
+    NaN
+    > var y = {{alias}}( 1.0, 0.0 )
+    NaN


Suggested change

> y = {{alias}}( 4.0, 2.0 )

4.0

> var y = {{alias}}( 0.0, 1.0 )

NaN

> var y = {{alias}}( 1.0, 0.0 )

NaN

> var y = {{alias}}( 4.0, 2.0 )

4.0

> y = {{alias}}( 0.0, 1.0 )

NaN

> y = {{alias}}( 1.0, 0.0 )

NaN

Planeshifter · 2026-01-07T04:36:52Z

lib/node_modules/@stdlib/stats/base/dists/wald/mean/README.md

+
+<section class="intro">
+
+The [expected value][mean] for a [wald][wald-distribution] random variable with mean `μ` and shape parameter `λ > 0` is


Since the distribution is named after a person, Abraham Wald, we should capitalize it here and elsewhere and use "Wald distribution".

Planeshifter · 2026-01-07T04:38:09Z

lib/node_modules/@stdlib/stats/base/dists/wald/mean/README.md

+
+The [expected value][mean] for a [wald][wald-distribution] random variable with mean `μ` and shape parameter `λ > 0` is
+
+<!-- <equation class="equation" label="eq:wald_expectation" align="center" raw="\mathbb{E}\left[ X \right] = \mu" alt="Expected value for a normal distribution."> -->


Incorrectly referring to normal distribution here and below.

Planeshifter · 2026-01-07T04:39:09Z

lib/node_modules/@stdlib/stats/base/dists/wald/mean/benchmark/benchmark.js

+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		mu = ( randu()*100.0 ) + EPS;


Let's update the benchmark files to use the random array functions like in the example code to move the random number generation out of the benchmarking loop.

Consult other stats packages for how this should look these days.

Planeshifter · 2026-01-07T04:40:55Z

lib/node_modules/@stdlib/stats/base/dists/wald/mean/examples/c/example.c

+#ifndef STDLIB_CONSTANT_FLOAT64_EPS
+#define STDLIB_CONSTANT_FLOAT64_EPS 2.22044604925031308e-16
+#endif


Not needed; let's just use the same example as in the README.md and use 0.1 instead of STDLIB_CONSTANT_FLOAT64_EPS for the minimum value. In general, the example block in the README.md should match what is in the example files.

Planeshifter

Left a bunch more comments.

lib/node_modules/@stdlib/stats/base/dists/wald/mean/docs/repl.txt

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Planeshifter

LGTM! Thanks for cleaning the PR up and getting it into a good shape!

stdlib-bot · 2026-01-07T19:42:40Z

PR Commit Message

feat: add Wald distribution mean package

PR-URL: https://github.com/stdlib-js/stdlib/pull/9502
Closes: https://github.com/stdlib-js/stdlib/issues/209

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Please review the above commit message and make any necessary adjustments.

mean package core implemented

498b3d9

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Jan 2, 2026

fix: correct indentation to use tabs instead of spaces

21c98e8

stdlib-bot added the Potential Duplicate There might be another pull request resolving the same issue. label Jan 3, 2026

Planeshifter self-requested a review January 4, 2026 06:40

Planeshifter reviewed Jan 4, 2026

View reviewed changes

Planeshifter requested changes Jan 4, 2026

View reviewed changes

requested changed implemented

e0830f7

manit2004 requested a review from Planeshifter January 4, 2026 12:43

tests added

6218210

manit2004 added 7 commits January 4, 2026 20:38

added examples

663a7de

defined EPS due to import error in CI

a0496a6

linting error fixed

a3ea8f0

linting error fixed

8b56e02

added docs

5bbc724

fixed copyright year

f976234

linting error fixed

8768066

Planeshifter requested changes Jan 5, 2026

View reviewed changes

Planeshifter reviewed Jan 5, 2026

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/wald/mean/docs/repl.txt Outdated Show resolved Hide resolved

Planeshifter reviewed Jan 5, 2026

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/wald/mean/src/main.c Outdated Show resolved Hide resolved

manit2004 added 3 commits January 5, 2026 12:25

suggestions implemented

5a5139c

benchmark and readme added

e54875d

copyright year fixed

7dfb31a

manit2004 requested a review from Planeshifter January 5, 2026 17:52

manit2004 mentioned this pull request Jan 5, 2026

Office Hours (2026-01-06) stdlib-js/meetings#70

Closed

Planeshifter reviewed Jan 7, 2026

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/normal/mean/docs/types/index.d.ts Outdated Show resolved Hide resolved

chore: revert copyright year changes

1a9d7b2

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Planeshifter reviewed Jan 7, 2026

View reviewed changes

Planeshifter requested changes Jan 7, 2026

View reviewed changes

Planeshifter added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. Potential Duplicate There might be another pull request resolving the same issue. labels Jan 7, 2026

manit2004 added 5 commits January 7, 2026 12:39

comments resolved

d78d7a5

linting error fixed

f4dee69

linting error fixed

e2af1d3

linting error fixed

042fd0e

fix: correct indentation on line 34

bfd0049

manit2004 requested a review from Planeshifter January 7, 2026 07:54

stdlib-bot added the Needs Review A pull request which needs code review. label Jan 7, 2026

Planeshifter reviewed Jan 7, 2026

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/wald/mean/docs/repl.txt Outdated Show resolved Hide resolved

Planeshifter added 3 commits January 7, 2026 13:37

chore: clean-up sections

bc5f5c3

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

chore: revert changes

c3abeb3

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

docs: update description

cf2bcb0

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Planeshifter approved these changes Jan 7, 2026

View reviewed changes

Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Jan 7, 2026

stdlib-bot removed Needs Review A pull request which needs code review. Needs Changes Pull request which needs changes before being merged. labels Jan 7, 2026

Planeshifter merged commit 92d23f5 into stdlib-js:develop Jan 7, 2026
36 checks passed

stdlib-bot removed the Ready To Merge A pull request which is ready to be merged. label Jan 7, 2026

manit2004 deleted the feat/wald-distribution-mean-209 branch January 8, 2026 15:28

	* Returns the expected value for a wald distribution with mean `mu` and standard deviation `sigma`.
	* Returns the expected value for a Wald distribution with mean `mu` and standard deviation `sigma`.

	* Evaluates the expected value for a Wald distribution with mean `mu` and standard deviation `sigma`.
	* Returns the expected value for a Wald distribution with mean `mu` and standard deviation `sigma`.


		<section class="intro">

		The [expected value][mean] for a [wald][wald-distribution] random variable with mean `μ` and shape parameter `λ > 0` is


		The [expected value][mean] for a [wald][wald-distribution] random variable with mean `μ` and shape parameter `λ > 0` is

		<!-- <equation class="equation" label="eq:wald_expectation" align="center" raw="\mathbb{E}\left[ X \right] = \mu" alt="Expected value for a normal distribution."> -->

Uh oh!

Comments

Conversation

manit2004 commented Jan 2, 2026 • edited by Planeshifter Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Questions

Other

Checklist

AI Assistance

Disclosure

Uh oh!

Planeshifter Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

stdlib-bot commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

stdlib-bot commented Jan 7, 2026

PR Commit Message

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

manit2004 commented Jan 2, 2026 •

edited by Planeshifter

Loading

Planeshifter Jan 4, 2026 •

edited

Loading

stdlib-bot commented Jan 4, 2026 •

edited

Loading