Skip to content

Commit 56a58df

Browse files
committed
Auto-generated commit
1 parent 1d56686 commit 56a58df

2 files changed

Lines changed: 56 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2026-04-24)
7+
## Unreleased (2026-05-10)
88

99
<section class="features">
1010

1111
### Features
1212

13+
- [`009e8bf`](https://github.com/stdlib-js/stdlib/commit/009e8bfdd4aa743569580ece4a034cad5287926d) - add `Descriptor` interface in `@stdlib/ndarray` module
1314
- [`b9502d5`](https://github.com/stdlib-js/stdlib/commit/b9502d5bdeb15982528aa7777f399a291c9dc6b8) - add complex32 type definitions and add `Float16Array` stub
1415
- [`f6efb5e`](https://github.com/stdlib-js/stdlib/commit/f6efb5ea8dbd31affbd90bb35c8de06b33bb3704) - add support for float16 array types [(#9806)](https://github.com/stdlib-js/stdlib/pull/9806)
1516
- [`b1a1b7f`](https://github.com/stdlib-js/stdlib/commit/b1a1b7fe3c8b93365c70632b726d6797d2af4438) - add support for ndarray data type objects and update existing type definitions
@@ -49,6 +50,8 @@
4950

5051
<details>
5152

53+
- [`009e8bf`](https://github.com/stdlib-js/stdlib/commit/009e8bfdd4aa743569580ece4a034cad5287926d) - **feat:** add `Descriptor` interface in `@stdlib/ndarray` module _(by Athan Reines)_
54+
- [`5a06940`](https://github.com/stdlib-js/stdlib/commit/5a06940ac26e639280b53b34b6707f6ac714d28a) - **docs:** fix typos and examples [(#11761)](https://github.com/stdlib-js/stdlib/pull/11761) _(by Philipp Burckhardt, Athan Reines)_
5255
- [`b9502d5`](https://github.com/stdlib-js/stdlib/commit/b9502d5bdeb15982528aa7777f399a291c9dc6b8) - **feat:** add complex32 type definitions and add `Float16Array` stub _(by Athan Reines)_
5356
- [`f6efb5e`](https://github.com/stdlib-js/stdlib/commit/f6efb5ea8dbd31affbd90bb35c8de06b33bb3704) - **feat:** add support for float16 array types [(#9806)](https://github.com/stdlib-js/stdlib/pull/9806) _(by Gururaj Gurram)_
5457
- [`64fa79c`](https://github.com/stdlib-js/stdlib/commit/64fa79c79b2aa6a98404676be3c05b5048684011) - **style:** disable lint rule _(by Athan Reines)_
@@ -75,10 +78,11 @@
7578

7679
### Contributors
7780

78-
A total of 2 people contributed to this release. Thank you to the following contributors:
81+
A total of 3 people contributed to this release. Thank you to the following contributors:
7982

8083
- Athan Reines
8184
- Gururaj Gurram
85+
- Philipp Burckhardt
8286

8387
</section>
8488

index.d.ts

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -670,7 +670,7 @@ declare module '@stdlib/types/array' {
670670
* @example
671671
* const buf = new Float16Array( 8 );
672672
*
673-
* const z: Complex64Array = {
673+
* const z: Complex32Array = {
674674
* 'byteLength': 16,
675675
* 'byteOffset': 0,
676676
* 'BYTES_PER_ELEMENT': 2,
@@ -2755,6 +2755,55 @@ declare module '@stdlib/types/ndarray' {
27552755
*/
27562756
type Strides10D = Collection<number>;
27572757

2758+
/**
2759+
* Interface describing an ndarray descriptor.
2760+
*
2761+
* @example
2762+
* const obj: Descriptor = {
2763+
* 'data': [ 1, 2, 3 ],
2764+
* 'dtype': 'generic',
2765+
* 'shape': [ 3 ],
2766+
* 'strides': [ 1 ],
2767+
* 'offset': 0,
2768+
* 'order': 'row-major'
2769+
* };
2770+
*/
2771+
interface Descriptor {
2772+
/**
2773+
* A reference to the underlying data buffer.
2774+
*/
2775+
data: ArrayLike<any> | AccessorArrayLike<any>; // eslint-disable-line @typescript-eslint/no-explicit-any
2776+
2777+
/**
2778+
* Underlying data type.
2779+
*/
2780+
dtype: string | BaseDataTypeObject;
2781+
2782+
/**
2783+
* Array shape.
2784+
*/
2785+
shape: Shape;
2786+
2787+
/**
2788+
* Array strides.
2789+
*/
2790+
strides: Strides;
2791+
2792+
/**
2793+
* Index offset which specifies the `buffer` index at which to start iterating over array elements.
2794+
*/
2795+
offset: number;
2796+
2797+
/**
2798+
* Array order.
2799+
*
2800+
* ## Notes
2801+
*
2802+
* - The array order is either row-major (C-style) or column-major (Fortran-style).
2803+
*/
2804+
order: Order;
2805+
}
2806+
27582807
/**
27592808
* Flags and other meta information (e.g., memory layout of the array).
27602809
*/

0 commit comments

Comments
 (0)