stdlib-js / stdlib-js/stdlib

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

オープン
#1,088 コメント 8 件 リアクション 0 件 担当者 1 名 @prajwalkulkarni が担当を希望しています GitHub で見る
Accepted difficulty: 2 Enhancement priority: High RFC TypeScript
主要言語
JavaScript
スター
6k
フォーク
1.3k
平均マージ
1日 3時間
マージ済み PR(30日)
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 を短くまとめたダイジェスト。