feat: add `math/base/special/bernoullif` #3037

gururaj1512 · 2024-10-26T18:59:20Z

Progresses #649

Description

What is the purpose of this pull request?

adds math/base/special/bernoullif, which would be the single-precision equivalent for math/base/special/bernoullif.

float stdlib_base_bernoullif( const int32_t n )

Related Issues

Does this pull request have any related issues?

This pull request:

Progresses: [RFC]: Add C implementations to base special math functions (tracking issue) #649

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

lib/node_modules/@stdlib/math/base/special/bernoullif/lib/main.js

kgryte · 2024-10-26T22:46:05Z

lib/node_modules/@stdlib/math/base/special/bernoullif/lib/bernoullif.json

@@ -0,0 +1,34 @@
+[
+  1.00000000000000000000000000000000000000000,


These values all have very high precision. Is there a reason for that?

No, I have used similar values as of math/base/special/bernoulli. Should I make it less precise?

No, I have used similar values as of math/base/special/bernoulli. Should I make it less precise?

Yes, @gururaj1512.

You'll have to keep these values in appropriate precision. You can use https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/to-float32 for the conversion.

lib/node_modules/@stdlib/math/base/special/bernoullif/src/main.c

lib/node_modules/@stdlib/math/base/special/bernoullif/manifest.json

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com>

lib/node_modules/@stdlib/math/base/special/bernoullif/manifest.json

Planeshifter · 2024-11-11T15:13:50Z

@gunjjoshi This is not a problem exclusively with this PR, since it also applies to math/base/special/bernoulli, which you added in #1860, but I noticed that the implementation returns zero for all odd numbers. However, Wikipedia says that this is incorrect for input value 1: https://en.wikipedia.org/wiki/Bernoulli_number
Could you please take a look and confirm whether we need to handle this case separately?

gunjjoshi · 2024-11-11T16:52:25Z

@Planeshifter Thanks for catching this. After digging for some time, I found that there is a mix of opinions on whether B(1) = +1/2 or B(1) = -1/2. For instance, here is a discussion from sympy: sympy/sympy#23866.
While it is incorrect to use B(1) = 0, the choice that must be made is between +1/2 or -1/2.
sympy now uses +1/2 (it used -1/2 earlier). There's a discussion at sagemath too: sagemath/sage#34521.

Overall, I think, it would be better if we too, use B(1) = +1/2. I'll make this change in math/base/special/bernoulli, if this is fine.

gunjjoshi · 2024-11-11T16:55:04Z

But yes, NIST prescribes the convention to use B(1) = -1/2: https://en.wikipedia.org/wiki/Bernoulli_number#Notation
What should we follow, in this case?

kgryte · 2024-11-13T01:47:22Z

Let's go ahead and use 1/2. This will match SymPy and is also used as a convention in R. As commented elsewhere, how much the choice actually matters in practice is subject to some debate. In this case, I'm more inclined to go with Knuth.

kgryte · 2024-11-13T23:48:17Z

Similar to the changes proposed in #3108, we'll want to make similar changes here.

…lli` BREAKING CHANGE: update return value for `n=1` In order to migrate and preserve prior behavior, users should special case `n=1` and return `0`. The change in this commit aligns return values with SymPy and R; although, other libraries and envs choose to return `-0.5`. PR-URL: #3108 Ref: #3037 (comment) Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com> Signed-off-by: Athan Reines <kgryte@gmail.com>

gururaj1512 · 2024-11-14T18:58:15Z

Refactored it as suggested.

kgryte · 2024-11-18T04:11:38Z

/stdlib merge

lib/node_modules/@stdlib/math/base/special/bernoullif/README.md

lib/node_modules/@stdlib/math/base/special/bernoullif/src/main.c

anandkaranubc · 2025-05-12T05:23:59Z

lib/node_modules/@stdlib/math/base/special/bernoullif/lib/main.js

+
+// MODULES //
+
+var isNonNegativeInteger = require( '@stdlib/math/base/assert/is-nonnegative-integer' );


Suggested change

var isNonNegativeInteger = require( '@stdlib/math/base/assert/is-nonnegative-integer' );

var isNonNegativeIntegerf = require( '@stdlib/math/base/assert/is-nonnegative-integerf' );

anandkaranubc · 2025-05-12T05:25:32Z

lib/node_modules/@stdlib/math/base/special/bernoullif/lib/main.js

+		return 0.0;
+	}
+	if ( n > MAX_BERNOULLI ) {
+		return ( ( n / 2 ) & 1 ) ? PINF : NINF;


Suggested change

return ( ( n / 2 ) & 1 ) ? PINF : NINF;

return ( (n/2)&1 ) ? PINF : NINF;

anandkaranubc · 2025-05-12T05:30:37Z

lib/node_modules/@stdlib/math/base/special/bernoullif/examples/index.js

+
+var bernoullif = require( './../lib' );
+
+var v;
+var i;
+
+for ( i = 0; i < 70; i++ ) {
+	v = bernoullif( i );
+	console.log( v );
+}


Suggested change

var bernoullif = require( './../lib' );

var v;

var i;

for ( i = 0; i < 70; i++ ) {

v = bernoullif( i );

console.log( v );

}

var logEachMap = require( '@stdlib/console/log-each-map' );

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

var bernoullif = require( './../lib' );

var x = discreteUniform( 100, 0, 70, {

'dtype': 'int32'

});

logEachMap( 'bernoullif(%d) = %0.4f', x, bernoullif );

anandkaranubc · 2025-05-12T05:31:54Z

lib/node_modules/@stdlib/math/base/special/bernoullif/examples/c/example.c

+
+	for ( i = 0; i < 70; i++ ) {
+		v = stdlib_base_bernoullif( i );
+		printf( "bernoulli(%d) = %f\n", i, v );


Suggested change

printf( "bernoulli(%d) = %f\n", i, v );

printf( "bernoullif(%d) = %f\n", i, v );

anandkaranubc · 2025-05-12T05:35:12Z

lib/node_modules/@stdlib/math/base/special/bernoullif/test/test.js

+
+	for ( i = -1; i > -50; i-- ) {
+		v = bernoullif( i );
+		t.strictEqual( isnanf( v ), true, 'returns expected value when provided ' + i );


Suggested change

t.strictEqual( isnanf( v ), true, 'returns expected value when provided ' + i );

t.strictEqual( isnanf( v ), true, 'returns expected value' );

Applies here and below...

anandkaranubc · 2025-05-12T05:36:29Z

lib/node_modules/@stdlib/math/base/special/bernoullif/test/test.js

+tape( 'the function returns the nth Bernoulli number for odd numbers', function test( t ) {
+	var v;
+	var i;
+	for ( i = 3; i < 500; i += 2 ) {


Suggested change

for ( i = 3; i < 500; i += 2 ) {

for ( i = 3; i < 100; i += 2 ) {

A smaller range is ok for bernoullif

anandkaranubc · 2025-05-12T05:38:17Z

lib/node_modules/@stdlib/math/base/special/bernoullif/test/test.js

+tape( 'the function returns +/- infinity for large integers', function test( t ) {
+	var v;
+	var i;
+	for ( i = 66; i < 500; i += 2 ) {


Suggested change

for ( i = 66; i < 500; i += 2 ) {

for ( i = 66; i < 150; i += 2 ) {

Same comment.

anandkaranubc · 2025-05-12T05:44:41Z

lib/node_modules/@stdlib/math/base/special/bernoullif/benchmark/benchmark.js

+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var randu = require( '@stdlib/random/array/discrete-uniform' );


Suggested change

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

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

For being consistent across other packages.

anandkaranubc · 2025-05-12T05:45:15Z

lib/node_modules/@stdlib/math/base/special/bernoullif/benchmark/benchmark.js

+	var y;
+	var i;
+
+	x = randu( 100, 0, 500 );


Suggested change

x = randu( 100, 0, 500 );

x = discreteUniform( 100, 0, 100 );

100 is fine here for the max value.

anandkaranubc · 2025-05-12T05:46:58Z

lib/node_modules/@stdlib/math/base/special/bernoullif/benchmark/c/native/benchmark.c

+	int i;
+
+	for ( i = 0; i < 100; i++ ) {
+		x[ i ] = ( 500.0 * rand_float() );


Suggested change

x[ i ] = ( 500.0 * rand_float() );

x[ i ] = ( 500.0f * rand_float() );

anandkaranubc · 2025-05-12T05:47:36Z

lib/node_modules/@stdlib/math/base/special/bernoullif/benchmark/c/native/benchmark.c

+
+	t = tic();
+	for ( i = 0; i < ITERATIONS; i++ ) {
+		y = stdlib_base_bernoullif( (int)( x[ i % 100 ] ) );


Suggested change

y = stdlib_base_bernoullif( (int)( x[ i % 100 ] ) );

y = stdlib_base_bernoullif( (int32_t)( x[ i%100 ] ) );

anandkaranubc · 2025-05-12T05:49:31Z

lib/node_modules/@stdlib/math/base/special/bernoullif/manifest.json

+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math/base/assert/is-odd",


@stdlib/math/base/assert/is-odd is not needed here now.

anandkaranubc · 2025-05-12T05:51:10Z

lib/node_modules/@stdlib/math/base/special/bernoullif/package.json

+    "stdmath",
+    "mathematics",
+    "math",
+    "special functions",


Suggested change

"special functions",

Keywords with more than one word are not used.

anandkaranubc · 2025-05-12T05:54:07Z

lib/node_modules/@stdlib/math/base/special/bernoullif/README.md

+var bernoullif = require( '@stdlib/math/base/special/bernoullif' );
+
+var v;
+var i;
+
+for ( i = 0; i < 70; i++ ) {
+    v = bernoullif( i );
+    console.log( v );
+}


Suggested change

var bernoullif = require( '@stdlib/math/base/special/bernoullif' );

var v;

var i;

for ( i = 0; i < 70; i++ ) {

v = bernoullif( i );

console.log( v );

}

var logEachMap = require( '@stdlib/console/log-each-map' );

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

var bernoullif = require( './../lib' );

var x = discreteUniform( 100, 0, 70, {

'dtype': 'int32'

});

logEachMap( 'bernoullif(%d) = %0.4f', x, bernoullif );

anandkaranubc · 2025-05-12T05:54:49Z

lib/node_modules/@stdlib/math/base/special/bernoullif/README.md

+
+```c
+float out = stdlib_base_bernoullif( 0 );
+// returns 1.0


Suggested change

// returns 1.0

// returns 1.0f

anandkaranubc · 2025-05-12T05:54:54Z

lib/node_modules/@stdlib/math/base/special/bernoullif/README.md

+// returns 1.0
+
+out = stdlib_base_bernoullif( 1 );
+// returns 0.5


Suggested change

// returns 0.5

// returns 0.5f

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

lib/node_modules/@stdlib/math/base/special/bernoullif/README.md

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

feat:add math/base/special/bernoullif

b796c03

stdlib-bot added the Math Issue or pull request specific to math functionality. label Oct 26, 2024

kgryte reviewed Oct 26, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/bernoullif/lib/main.js Outdated Show resolved Hide resolved

kgryte reviewed Oct 26, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/bernoullif/src/main.c Outdated Show resolved Hide resolved

kgryte reviewed Oct 26, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/bernoullif/manifest.json Outdated Show resolved Hide resolved

kgryte added Feature Issue or pull request for adding a new feature. Needs Changes Pull request which needs changes before being merged. labels Oct 26, 2024

gururaj1512 and others added 2 commits October 27, 2024 20:32

Update lib/node_modules/@stdlib/math/base/special/bernoullif/src/main.c

c54b6bc

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com>

fix: manifest.json file dependencies

5489bb6

kgryte reviewed Oct 27, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/bernoullif/manifest.json Outdated Show resolved Hide resolved

gururaj1512 added 4 commits October 28, 2024 12:53

fix: apply review changes

1824084

fix: changes

d6e8e6b

fix: check errors

7c37cc0

fix: bernoullif manifest.json file

aca6ec3

gunjjoshi mentioned this pull request Nov 13, 2024

feat!: update the return value for n=1 in math/base/special/bernoulli #3108

Merged

1 task

gururaj1512 added 2 commits November 15, 2024 00:12

refactor: update return value for n=1

2dcd971

fix: lint error

46c3d20

kgryte added the Needs Review A pull request which needs code review. label Nov 18, 2024

kgryte requested a review from gunjjoshi November 18, 2024 04:12

Merge remote-tracking branch 'upstream/develop' into bernoullif

e5b1927

gunjjoshi requested changes Nov 19, 2024

View reviewed changes

anandkaranubc reviewed May 12, 2025

View reviewed changes

anandkaranubc previously approved these changes May 12, 2025

View reviewed changes

Planeshifter previously approved these changes May 12, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/bernoullif/README.md Outdated Show resolved Hide resolved

lib/node_modules/@stdlib/math/base/special/bernoullif/README.md Outdated Show resolved Hide resolved

Planeshifter added Ready To Merge A pull request which is ready to be merged. and removed Needs Review A pull request which needs code review. Needs Changes Pull request which needs changes before being merged. labels May 12, 2025

docs: update description

dc31e82

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

Planeshifter dismissed stale reviews from anandkaranubc and themself via dc31e82 May 12, 2025 10:29

Planeshifter approved these changes May 12, 2025

View reviewed changes

Planeshifter added Ready To Merge A pull request which is ready to be merged. and removed Ready To Merge A pull request which is ready to be merged. labels May 12, 2025

Planeshifter merged commit 7d671b1 into stdlib-js:develop May 12, 2025
28 of 29 checks passed

gururaj1512 deleted the bernoullif branch May 12, 2025 10:42

		@@ -0,0 +1,34 @@
		[
		1.00000000000000000000000000000000000000000,


		// MODULES //

		var isNonNegativeInteger = require( '@stdlib/math/base/assert/is-nonnegative-integer' );

	var isNonNegativeInteger = require( '@stdlib/math/base/assert/is-nonnegative-integer' );
	var isNonNegativeIntegerf = require( '@stdlib/math/base/assert/is-nonnegative-integerf' );

	return ( ( n / 2 ) & 1 ) ? PINF : NINF;
	return ( (n/2)&1 ) ? PINF : NINF;

	printf( "bernoulli(%d) = %f\n", i, v );
	printf( "bernoullif(%d) = %f\n", i, v );

	t.strictEqual( isnanf( v ), true, 'returns expected value when provided ' + i );
	t.strictEqual( isnanf( v ), true, 'returns expected value' );

	for ( i = 3; i < 500; i += 2 ) {
	for ( i = 3; i < 100; i += 2 ) {

	for ( i = 66; i < 500; i += 2 ) {
	for ( i = 66; i < 150; i += 2 ) {

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

	x = randu( 100, 0, 500 );
	x = discreteUniform( 100, 0, 100 );

	x[ i ] = ( 500.0 * rand_float() );
	x[ i ] = ( 500.0f * rand_float() );

	y = stdlib_base_bernoullif( (int)( x[ i % 100 ] ) );
	y = stdlib_base_bernoullif( (int32_t)( x[ i%100 ] ) );

Uh oh!

feat: add math/base/special/bernoullif #3037

feat: add math/base/special/bernoullif #3037

Uh oh!

Conversation

gururaj1512 commented Oct 26, 2024 • edited by kgryte Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Questions

Other

Checklist

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gunjjoshi Apr 3, 2025 • 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!

Uh oh!

Uh oh!

Uh oh!

Planeshifter commented Nov 11, 2024

Uh oh!

gunjjoshi commented Nov 11, 2024

Uh oh!

gunjjoshi commented Nov 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kgryte commented Nov 13, 2024

Uh oh!

kgryte commented Nov 13, 2024

Uh oh!

gururaj1512 commented Nov 14, 2024

Uh oh!

kgryte commented Nov 18, 2024

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat: add `math/base/special/bernoullif` #3037

feat: add `math/base/special/bernoullif` #3037

gururaj1512 commented Oct 26, 2024 •

edited by kgryte

Loading

gunjjoshi Apr 3, 2025 •

edited

Loading

gunjjoshi commented Nov 11, 2024 •

edited

Loading