chore: add a poc script for generating `dtype` combinations #7773

gunjjoshi · 2025-07-29T12:23:53Z

Resolves None.

Description

What is the purpose of this pull request?

This pull request:

adds a proof of concept to auto-generate valid dtype pairs.
The valid combinations are then written in src/addon.c and lib/types.js.
adds some meta-data in package.json of ceil, ceilf, cceil and cceilf. For now, I have only modified the relevant dtype fields in the meta-data of these 4 packages.

Related Issues

Does this pull request have any related issues?

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

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

gunjjoshi · 2025-07-29T12:27:10Z

Please note that the meta-data in scalar math kernels of ceil are not completely correct. I have modified the input and output dtype fields only, which were required as of now.

gunjjoshi · 2025-07-29T12:29:27Z

lib/node_modules/@stdlib/math/special/ceil/scripts/script.js

+	for ( i = 0; i < matches.length; i++ ) {
+		// Skip complex32, float16, uint8c and int16 as we don't support them yet...
+		if ( matches[ i ][ 0 ] === 'complex32' ||
+			matches[ i ][ 0 ] === 'int16' ||
+			matches[ i ][ 0 ] === 'float16' ||
+			matches[ i ][ 0 ] === 'uint8c' ||
+			matches[ i ][ 1 ] === 'complex32' ||
+			matches[ i ][ 1 ] === 'int16'||
+			matches[ i ][ 1 ] === 'float16' ||
+			matches[ i ][ 1 ] === 'uint8c' ) {
+			continue;
+		}


We are skipping those dtypes which are currently not present here: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary#c-apis

gunjjoshi · 2025-07-29T12:37:35Z

lib/node_modules/@stdlib/math/special/ceil/scripts/script.js

I checked the generated functions here: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary#c-apis, and all of them do exist.

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

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

gunjjoshi · 2025-08-08T19:52:55Z

I've removed the previous implementation now, and have kept only the latest approach, as discussed, for the sqrt function. Now, along with the scripts, we have a few more files that would be helpful:

@stdlib/math/special/scripts/dtype_hierarchy.js : To find out which dtype to prefer, such as, preferring float64 over float32, in order to compute in higher precision.
@stdlib/math/special/scripts/function_database.json : Contains input & output dtypes, output policy and scalar kernels for each function.
@stdlib/ndarray/base/unary/data/funstion_list.json : To verify if the calculated ndarray kernel is actually available in ndarray/base/unary or not.

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

…o ndarray-abs

gunjjoshi · 2025-08-11T03:04:10Z

I tried running the same script for sin, and it gives the same dtype pairs as given for sqrt, as their input and output dtype policies are same. Here's the generated addon.c and types.js for sin.

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

gunjjoshi · 2025-08-13T17:37:03Z

I've now added the generated files for floor as well.

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

kgryte · 2025-08-13T18:16:55Z

lib/node_modules/@stdlib/math/special/floor/lib/types.js

+	dtypes.complex128, dtypes.complex128,
+
+	// float32 (2)
+	dtypes.float32, dtypes.float32,


We should be able to go from float32 to complex64 and complex128. Same for other real-valued data types below.

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

gunjjoshi · 2025-08-20T18:12:49Z

For easy reference:

sin:
- addon.c
- types.js
sqrt:
- addon.c
- types.js
fibonacci:
- addon.c
- types.js
floor:
- addon.c
- types.js

lib/node_modules/@stdlib/math/special/sqrt/src/addon.c

lib/node_modules/@stdlib/math/special/sin/lib/types.js

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

gunjjoshi · 2025-08-23T05:55:18Z

Now, we are able to generate the following files:

src/addon.c
lib/types.js
lib/data.js
lib/meta.json
lib/types.json

I have included all the above generated files for floor, fibonacci, sin and sqrt in this PR now.

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

gunjjoshi · 2025-08-27T12:48:15Z

I've added the generated files for math/special/abs now, which are inside math/special/abs-generated.

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

lib/node_modules/@stdlib/math/special/scripts/function_database.json

Signed-off-by: Athan <[email protected]>

lib/node_modules/@stdlib/math/special/scripts/function_database.json

kgryte · 2025-09-10T19:40:04Z

lib/node_modules/@stdlib/math/special/scripts/scaffold_database.json

math/special/data/unary.json

kgryte · 2025-09-10T19:40:33Z

lib/node_modules/@stdlib/math/special/scripts/generate_scaffolds_database.js

math/special/scripts/generate_unary_database.js

PR-URL: #8065 Ref: #7773 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>

gunjjoshi added 9 commits July 22, 2025 07:47

chore: initial script

56dab20

Merge branch 'stdlib-js:develop' into ndarray-abs

d5b6478

Merge branch 'stdlib-js:develop' into ndarray-abs

24ef2b0

refactor: try out the script for ceil

e287527

Merge branch 'stdlib-js:develop' into ndarray-abs

9f25fb6

stdlib-bot added the Math Issue or pull request specific to math functionality. label Jul 29, 2025

gunjjoshi added 2 commits July 29, 2025 17:54

Delete lib/node_modules/@stdlib/math/special/abs/scripts/test.js

cced8c1

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

Delete lib/node_modules/@stdlib/math/special/abs/src/addon.c.txt

ff7deec

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

gunjjoshi commented Jul 29, 2025

View reviewed changes

gunjjoshi added 5 commits July 29, 2025 18:09

Update script.js

807edcd

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

Merge branch 'stdlib-js:develop' into ndarray-abs

e5dfa06

refactor: try new approach

34f340e

gunjjoshi added 3 commits August 11, 2025 08:17

Merge branch 'stdlib-js:develop' into ndarray-abs

e17871e

Merge branch 'ndarray-abs' of https://github.com/gunjjoshi/stdlib int…

f77a874

…o ndarray-abs

gunjjoshi added 2 commits August 13, 2025 20:30

Merge branch 'stdlib-js:develop' into ndarray-abs

5de19a6

kgryte reviewed Aug 13, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/sqrtf/package.json Show resolved Hide resolved

kgryte reviewed Aug 13, 2025

View reviewed changes

gunjjoshi added 2 commits August 20, 2025 23:37

kgryte reviewed Aug 20, 2025

View reviewed changes

lib/node_modules/@stdlib/math/special/sqrt/src/addon.c Outdated Show resolved Hide resolved

kgryte reviewed Aug 20, 2025

View reviewed changes

lib/node_modules/@stdlib/math/special/sin/lib/types.js Outdated Show resolved Hide resolved

gunjjoshi added 7 commits August 22, 2025 22:29

gunjjoshi added 3 commits August 27, 2025 18:12

Merge branch 'develop' into ndarray-abs

4736a94

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