feat: add stats/incr/nanmmeanstdev

[saad-imran-dev]

---

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

Description

What is the purpose of this pull request?

This pull request:

• It adds module which is a wrapper around mmeanstdev for handling NaN values. It ignores any NaN values passes in the accumulator

Related Issues

Does this pull request have any related issues?

This pull request:

• resolves [RFC]: add stats/incr/nanmmeanstdev #5591

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

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/incr/nanmmeanstdev	$\color{green}213/213$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}213/213$ $\color{green}+100.00\%$

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

[ShabiShett07]

/stdlib update-copyright-years

[ShabiShett07]

@saad-imran-dev, please update your pr title to:

feat: add `stats/incr/nanmmeanstdev`

to pass the pr title check.

[ShabiShett07]

Suggested change

var randu = require( '@stdlib/random/base/randu' );

I think we don't need to use this package, instead we could just pass iteration number as input

[ShabiShett07]

Suggested change

	v = acc( randu() );
	v = acc( i );

Same reason

[ShabiShett07]

I think the examples should be updated as we need to pass NaN values too in the input, please refer other similar packages.

[ShabiShett07]

Same here

[ShabiShett07]

@saad-imran-dev, I think your implementation is missing repl.txt file

[ShabiShett07]

Suggested change

	* If provided a value, the accumulator function returns an updated moving arithmetic mean and corrected sample standard deviation. If provided NaN or no value, the accumulator function returns the current moving arithmetic mean and corrected sample standard deviation.
	* If provided a value, the accumulator function returns an updated moving arithmetic mean and corrected sample standard deviation. If provided `NaN` or no value, the accumulator function returns the current moving arithmetic mean and corrected sample standard deviation.

[ShabiShett07]

Here and elsewhere

[saad-imran-dev]

@saad-imran-dev, I think your implementation is missing repl.txt file

@ShabiShett07 I get this error whenever I try to add repl.txt and commit. Not able to resolve this error.

/stdlib/lib/node_modules/@stdlib/_tools/repl-txt/rules/match-signature/lib/main.js:61
                                if ( params[i].multiple !== sigParams[i-skip].multiple ) {

{{alias}}()
    Returns an accumulator function which incrementally computes a moving
    arithmetic mean and corrected sample standard deviation, ignoring
    `NaN` values.

    The `W` parameter defines the number of values over which to compute the
    moving arithmetic mean and corrected sample standard deviation.

    If provided a value, the accumulator function returns updated accumulated
    values. If not provided a value, the accumulator function returns
    the current moving accumulated values.

    As `W` values are needed to fill the window buffer, the first `W-1` returned
    accumulated values are calculated from smaller sample sizes. Until the
    window is full, each returned accumulated value is calculated from all
    provided values.

    Parameters
    ----------
    out: Array|TypedArray (optional)
        Output array.

    W: integer
        Window size.

    Returns
    -------
    acc: Function
        Accumulator function.

    Examples
    --------
    > var accumulator = {{alias}}( 3 );
    > var v = accumulator()
    null
    > v = accumulator( 2.0 )
    [ 2.0, 0.0 ]
    > v = accumulator( -5.0 )
    [ -1.5, ~4.95 ]
    > v = accumulator( NaN )
    [ -1.5, ~4.95 ]
    > v = accumulator( 3.0 )
    [ 0.0, ~4.36 ]
    > v = accumulator( 5.0 )
    [ 1.0, ~5.29 ]
    > v = accumulator( NaN )
    [ 1.0, ~5.29 ]
    > v = accumulator()
    [ 1.0, ~5.29 ]

    See Also
    --------