feat: add c implementation for `@stdlib/stats/base/dists/logistic/entropy` #4385

DhruvArvindSingh · 2024-12-30T10:33:52Z

Resolves #3734 .

Description

What is the purpose of this pull request?

This pull request:

Adds C implementation for @stdlib/stats/base/dists/logistic/entropy

Related Issues

Does this pull request have any related issues?

This pull request:

resolves [RFC]: Add C implementation for @stdlib/stats/base/dists/logistic/entropy #3734
resolves [RFC]: Add C implementations to logistic distribution functions (tracking issue) #3692

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: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---

stdlib-bot · 2024-12-30T10:36:08Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/dists/logistic/entropy	$\color{green}175/175$ $\color{green}+100.00\%$	$\color{green}9/9$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}175/175$ $\color{green}+100.00\%$

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

Planeshifter · 2025-03-16T20:24:05Z

⚠️ Tracking Issue Closure Warning ⚠️

I noticed your PR description contains closing keywords ("Resolves", "Closes", or "Fixes") referencing a "Tracking Issue".

Why this matters:
Tracking issues should typically remain open until all related sub-issues are completed. GitHub automatically closes issues with such closing keywords when the PR is merged.

Required action:
Use "Progresses:" or "Ref:" instead to reference the tracking issue without automatically closing it.

Thank you for your contribution to the project!

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

Planeshifter · 2025-03-25T08:45:58Z

lib/node_modules/@stdlib/stats/base/dists/logistic/entropy/README.md

+double stdlib_base_dists_logistic_entropy( const double mu, const double s );
+```
+
+</section>


Missing newlines here and below between section tags, headings, and the like.

Planeshifter · 2025-03-25T08:46:27Z

lib/node_modules/@stdlib/stats/base/dists/logistic/entropy/benchmark/benchmark.native.js

+	mu = new Float64Array( len );
+	s = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		mu[ i ] = ( randu() * 100.0 ) - 50.0;


It would be good to update this to draw the random numbers directly from the desired uniform distribution.

Planeshifter · 2025-03-25T08:47:51Z

lib/node_modules/@stdlib/stats/base/dists/logistic/entropy/src/main.c

+/**
+* Returns the differential entropy for a logistic distribution with location `mu` and scale `s`.
+*
+* @param {number} mu - location parameter


JSDoc here should be replaced with C Doxygen-style comments.

Planeshifter · 2025-03-25T08:48:25Z

lib/node_modules/@stdlib/stats/base/dists/logistic/entropy/lib/native.js

+*
+* @param {number} mu - location parameter


Suggested change

*

* @param {number} mu - location parameter

*

* @private

* @param {number} mu - location parameter

Planeshifter · 2025-03-25T08:49:06Z

lib/node_modules/@stdlib/stats/base/dists/logistic/entropy/benchmark/c/benchmark.c

+		mu[ i ] = random_uniform( 0.0, 100.0 ) - 50.0;
+		s[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;


Suggested change

mu[ i ] = random_uniform( 0.0, 100.0 ) - 50.0;

s[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;

mu[ i ] = random_uniform( -50.0, 50.0 );

s[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );

Planeshifter · 2025-03-25T08:50:10Z

lib/node_modules/@stdlib/stats/base/dists/logistic/entropy/README.md

+        mu = random_uniform( 0.0, 10.0 ) - 5.0;
+        s = random_uniform( 0.0, 20.0 );
+        y = stdlib_base_dists_logistic_entropy( mu, s );
+        printf( "µ: %lf, s: %lf, Ent(X;µ,s): %lf\n", mu, s, y );


Suggested change

printf( "µ: %lf, s: %lf, Ent(X;µ,s): %lf\n", mu, s, y );

printf( "µ: %lf, s: %lf, h(X;µ,s): %lf\n", mu, s, y );

Planeshifter · 2025-03-25T08:50:41Z

lib/node_modules/@stdlib/stats/base/dists/logistic/entropy/examples/c/example.c

+		mu = random_uniform( 0.0, 10.0 ) - 5.0;
+		s = random_uniform( 0.0, 20.0 );
+		y = stdlib_base_dists_logistic_entropy( mu, s );
+		printf( "µ: %lf, s: %lf, Ent(X;µ,s): %lf\n", mu, s, y );


Suggested change

printf( "µ: %lf, s: %lf, Ent(X;µ,s): %lf\n", mu, s, y );

printf( "µ: %lf, s: %lf, h(X;µ,s): %lf\n", mu, s, y );

Planeshifter

Thanks for the PR!

Flagged a bunch of issues that will have to be addressed before it can move forward. Similar changes are likely need in other PRs of yours such as #4391, too.

Planeshifter · 2025-03-25T08:52:07Z

/stdlib update-copyright-years

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Dec 30, 2024

Planeshifter added the Potential Duplicate There might be another pull request resolving the same issue. label Mar 15, 2025

Merge branch 'develop' into develop_#3734

290a19e

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

stdlib-bot added the Good First PR A pull request resolving a Good First Issue. label Mar 25, 2025

Planeshifter reviewed Mar 25, 2025

View reviewed changes

Planeshifter requested changes Mar 25, 2025

View reviewed changes

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Mar 25, 2025

chore: update copyright years

a59b43a

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Mar 25, 2025

Planeshifter added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Mar 25, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add c implementation for `@stdlib/stats/base/dists/logistic/entropy` #4385

feat: add c implementation for `@stdlib/stats/base/dists/logistic/entropy` #4385

DhruvArvindSingh commented Dec 30, 2024

stdlib-bot commented Dec 30, 2024 •

edited

Loading

Planeshifter commented Mar 16, 2025

Planeshifter Mar 25, 2025

Planeshifter Mar 25, 2025

Planeshifter Mar 25, 2025

Planeshifter Mar 25, 2025

Planeshifter Mar 25, 2025

Planeshifter Mar 25, 2025

Planeshifter Mar 25, 2025

Planeshifter left a comment

Planeshifter commented Mar 25, 2025

		mu[ i ] = random_uniform( 0.0, 100.0 ) - 50.0;
		s[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;

	printf( "µ: %lf, s: %lf, Ent(X;µ,s): %lf\n", mu, s, y );
	printf( "µ: %lf, s: %lf, h(X;µ,s): %lf\n", mu, s, y );

feat: add c implementation for @stdlib/stats/base/dists/logistic/entropy #4385

Are you sure you want to change the base?

feat: add c implementation for @stdlib/stats/base/dists/logistic/entropy #4385

Conversation

DhruvArvindSingh commented Dec 30, 2024

Description

Related Issues

Questions

Other

Checklist

stdlib-bot commented Dec 30, 2024 • edited Loading

Coverage Report

Planeshifter commented Mar 16, 2025

Planeshifter Mar 25, 2025

Choose a reason for hiding this comment

Planeshifter Mar 25, 2025

Choose a reason for hiding this comment

Planeshifter Mar 25, 2025

Choose a reason for hiding this comment

Planeshifter Mar 25, 2025

Choose a reason for hiding this comment

Planeshifter Mar 25, 2025

Choose a reason for hiding this comment

Planeshifter Mar 25, 2025

Choose a reason for hiding this comment

Planeshifter Mar 25, 2025

Choose a reason for hiding this comment

Planeshifter left a comment

Choose a reason for hiding this comment

Planeshifter commented Mar 25, 2025

feat: add c implementation for `@stdlib/stats/base/dists/logistic/entropy` #4385

feat: add c implementation for `@stdlib/stats/base/dists/logistic/entropy` #4385

stdlib-bot commented Dec 30, 2024 •

edited

Loading