Skip to content

Commit 5328dc9

Browse files
committed
Auto-generated commit
1 parent a7f33b9 commit 5328dc9

3 files changed

Lines changed: 14 additions & 20 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -929,6 +929,7 @@ A total of 49 issues were closed in this release:
929929

930930
<details>
931931

932+
- [`c5215cc`](https://github.com/stdlib-js/stdlib/commit/c5215cca9085bae13510df122d8637595eb6645d) - **docs:** improve doctests for complex number typed arrays in `ndarray/base/from-scalar` [(#12049)](https://github.com/stdlib-js/stdlib/pull/12049) _(by Karan Anand, Athan Reines)_
932933
- [`1e326dd`](https://github.com/stdlib-js/stdlib/commit/1e326dd99001c7919f24ad6f477597d14da00b23) - **docs:** improve doctests for complex number typed arrays in `ndarray/base/nullary` [(#12045)](https://github.com/stdlib-js/stdlib/pull/12045) _(by Karan Anand)_
933934
- [`c61a3e6`](https://github.com/stdlib-js/stdlib/commit/c61a3e6bbdddc67fc7b384e9bf283a34b75fd38f) - **docs:** improve doctests for complex number typed arrays in `ndarray/base/unary-by` [(#12047)](https://github.com/stdlib-js/stdlib/pull/12047) _(by Karan Anand)_
934935
- [`d4e7085`](https://github.com/stdlib-js/stdlib/commit/d4e708558f65e141de712cec2484c27838df2cd8) - **docs:** improve doctests for complex number typed arrays in `ndarray/base/unary` [(#12044)](https://github.com/stdlib-js/stdlib/pull/12044) _(by Karan Anand)_

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,11 @@ For more information on the project, filing bug reports and feature requests, an
365365

366366
---
367367

368+
## License
369+
370+
See [LICENSE][stdlib-license].
371+
372+
368373
## Copyright
369374

370375
Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
@@ -411,6 +416,8 @@ Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
411416
[esm-readme]: https://github.com/stdlib-js/ndarray/blob/esm/README.md
412417
[branches-url]: https://github.com/stdlib-js/ndarray/blob/main/branches.md
413418

419+
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray/main/LICENSE
420+
414421
<!-- <toc-links> -->
415422

416423
[@stdlib/ndarray/defaults]: https://github.com/stdlib-js/ndarray/tree/main/defaults

base/from-scalar/docs/types/index.d.ts

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,9 @@ declare function scalar2ndarray( value: number, dtype: Float32DataType, order: O
9090
* @example
9191
* var getShape = require( '@stdlib/ndarray/shape' );
9292
* var getDType = require( '@stdlib/ndarray/dtype' );
93+
* var getData = require( '@stdlib/ndarray/data-buffer' );
9394
*
9495
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
95-
* var real = require( '@stdlib/complex/float64/real' );
96-
* var imag = require( '@stdlib/complex/float64/imag' );
9796
*
9897
* var v = new Complex128( 1.0, 2.0 );
9998
*
@@ -106,14 +105,8 @@ declare function scalar2ndarray( value: number, dtype: Float32DataType, order: O
106105
* var dt = String( getDType( x ) );
107106
* // returns 'complex128'
108107
*
109-
* var v = x.get();
110-
* // returns <Complex128>
111-
*
112-
* var re = real( v );
113-
* // returns 1.0
114-
*
115-
* var im = imag( v );
116-
* // returns 2.0
108+
* var buf = getData( x );
109+
* // buf => <Complex128Array>[ 1.0, 2.0 ]
117110
*/
118111
declare function scalar2ndarray( value: number | ComplexLike, dtype: Complex128DataType, order: Order ): complex128ndarray;
119112

@@ -132,10 +125,9 @@ declare function scalar2ndarray( value: number | ComplexLike, dtype: Complex128D
132125
* @example
133126
* var getShape = require( '@stdlib/ndarray/shape' );
134127
* var getDType = require( '@stdlib/ndarray/dtype' );
128+
* var getData = require( '@stdlib/ndarray/data-buffer' );
135129
*
136130
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
137-
* var realf = require( '@stdlib/complex/float32/real' );
138-
* var imagf = require( '@stdlib/complex/float32/imag' );
139131
*
140132
* var v = new Complex64( 1.0, 2.0 );
141133
*
@@ -148,14 +140,8 @@ declare function scalar2ndarray( value: number | ComplexLike, dtype: Complex128D
148140
* var dt = String( getDType( x ) );
149141
* // returns 'complex64'
150142
*
151-
* var v = x.get();
152-
* // returns <Complex64>
153-
*
154-
* var re = realf( v );
155-
* // returns 1.0
156-
*
157-
* var im = imagf( v );
158-
* // returns 2.0
143+
* var buf = getData( x );
144+
* // buf => <Complex64Array>[ 1.0, 2.0 ]
159145
*/
160146
declare function scalar2ndarray( value: number | ComplexLike, dtype: Complex64DataType, order: Order ): complex64ndarray;
161147

0 commit comments

Comments
 (0)