feat: add C implementation for `stats/base/dists/planck/logpmf` #5001

yuvi-mittal · 2025-01-31T20:39:26Z

Resolves #5000

Description

What is the purpose of this pull request?

This pull request:

Add C implementation for @stdlib/stats/base/dists/planck/logpmf

Related Issues

Does this pull request have any related issues?

This pull request:

resolves [RFC]: Add C implementation for @stdlib/stats/base/dists/planck/logpmf #5000

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_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 · 2025-01-31T20:41:27Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/dists/planck/logpmf	$\color{green}282/282$ $\color{green}+100.00\%$	$\color{green}21/21$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}282/282$ $\color{green}+100.00\%$

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

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md

Neerajpathak07 · 2025-02-01T08:31:46Z

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/manifest.json

+          "@stdlib/math/base/assert/is-nan",
+          "@stdlib/math/base/assert/is-nonnegative-integer",
+          "@stdlib/math/base/special/expm1",
+          "@stdlib/constants/float64/pi",


pi should be removed as it is not used in the main.c file right.

same goes for the other builds as well!

Neerajpathak07 · 2025-02-01T08:34:05Z

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/benchmark.js

@@ -21,8 +21,10 @@
 // MODULES //

 var bench = require( '@stdlib/bench' );
+var Float64Array = require( '@stdlib/array/float64' );
 var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );


Suggested change

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );

should be removed as it is not used in the file anywhere

same comment for the native file as well

actually it is been used in pkg+':factory'(benchmark 2) , as it uses random/array/discrete-uniform , so i made two variable one for array and one for base .

Yeah, but the the ::factory code block should have the discreteUniformbase number generation logic for len = 100 and var x having a Float64array val just as you did it for the above code block!!

...dules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c

Neerajpathak07 · 2025-02-01T08:41:24Z

@yuvi-mittal
Please change the PR title to:-
feat: add C implementation for stats/base/dists/planck/logpmf

--- 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 ---

yuvi-mittal · 2025-02-22T13:38:36Z

@Planeshifter , this PR is ready to be merged too i believe !

Planeshifter · 2025-03-05T03:09:18Z

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/native.js

+* @private
+* @param {number} x - input value
+* @param {number} lambda - shape parameter
+* @returns {number} evaluated log(PMF)


Suggested change

* @returns {number} evaluated log(PMF)

* @returns {number} evaluated logPMF

Planeshifter · 2025-03-05T03:11:06Z

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c

+*
+* @param x       input value
+* @param lambda  shape parameter
+* @return        evaluated log PMF


Suggested change

* @return evaluated log PMF

* @return evaluated logPMF

Planeshifter · 2025-03-05T03:11:51Z

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md

@@ -101,7 +101,7 @@ y = mylogpmf( 1.0 );

 ## Notes

-   In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow.
+In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow.


Suggested change

In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow.

- In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow.

Planeshifter · 2025-03-05T03:12:03Z

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md

+#include <stdio.h>
+static int random_discrete_uniform( const int min, const int max ) {
+    return min + ( rand() % ( max - min + 1 ) );
+}


Suggested change

#include <stdio.h>

static int random_discrete_uniform( const int min, const int max ) {

return min + ( rand() % ( max - min + 1 ) );

}

#include <stdio.h>

static int random_discrete_uniform( const int min, const int max ) {

return min + ( rand() % ( max - min + 1 ) );

}

Planeshifter · 2025-03-05T03:12:20Z

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/benchmark.native.js

+		x[i] = discreteUniformBase(0, 40);
+		lambda[i] = uniformBase(1.0, 10.0);


Suggested change

x[i] = discreteUniformBase(0, 40);

lambda[i] = uniformBase(1.0, 10.0);

x[i] = discreteUniformBase( 0, 40 );

lambda[i] = uniformBase( 1.0, 10.0 );

Planeshifter · 2025-03-05T03:12:49Z

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/benchmark.c

+* @param total     total number of tests
+* @param passing   total number of passing tests
+*/
+


Shouldn't have empty lines between documentation blocks and functions in this file.

Planeshifter · 2025-03-05T03:13:13Z

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/benchmark.c

+/**
+* Generates a random number on the interval [min,max).
+*
+* @param min    minimum value (inclusive)
+* @param max    maximum value (exclusive)
+* @return       random number
+*/
+
+static int random_discrete_uniform( int min, int max ) {
+	return min + rand() % ( max - min + 1 );
+}
+
+static double random_uniform( double min, double max ) {
+	double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+	return min + ( v * ( max - min ) );
+}


Need to document both functions here.

Planeshifter

Thanks for your efforts, @yuvi-mittal! This should be fairly close, but there are a bunch of errors that need to be resolved before it can be merged.

yuvi-mittal · 2025-03-06T05:13:01Z

I will check them by EOD, but I have one question—why aren't these linting errors showing on my local system? There are no lint errors locally.

Planeshifter · 2025-03-07T03:21:56Z

