feat: add C ndarray interface and refactor implementation for `stats/base/dvarmpn` #4543

DhruvArvindSingh · 2025-01-04T21:15:57Z

Resolves None.

Description

What is the purpose of this pull request?

This pull request:

adds C ndarray interface for stats/base/dvarmpn
refactors JavaScript implementation
updates tests, docs, benchmarks and examples

Related Issues

Does this pull request have any related issues?

This pull request:

resolves 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: 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_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - 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 ---

stdlib-bot · 2025-01-04T21:18:08Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/dvarmpn	$\color{green}383/383$ $\color{green}+100.00\%$	$\color{green}21/21$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}383/383$ $\color{green}+100.00\%$

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

--- 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: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: failed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: failed ---

--- 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: passed - 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: 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_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: passed - task: run_c_examples status: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: failed ---

--- 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: 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: passed - 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: 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_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: passed - task: run_c_examples status: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - 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 ---

aayush0325

also, you haven't made the required changes in README.md please refer to some of the previously merged PRs to get an idea of what changes you need to make there.

lib/node_modules/@stdlib/stats/base/dvarmpn/examples/c/example.c

lib/node_modules/@stdlib/stats/base/dvarmpn/benchmark/benchmark.js

lib/node_modules/@stdlib/stats/base/dvarmpn/benchmark/c/benchmark.length.c

lib/node_modules/@stdlib/stats/base/dvarmpn/docs/repl.txt

lib/node_modules/@stdlib/stats/base/dvarmpn/src/main.c

lib/node_modules/@stdlib/stats/base/dvarmpn/lib/ndarray.native.js

aayush0325 · 2025-01-18T12:18:35Z

lib/node_modules/@stdlib/stats/base/dvarmpn/src/addon.c

-	STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, stride, argv, 3 );
-	STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dvarmpn( N, mean, correction, X, stride ), v );
+	STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 3 );
+	STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dvarmpn( N, mean, correction, X, strideX ), v );


Suggested change

STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dvarmpn( N, mean, correction, X, strideX ), v );

STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dvarmpn)( N, mean, correction, X, strideX ), v );

you'll also need to include stdlib/blas/base/shared.h

Please verify whether we need shared.h package is needed here, as it runs without it also

lib/node_modules/@stdlib/stats/base/dvarmpn/src/addon.c

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

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

--- 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: 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_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - 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 ---

DhruvArvindSingh · 2025-01-18T20:56:44Z

Thanks @aayush0325 for reviewing my PR.... I have made the necessary

aayush0325 · 2025-02-01T13:13:58Z

lib/node_modules/@stdlib/stats/base/dvarmpn/README.md


-The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [variance][variance] of every other element in `x`,
+The `N` and `strideX` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [variance][variance] of every other element in `x`,

 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );


please update this example to remove the usage of @stdlib/math/base/special/floor

same comment for all other instances

https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/%40stdlib/stats/base/smax/README.md?plain=1#L74

see how the examples are written here for reference!

aayush0325 · 2025-02-01T13:17:43Z

lib/node_modules/@stdlib/stats/base/dvarmpn/benchmark/c/benchmark.length.c

+static double benchmark2( int iterations, int len ) {
+	double elapsed;
+	double x[ len ];
+	float v;


Suggested change

float v;

double v;

aayush0325 · 2025-02-01T13:17:56Z

lib/node_modules/@stdlib/stats/base/dvarmpn/benchmark/c/benchmark.length.c

+	for ( i = 0; i < len; i++ ) {
+		x[ i ] = ( rand_double() * 20000.0 ) - 10000.0;
+	}
+	v = 0.0f;


Suggested change

v = 0.0f;

v = 0.0;

aayush0325 · 2025-02-01T13:18:28Z

lib/node_modules/@stdlib/stats/base/dvarmpn/benchmark/c/benchmark.length.c

+	t = tic();
+	for ( i = 0; i < iterations; i++ ) {
+		// cppcheck-suppress uninitvar
+		v = stdlib_strided_dvarmpn_ndarray( len, 0.0, 1, x, 1, 1 );


Suggested change

v = stdlib_strided_dvarmpn_ndarray( len, 0.0, 1, x, 1, 1 );

v = stdlib_strided_dvarmpn_ndarray( len, 0.0, 1, x, 1, 0 );

just following the convention here

aayush0325 · 2025-02-01T13:20:01Z

lib/node_modules/@stdlib/stats/base/dvarmpn/examples/c/example.c

 #include <stdio.h>

 int main( void ) {
 	// Create a strided array:
-	double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
+	const double x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };


Suggested change

const double x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };

const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };

only single precision floating-point values are suffixed with a f

aayush0325 · 2025-02-01T13:21:02Z

