stdlib-js / stdlib-js/stdlib

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

Đang mở
#1,088 8 bình luận 0 reaction 1 người được giao Được @prajwalkulkarni nhận Xem trên GitHub
Accepted difficulty: 2 Enhancement priority: High RFC TypeScript
Ngôn ngữ chính
JavaScript
Star
6k
Fork
1.3k
Merge trung bình
1 ngày 3 giờ
Pull request đã merge (30 ngày)
611

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.