@yuvi-mittal Thanks for taking care of these! All checks are green on CI too, so there is nothing wrong with your local setup. Simple explanation is that we have various conventions that are currently not yet enforced via automated linting because we didn't have the bandwidth to do so or which would be infeasible to automatically check.

yuvi-mittal · 2025-04-03T13:57:56Z

@kgryte , The PR looks good to me , can you please review if there is any issue !

Planeshifter · 2025-04-05T00:13:17Z

@yuvi-mittal The comments I left still need to be addressed.

yuvi-mittal · 2025-04-05T09:50:54Z

Yess , Sorry . I will look into that !

Neerajpathak07 reviewed Feb 1, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md Outdated Show resolved Hide resolved

Neerajpathak07 reviewed Feb 1, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md Outdated Show resolved Hide resolved

Neerajpathak07 reviewed Feb 1, 2025

View reviewed changes

...dules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h Outdated Show resolved Hide resolved

Neerajpathak07 reviewed Feb 1, 2025

View reviewed changes

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

yuvi-mittal changed the title ~~feat: Add C implementation for @stdlib/stats/base/dists/planck/logpmf~~ feat: add C implementation for stats/base/dists/planck/logpmf Feb 2, 2025

stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Feb 2, 2025

Planeshifter added the bot: Update Copyright Years Pull request needing the copyright years of its files updated. label Feb 15, 2025

stdlib-bot added bot: In Progress Pull request is currently awaiting automation. and removed bot: Update Copyright Years Pull request needing the copyright years of its files updated. labels Feb 15, 2025

chore: update copyright years

6556404

Planeshifter added bot: Lint Autofix Pull request needing applicable lint errors to be automatically fixed. and removed bot: In Progress Pull request is currently awaiting automation. labels Feb 15, 2025

stdlib-bot added bot: In Progress Pull request is currently awaiting automation. and removed bot: Lint Autofix Pull request needing applicable lint errors to be automatically fixed. labels Feb 15, 2025

Planeshifter changed the title ~~feat: add C implementation for stats/base/dists/planck/logpmf~~ feat: add C implementation for stats/base/dists/planck/logpmf Feb 15, 2025

Planeshifter removed the bot: In Progress Pull request is currently awaiting automation. label Feb 15, 2025

Planeshifter reviewed Mar 5, 2025

View reviewed changes

Planeshifter requested changes Mar 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add C implementation for `stats/base/dists/planck/logpmf` #5001

feat: add C implementation for `stats/base/dists/planck/logpmf` #5001

yuvi-mittal commented Jan 31, 2025

stdlib-bot commented Jan 31, 2025 •

edited

Loading

Neerajpathak07 Feb 1, 2025

Neerajpathak07 Feb 1, 2025

Neerajpathak07 Feb 1, 2025

Neerajpathak07 Feb 1, 2025

yuvi-mittal Feb 2, 2025

Neerajpathak07 Feb 3, 2025 •

edited

Loading

Neerajpathak07 commented Feb 1, 2025

yuvi-mittal commented Feb 22, 2025

Planeshifter Mar 5, 2025

Planeshifter Mar 5, 2025

Planeshifter Mar 5, 2025

Planeshifter Mar 5, 2025

Planeshifter Mar 5, 2025

Planeshifter Mar 5, 2025

Planeshifter Mar 5, 2025

Planeshifter left a comment

yuvi-mittal commented Mar 6, 2025

Planeshifter commented Mar 7, 2025 •

edited

Loading

yuvi-mittal commented Apr 3, 2025

Planeshifter commented Apr 5, 2025

yuvi-mittal commented Apr 5, 2025

	* @returns {number} evaluated log(PMF)
	* @returns {number} evaluated logPMF

	In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow.
	- In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow.

		x[i] = discreteUniformBase(0, 40);
		lambda[i] = uniformBase(1.0, 10.0);

feat: add C implementation for stats/base/dists/planck/logpmf #5001

Are you sure you want to change the base?

feat: add C implementation for stats/base/dists/planck/logpmf #5001

Conversation

yuvi-mittal commented Jan 31, 2025

Description

Related Issues

Questions

Other

Checklist

stdlib-bot commented Jan 31, 2025 • edited Loading

Coverage Report

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

Neerajpathak07 Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Neerajpathak07 commented Feb 1, 2025

yuvi-mittal commented Feb 22, 2025

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

Planeshifter left a comment

Choose a reason for hiding this comment

yuvi-mittal commented Mar 6, 2025

Planeshifter commented Mar 7, 2025 • edited Loading

yuvi-mittal commented Apr 3, 2025

Planeshifter commented Apr 5, 2025

yuvi-mittal commented Apr 5, 2025

feat: add C implementation for `stats/base/dists/planck/logpmf` #5001

feat: add C implementation for `stats/base/dists/planck/logpmf` #5001

stdlib-bot commented Jan 31, 2025 •

edited

Loading

Neerajpathak07 Feb 3, 2025 •

edited

Loading

Planeshifter commented Mar 7, 2025 •

edited

Loading