stdlib-js / stdlib-js/stdlib

[RFC]: improve type declarations for `@stdlib/ndarray/array`

未关闭
#1,088 8 条评论 0 个 reaction 已指派 1 人 已被 @prajwalkulkarni 认领 在 GitHub 查看
Accepted difficulty: 2 Enhancement priority: High RFC TypeScript
主要语言
JavaScript
星标
6k
派生
1.3k
平均合并
1 天 3 小时
30 天内合并 PR
611

描述

### Description

This RFC proposes improving the TypeScript type declarations for `@stdlib/ndarray/array`. Currently, type declarations do not account for `dtype` information.

Ideally, we'd improve declarations such that

- based on a provided `dtype` option value, we return an `ndarray` of the corresponding type (e.g., if `dtype = 'float64'`, then return a `float64ndarray`, etc).
- when not provided a `dtype` option value, we use the `buffer` argument/option to infer a corresponding output `ndarray` dtype.

Supporting the above is likely to require extensive use of function overloads in a manner to what we've done elsewhere in the project when a dtype can effect output results.

### Related Issues

No.

### Questions

No.

### Other

No.

### 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:`.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

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