feat: add `math/base/special/logitf` #3367

vivekmaurya001 · 2024-12-07T19:20:36Z

Progresses #649

Description

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

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

…o logitf

stdlib-bot · 2024-12-07T19:23:14Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/logitf	$\color{green}192/192$ $\color{green}+100.00\%$	$\color{green}13/13$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}192/192$ $\color{green}+100.00\%$

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

Planeshifter · 2024-12-07T19:31:26Z

/stdlib update-copyright-years

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

--- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: passed - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed ---

vivekmaurya001 · 2025-01-18T14:17:40Z

/stdlib update-copyright-years

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

…o logitf --- 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: passed - 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 ---

vivekmaurya001 · 2025-01-18T15:37:59Z

Hi @gunjjoshi , i have made the changes according to recent PR discussions , can u please check

vivekmaurya001 · 2025-03-07T06:38:19Z

@gunjjoshi , @Planeshifter , Is this PR need some changes or is it good to go ?

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

lib/node_modules/@stdlib/math/base/special/logitf/benchmark/c/benchmark.c

gunjjoshi · 2025-03-07T07:00:20Z

lib/node_modules/@stdlib/math/base/special/logitf/benchmark/c/benchmark.c

+double logit( double x ) {
+	if ( x != x ) {
+		return x;
+	}
+	if ( x < 0.0 || x > 1.0 ) {
+		return NAN;
+	}
+	if ( x == 0.0 ) {
+		return -HUGE_VAL;
+	}
+	if ( x == 1.0 ) {
+		return HUGE_VAL;
+	}
+	return log( x / ( 1.0 - x ) );
+}


@vivekmaurya001 This must be modified for single-precision.

Oh, sorry I didn't notice it

gunjjoshi · 2025-03-07T07:00:37Z

lib/node_modules/@stdlib/math/base/special/logitf/benchmark/c/benchmark.c

+	double y;
+	double t;
+	int i;
+
+	t = tic();
+	for ( i = 0; i < ITERATIONS; i++ ) {
+		y = logit( rand_double() );
+		if ( y != y ) {
+			printf( "should not return NaN\n" );
+			break;
+		}
+	}
+	elapsed = tic() - t;
+	if ( y != y ) {
+		printf( "should not return NaN\n" );
+	}
+	return elapsed;


Same goes for this too.

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

lib/node_modules/@stdlib/math/base/special/logitf/docs/repl.txt

lib/node_modules/@stdlib/math/base/special/logitf/docs/types/index.d.ts

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

gunjjoshi · 2025-03-07T07:21:01Z

lib/node_modules/@stdlib/math/base/special/logitf/test/fixtures/python/runner.py

+    x = np.linspace(0.25, 0.49, 500).astype(np.float32)
+    gen(x, "medium_below.json")
+
+    x = np.linspace(0.5, 0.75, 500).astype(np.float32)
+    gen(x, "medium_above.json")


@vivekmaurya001 Any specific reason to break down the range 0.25 - 0.75 into 2 parts? In logit, we are having a single range for this.

Yeah, actually what happened is medium test case almost all tests got passed except 3 with tolerance below 20 and for these 3 tests tolerance is taking about 250 value, so I thought to split it

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

Signed-off-by: Gunj Joshi <[email protected]>

…ndex.d.ts Signed-off-by: Gunj Joshi <[email protected]>

gunjjoshi · 2025-03-07T07:32:36Z

Tested this PR locally. The tolerance of 15.0 * EPS isn't required in test.native.js, for the C implementation. But, that is required in test.js, for the JS implementation. Any reason to keep the same tolerance level of 15.0 * EPS in test.native.js as well, even though it wasn't required, @vivekmaurya001?

vivekmaurya001 · 2025-03-08T13:32:47Z

@gunjjoshi, I didnt realised it I thought the test file was requiring so this file also required it at that time while testing native file got skipped, sorry about that

--- 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: na - 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: passed - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: missing_dependencies - 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 ---

vivekmaurya001 · 2025-03-08T14:35:15Z

/stdlib update-copyright-years

anandkaranubc · 2025-04-17T08:34:19Z

/stdlib merge

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

--- 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: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - 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: passed - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- 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: na - 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: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - 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: 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_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: na - 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 ---

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

--- 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: na - task: lint_package_json status: na - 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: 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 ---

--- 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: na - 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: na - task: lint_javascript_tests status: passed - 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 ---

anandkaranubc · 2025-04-17T09:35:25Z

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

+	if ( p === 1.0 ) {
+		return PINF;
+	}
+	return lnf( float64ToFloat32( p / float64ToFloat32( 1.0-p ) ) );


The need for a higher tolerance threshold in the JS tests is no longer necessary with this change. Previously, without using float64ToFloat32, calculations were elevated to double precision, resulting in different outputs.

anandkaranubc

Good to go! Thanks @vivekmaurya001 and @gunjjoshi!

vivekmaurya001 added 2 commits December 8, 2024 00:46

feat(math): add math/base/special/logitf

084c777

Merge branch 'logitf' of https://github.com/vivekmaurya001/stdlib int…

fba8f2c

…o logitf

stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. labels Dec 7, 2024

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Dec 7, 2024

chore: update copyright years

92cc9c6

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Dec 7, 2024

gunjjoshi reviewed Dec 24, 2024

View reviewed changes

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

gunjjoshi added status: Blocked Issue or pull request which is current blocked. and removed Needs Review A pull request which needs code review. labels Dec 24, 2024

vivekmaurya001 and others added 2 commits January 18, 2025 19:08

Merge branch 'stdlib-js:develop' into logitf

33ea60a

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

chore: update copyright years

2e3dce0

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

vivekmaurya001 added 2 commits January 18, 2025 14:29

vivekmaurya001 marked this pull request as draft January 18, 2025 14:30

vivekmaurya001 marked this pull request as ready for review January 18, 2025 15:33

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

vivekmaurya001 added 2 commits January 18, 2025 16:27

add math/base/special/logitf

5a0da6c

add math/base/special/logitf

b600358

kgryte removed the status: Blocked Issue or pull request which is current blocked. label Jan 18, 2025

gunjjoshi requested changes Mar 7, 2025

View reviewed changes