lib/node_modules/@stdlib/stats/base/dvarmpn/lib/dvarmpn.native.js

@@ -41,10 +41,10 @@ var addon = require( './../src/addon.node' );
 * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 *
 * var v = dvarmpn( x.length, 1.0/3.0, 1, x, 1 );
-* // returns ~4.3333
+*  //returns ~4.3333


Suggested change

* //returns ~4.3333

* // returns ~4.3333

aayush0325 · 2025-02-01T13:21:36Z

lib/node_modules/@stdlib/stats/base/dvarmpn/lib/ndarray.js

-* var v = dvarmpn( N, 1.25, 1, x, 2, 1 );
-* // returns 6.25
+* var v = dvarmpn( 4, 1.25, 1, x, 2, 1 );
+*  //returns 6.25


Suggested change

* //returns 6.25

* // returns 6.25

aayush0325 · 2025-02-01T13:22:03Z

lib/node_modules/@stdlib/stats/base/dvarmpn/lib/ndarray.native.js

-* var v = dvarmpn( N, 1.25, 1, x, 2, 1 );
-* // returns 6.25
+* var v = dvarmpn( 4, 1.25, 1, x, 2, 1 );
+*  //returns 6.25


Suggested change

* //returns 6.25

* // returns 6.25

DhruvArvindSingh marked this pull request as draft January 4, 2025 21:16

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels Jan 4, 2025

DhruvArvindSingh added 4 commits January 4, 2025 22:16

DhruvArvindSingh marked this pull request as ready for review January 5, 2025 11:49

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

kgryte requested a review from aayush0325 January 18, 2025 11:52

aayush0325 requested changes Jan 18, 2025

View reviewed changes

aayush0325 added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Jan 18, 2025

DhruvArvindSingh marked this pull request as draft January 18, 2025 12:33

DhruvArvindSingh and others added 4 commits January 19, 2025 01:51

Merge branch 'stdlib-js:develop' into ndarray/dvarmpn

4cb641f

DhruvArvindSingh requested a review from aayush0325 January 18, 2025 20:56

DhruvArvindSingh marked this pull request as ready for review January 18, 2025 20:56

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

aayush0325 requested changes Feb 1, 2025

View reviewed changes

aayush0325 mentioned this pull request Mar 30, 2025

feat: add C ndarray interface and refactor implementation for stats/base/dmeanvarpn #5030

Open

1 task

DhruvArvindSingh mentioned this pull request Apr 7, 2025

[RFC]: Add support for string arrays in stdlib stdlib-js/google-summer-of-code#144

Open

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add C ndarray interface and refactor implementation for `stats/base/dvarmpn` #4543

feat: add C ndarray interface and refactor implementation for `stats/base/dvarmpn` #4543

DhruvArvindSingh commented Jan 4, 2025

stdlib-bot commented Jan 4, 2025 •

edited

Loading

aayush0325 left a comment

aayush0325 Jan 18, 2025

DhruvArvindSingh Jan 18, 2025 •

edited

Loading

DhruvArvindSingh commented Jan 18, 2025

aayush0325 Feb 1, 2025

aayush0325 Feb 1, 2025

aayush0325 Feb 1, 2025

aayush0325 Feb 1, 2025

aayush0325 Feb 1, 2025

aayush0325 Feb 1, 2025

aayush0325 Feb 1, 2025

aayush0325 Feb 1, 2025

aayush0325 Feb 1, 2025

aayush0325 Feb 1, 2025

	STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dvarmpn( N, mean, correction, X, strideX ), v );
	STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dvarmpn)( N, mean, correction, X, strideX ), v );

	v = stdlib_strided_dvarmpn_ndarray( len, 0.0, 1, x, 1, 1 );
	v = stdlib_strided_dvarmpn_ndarray( len, 0.0, 1, x, 1, 0 );

	const double x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
	const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };

feat: add C ndarray interface and refactor implementation for stats/base/dvarmpn #4543

Are you sure you want to change the base?

feat: add C ndarray interface and refactor implementation for stats/base/dvarmpn #4543

Conversation

DhruvArvindSingh commented Jan 4, 2025

Description

Related Issues

Questions

Other

Checklist

stdlib-bot commented Jan 4, 2025 • edited Loading

Coverage Report

aayush0325 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DhruvArvindSingh Jan 18, 2025 • edited Loading

Choose a reason for hiding this comment

DhruvArvindSingh commented Jan 18, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat: add C ndarray interface and refactor implementation for `stats/base/dvarmpn` #4543

feat: add C ndarray interface and refactor implementation for `stats/base/dvarmpn` #4543

stdlib-bot commented Jan 4, 2025 •

edited

Loading

DhruvArvindSingh Jan 18, 2025 •

edited

Loading