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 <gunjjoshi8372@gmail.com>

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 <gunjjoshi8372@gmail.com>

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

kgryte · 2025-08-13T18:18:02Z

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

+	dtypes.complex64, dtypes.complex128,
+
+	// complex128 (1)
+	dtypes.complex128, dtypes.complex128,


We should be able to downcast from complex128 to complex64. Same for other floating-point dtypes. We should support "mostly safe" casts.

...not just safe casts.

kgryte · 2025-08-13T18:18:52Z

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

+	dtypes.uint8, dtypes.int32,
+	dtypes.uint8, dtypes.uint16,
+	dtypes.uint8, dtypes.uint32,
+	dtypes.uint8, dtypes.uint8


This list also omits "generic" from the list of pairings.

kgryte · 2025-08-13T18:21:17Z

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

+	stdlib_ndarray_c_z_as_z_z,
+
+	// complex128 (1)
+	stdlib_ndarray_z_z,


This is also missing the "mostly safe" casts.

@kgryte This complex128 can be safely casted into complex64 according to "mostly safe" casts. But, for that, we don't have a kernel like stdlib_ndarray_z_c_as_c_c or stdlib_ndarray_z_c_as_z_z in https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary. Should we avoid these type of cases, where it is possible to cast according to mostly safe casts, but there is no suitable ndarray kernel for the combination thus formed?

We do have z_c which is the same as z_c_as_z_z. The suffix is implied when downcasting.

I couldn't find z_c here: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary. Do we have it in some other file?

Hmm...you're right. I see the issue in the generation script in unary. I'll try and fix later. In the meantime, you can assume that they will be present.

Got it, thanks for looking into this!

kgryte · 2025-08-13T18:22:41Z

lib/node_modules/@stdlib/math/special/sin/scripts/config.js

+*/
+var config = {
+	'input_dtypes': 'real_and_generic',
+	'output_dtypes': 'real_floating_point',


Here, we should also allow real_floating_point_and_generic. Meaning, if I give a "generic" array, I should get a "generic" array out, by default.

kgryte · 2025-08-13T18:48:00Z

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

+// VARIABLES //
+
+var DTYPES = {};
+var basePkg = basename( join( __dirname, '..' ) );


I think you should be able to read the package.json for the package for the package name, no?

--- 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 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 <gunjjoshi8372@gmail.com>

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

ff7deec

Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>

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 <gunjjoshi8372@gmail.com>

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 Outdated Show resolved Hide resolved

kgryte reviewed Aug 13, 2025

View reviewed changes

Uh oh!

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

Are you sure you want to change the base?

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

Conversation

gunjjoshi commented Jul 29, 2025

Description

Related Issues

Questions

Other

Checklist

Uh oh!

gunjjoshi commented Jul 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gunjjoshi commented Aug 8, 2025

Uh oh!

gunjjoshi commented Aug 11, 2025

Uh oh!

gunjjoshi commented Aug 13, 2025

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!

Uh oh!

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

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