docs: replace manual `for` loop in examples #6249

anandkaranubc · 2025-03-21T05:59:07Z

Resolves None

Description

What is the purpose of this pull request?

This pull request:

replaces manual for loop in examples for stats/base/dists/arcsine/* packages

Related Issues

Does this pull request have any related issues?

This pull request:

resolves none

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.

No.

Checklist

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

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

stdlib-bot · 2025-03-21T06:04:18Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/dists/arcsine/entropy	$\color{green}193/193$ $\color{green}+100.00\%$	$\color{green}9/9$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}193/193$ $\color{green}+100.00\%$
stats/base/dists/arcsine/kurtosis	$\color{green}186/186$ $\color{green}+100.00\%$	$\color{green}9/9$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}186/186$ $\color{green}+100.00\%$
stats/base/dists/arcsine/logcdf	$\color{green}237/237$ $\color{green}+100.00\%$	$\color{green}25/25$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}237/237$ $\color{green}+100.00\%$
stats/base/dists/arcsine/logpdf	$\color{green}293/293$ $\color{green}+100.00\%$	$\color{green}25/25$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}293/293$ $\color{green}+100.00\%$
stats/base/dists/arcsine/mean	$\color{green}179/179$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}179/179$ $\color{green}+100.00\%$
stats/base/dists/arcsine/median	$\color{green}112/112$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}112/112$ $\color{green}+100.00\%$
stats/base/dists/arcsine/mode	$\color{green}190/190$ $\color{green}+100.00\%$	$\color{green}9/9$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}190/190$ $\color{green}+100.00\%$
stats/base/dists/arcsine/pdf	$\color{green}291/291$ $\color{green}+100.00\%$	$\color{green}25/25$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}291/291$ $\color{green}+100.00\%$
stats/base/dists/arcsine/quantile	$\color{green}218/218$ $\color{green}+100.00\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}218/218$ $\color{green}+100.00\%$
stats/base/dists/arcsine/skewness	$\color{green}186/186$ $\color{green}+100.00\%$	$\color{green}9/9$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}186/186$ $\color{green}+100.00\%$
stats/base/dists/arcsine/stdev	$\color{green}186/186$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}186/186$ $\color{green}+100.00\%$
stats/base/dists/arcsine/variance	$\color{green}182/182$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}182/182$ $\color{green}+100.00\%$

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

Planeshifter

LGTM!

stdlib-bot · 2025-03-21T09:48:10Z

PR Commit Message

docs: replace manual `for` loop in examples

PR-URL: https://github.com/stdlib-js/stdlib/pull/6249

Reviewed-by: Philipp Burckhardt <[email protected]>

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

kgryte · 2025-03-21T09:51:57Z

lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/README.md

+var a = uniform( x.length, -20.0, 0.0, opts );
+var b = uniform( x.length, 0.0, 40.0, opts );
+
+logEachMap( 'x: %d, a: %d, b: %d, ln(F(x;a,b)): %d', x, a, b, logcdf );


@anandkaranubc These should be %0.4f. This applies to other packages, as well.

cc @Planeshifter logEachMap supports string/format string interpolation.

kgryte · 2025-03-21T09:52:36Z

lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/examples/index.js

-	y = logcdf( x, a, b );
-	console.log( 'x: %d, a: %d, b: %d, ln(F(x;a,b)): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), y.toFixed( 4 ) );
-}
+logEachMap( 'x: %d, a: %d, b: %d, ln(F(x;a,b)): %d', x, a, b, logcdf );


Same comment.

kgryte · 2025-03-21T09:52:46Z

lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/README.md

+var a = uniform( x.length, -20.0, 0.0, opts );
+var b = uniform( x.length, 0.0, 40.0, opts );
+
+logEachMap( 'x: %d, a: %d, b: %d, ln(f(x;a,b)): %d', x, a, b, logpdf );


Same comment.

kgryte · 2025-03-21T09:52:55Z

lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/examples/index.js

-	y = logpdf( x, a, b );
-	console.log( 'x: %d, a: %d, b: %d, ln(f(x;a,b)): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), y.toFixed( 4 ) );
-}
+logEachMap( 'x: %d, a: %d, b: %d, ln(f(x;a,b)): %d', x, a, b, logpdf );


Same comment.

kgryte · 2025-03-21T09:53:54Z

lib/node_modules/@stdlib/stats/base/dists/arcsine/pdf/README.md

+var a = uniform( x.length, -20.0, 0.0, opts );
+var b = uniform( x.length, 0.0, 40.0, opts );
+
+logEachMap( 'x: %d, a: %d, b: %d, f(x;a,b): %d', x, a, b, pdf );


Same comment.

kgryte · 2025-03-21T09:54:04Z

lib/node_modules/@stdlib/stats/base/dists/arcsine/pdf/examples/index.js

-	y = pdf( x, a, b );
-	console.log( 'x: %d, a: %d, b: %d, f(x;a,b): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), y.toFixed( 4 ) );
-}
+logEachMap( 'x: %d, a: %d, b: %d, f(x;a,b): %d', x, a, b, pdf );


Same comment.

On it! Sorry about that. 😢

kgryte · 2025-03-21T09:55:52Z

@anandkaranubc Would you mind submitting a follow-up PR addressing the comments above?

PR-URL: #6259 Ref: 6ff59dd Ref: #6249 Reviewed-by: Athan Reines <[email protected]>

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Mar 21, 2025

Planeshifter approved these changes Mar 21, 2025

View reviewed changes

Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Mar 21, 2025

stdlib-bot removed the Needs Review A pull request which needs code review. label Mar 21, 2025

Planeshifter merged commit 6ff59dd into stdlib-js:develop Mar 21, 2025
63 checks passed

anandkaranubc deleted the examples/arcsine branch March 21, 2025 09:49

kgryte reviewed Mar 21, 2025

View reviewed changes

kgryte mentioned this pull request Mar 21, 2025

docs: fix use of %d #6259

Merged

1 task

kgryte pushed a commit that referenced this pull request Mar 21, 2025

docs: fix interpolation of decimal values

e3edfba

PR-URL: #6259 Ref: 6ff59dd Ref: #6249 Reviewed-by: Athan Reines <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: replace manual `for` loop in examples #6249

docs: replace manual `for` loop in examples #6249

anandkaranubc commented Mar 21, 2025

stdlib-bot commented Mar 21, 2025

Planeshifter left a comment

stdlib-bot commented Mar 21, 2025 •

edited by Planeshifter

Loading

kgryte Mar 21, 2025

kgryte Mar 21, 2025

kgryte Mar 21, 2025

kgryte Mar 21, 2025

kgryte Mar 21, 2025

kgryte Mar 21, 2025

kgryte Mar 21, 2025

anandkaranubc Mar 21, 2025

kgryte commented Mar 21, 2025

docs: replace manual for loop in examples #6249

docs: replace manual for loop in examples #6249

Conversation

anandkaranubc commented Mar 21, 2025

Description

Related Issues

Questions

Other

Checklist

stdlib-bot commented Mar 21, 2025

Coverage Report

Planeshifter left a comment

Choose a reason for hiding this comment

stdlib-bot commented Mar 21, 2025 • edited by Planeshifter Loading

PR Commit Message

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kgryte commented Mar 21, 2025

docs: replace manual `for` loop in examples #6249

docs: replace manual `for` loop in examples #6249

stdlib-bot commented Mar 21, 2025 •

edited by Planeshifter

Loading