stdlib-js / stdlib-js/stdlib

[RFC]: add `stats/incr/nanminmax`

未关闭
#5,579 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Accepted difficulty: 2 Feature Good First Issue JavaScript priority: Normal RFC Statistics
主要语言
JavaScript
星标
6k
派生
1.3k
平均合并
1 天 3 小时
30 天内合并 PR
611

描述

## Description

This RFC proposes adding a new package to the `stats/incr/*` namespace: `@stdlib/stats/incr/nanminmax`.

This package is similar to [`@stdlib/stats/incr/minmax`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/minmax), except that it performs special handling of `NaN` values.

### Key Points

When implementing this package, you'll need to do the following:

#### Create package files

To see examples of similar packages, see [`@stdlib/stats/incr/minmax`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/minmax) (propagates `NaN` values) and [`@stdlib/stats/incr/nansum`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/nansum) (wraps a `NaN` propagating accumulator and skips `NaN` values).

In particular notice how `nansum` is a thin wrapper around `sum`. In most cases, this is what we are looking for.

While the package proposed in this RFC will **not** match the implementations found in the above packages, those packages should provide a conceptual idea of what is desired. Do **not** simply copy-paste the code found in those packages without reasoning about expected behavior and API design.

#### Update source files

Once you've created package files, proceed to update all tests, documentation, and examples to reflect the API and expected behavior for the package. You should spend some time studying the tests in [`@stdlib/stats/incr/minmax`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/minmax). We expect this package to have equivalent and fully comprehensive tests. The primary difference will be in the handling of `NaN` values.

To see an example of what is expected, study the tests in

- [`@stdlib/stats/incr/sum`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/sum) and [`@stdlib/stats/incr/nansum`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/nansum)

Compare and contrast the tests in that pair of packages.

#### Run tests and other commands

For each of the following commands, please run them from the root stdlib repository directory (not the package folder!).

To run unit tests,

```bash
make test TESTS_FILTER=".*/stats/incr/nanminmax/.*"
```

To run examples,

```bash
make examples EXAMPLES_FILTER=".*/stats/incr/nanminmax/.*"
```

To run benchmarks,

```bash
make benchmark BENCHMARKS_FILTER=".*/stats/incr/nanminmax/.*"
```

### Create pull request

Provided all tests, examples, and benchmarks successfully execute and pass and that you've updated the package's documentation, you are now ready to open a pull request!

* * *

## Notes

- If you are interested in contributing a PR which addresses this RFC and still getting familiar with our project conventions, please do **not** submit LLM-generated code. Please consult our [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) and the associated [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md). Failure to respect project conventions will result in your PR being rejected without review. Thank you for understanding!

### Checklist

- [X] I have read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
- [X] Searched for existing issues and pull requests.
- [X] The issue name begins with `[RFC]:`.

贡献指南

打开贡献指南

调研方向

Start by comparing the package structure and tests for @stdlib/stats/incr/minmax, @stdlib/stats/incr/nansum, and their related sum tests. Create the nanminmax package, then update its tests, documentation, examples, and benchmarks; done means the filtered make test, make examples, and make benchmark commands pass from the repository root.

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
data
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。