feat: add `@stdlib/ndarray/to-locale-string` by headlessNode · Pull Request #10898 · stdlib-js/stdlib

headlessNode · 2026-03-12T11:48:25Z

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

Resolves stdlib-js/metr-issue-tracker#189.

Description

What is the purpose of this pull request?

This pull request:

add @stdlib/ndarray/to-locale-string

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

Resolves [RFC]: add ndarray/to-locale-string metr-issue-tracker#189

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.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

Yes
No

If you answered "yes" above, how did you use AI assistance?

Code generation (e.g., when writing an implementation or fixing a bug)
Test/benchmark generation
Documentation (including examples)
Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

Primarily written by Claude Code.

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

stdlib-bot · 2026-03-12T11:51:25Z

Coverage Report

Package	Statements	Branches	Functions	Lines
ndarray/to-locale-string	$\color{red}327/334$ $\color{green}+97.90%$	$\color{red}49/54$ $\color{green}+90.74%$	$\color{green}2/2$ $\color{green}+100.00%$	$\color{red}327/334$ $\color{green}+97.90%$

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

lib/node_modules/@stdlib/ndarray/to-locale-string/docs/types/index.d.ts

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>

Signed-off-by: Athan <kgryte@gmail.com>

lib/node_modules/@stdlib/ndarray/to-locale-string/docs/repl.txt

Signed-off-by: Athan <kgryte@gmail.com>

lib/node_modules/@stdlib/ndarray/to-locale-string/lib/main.js

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>

lib/node_modules/@stdlib/ndarray/to-locale-string/README.md

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>

kgryte · 2026-03-20T01:13:18Z

lib/node_modules/@stdlib/ndarray/to-locale-string/test/test.js

+		'set': noop
+	};
+
+	expected = 'ndarray( \'float64\', new Float64Array( [ 3, 5, 4, 6 ] ), [ 2, 2 ], [ 1, 2 ], 0, \'column-major\' )';


This is incorrect.

kgryte · 2026-03-20T01:17:39Z

lib/node_modules/@stdlib/ndarray/to-locale-string/test/test.js

+	t.end();
+
+	function getter( i, j ) {
+		return arr.data[ arr.offset+sub2ind( [ 2, 2 ], i, j ) ];


I am not sure why this is the approach was used for resolving a linear index because it is wrong. sub2ind resolves a view index, not a buffer index. For that you need to use vind2bind. But even then, just compute the index manually using strides. I believe you did this elsewhere.

kgryte · 2026-03-20T01:18:13Z

lib/node_modules/@stdlib/ndarray/to-locale-string/test/test.js

+	t.end();
+
+	function getter( i, j ) {
+		return arr.data.get( arr.offset+sub2ind( [ 2, 2 ], i, j ) );


Same comment as above and throughout this file.

kgryte · 2026-03-20T01:21:26Z

lib/node_modules/@stdlib/ndarray/to-locale-string/test/test.js

+	t.strictEqual( typeof actual, 'string', 'returns expected value' );
+	t.notEqual( actual.indexOf( '...' ), -1, 'contains ellipsis' );
+	t.notEqual( actual.indexOf( '0, 1, 2' ), -1, 'contains first three values' );
+	t.notEqual( actual.indexOf( '98, 99, 100' ), -1, 'contains last three values' );


What is this?

All these tests are wrong.

kgryte · 2026-03-20T01:22:08Z

lib/node_modules/@stdlib/ndarray/to-locale-string/test/test.js

+
+	actual = ndarray2localeString( arr );
+	t.strictEqual( typeof actual, 'string', 'returns expected value' );
+	t.notEqual( actual.indexOf( '...' ), -1, 'contains ellipsis' );


This is wrong. Did you review these tests to ensure they made sense?

kgryte · 2026-03-20T01:22:32Z

lib/node_modules/@stdlib/ndarray/to-locale-string/test/test.js

+	t.end();
+
+	function getter( i, j ) {
+		return arr.data[ arr.offset+sub2ind( [ 2, 2 ], i, j ) ];


Same comment as above regarding sub2ind.

lib/node_modules/@stdlib/ndarray/to-locale-string/README.md

Signed-off-by: Athan <kgryte@gmail.com>

kgryte · 2026-03-20T01:45:38Z

lib/node_modules/@stdlib/ndarray/to-locale-string/README.md

+<!-- eslint no-undef: "error" -->
+
+```javascript
+var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );


For a top-level package, I don't find this example particularly compelling. Instead, I suggest simplifying and simply (1) using, say, random/uniform to generate an ndarray of random values and (2) serializing that ndarray to a string using different locale identifiers (e.g., for English, German, etc) and potentially different configuration options (e.g., maximum number of digits, etc).

And I think it would be useful to use doctest return annotations for console.log statements to show the expected output. This would allow readers to develop a visual intuition regarding expected output.

This comment also applies to the corresponding example file.

kgryte

Left initial comments.

kgryte · 2026-03-20T01:47:54Z

For METR,

review_time: 50 mins

stdlib-bot added the Needs Review A pull request which needs code review. label Mar 12, 2026

headlessNode added Feature Issue or pull request for adding a new feature. METR Pull request associated with the METR project. labels Mar 12, 2026

headlessNode requested a review from kgryte March 12, 2026 12:02

headlessNode mentioned this pull request Mar 12, 2026

feat: add ndarray/to-string #10899

Draft

7 tasks