Skip to content

docs: improve doctests for complex number typed arrays in ndarray/base/from-scalar #12049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
May 10, 2026
Merged

docs: improve doctests for complex number typed arrays in ndarray/base/from-scalar #12049

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b770799
docs: improve doctests for complex number typed arrays in `ndarray/ba…
anandkaranubc May 10, 2026
52ba2af
Apply suggestions from code review
kgryte May 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 6 additions & 20 deletions lib/node_modules/@stdlib/ndarray/base/from-scalar/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,9 @@ declare function scalar2ndarray( value: number, dtype: Float32DataType, order: O
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
Comment thread
kgryte marked this conversation as resolved.
* var getData = require( '@stdlib/ndarray/data-buffer' );
*
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var v = new Complex128( 1.0, 2.0 );
*
Expand All @@ -106,14 +105,8 @@ declare function scalar2ndarray( value: number, dtype: Float32DataType, order: O
* var dt = String( getDType( x ) );
* // returns 'complex128'
*
* var v = x.get();
* // returns <Complex128>
*
* var re = real( v );
* // returns 1.0
*
* var im = imag( v );
* // returns 2.0
* var buf = getData( x );
* // buf => <Complex128Array>[ 1.0, 2.0 ]
*/
declare function scalar2ndarray( value: number | ComplexLike, dtype: Complex128DataType, order: Order ): complex128ndarray;

Expand All @@ -132,10 +125,9 @@ declare function scalar2ndarray( value: number | ComplexLike, dtype: Complex128D
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
Comment thread
kgryte marked this conversation as resolved.
* var getData = require( '@stdlib/ndarray/data-buffer' );
*
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var v = new Complex64( 1.0, 2.0 );
*
Expand All @@ -148,14 +140,8 @@ declare function scalar2ndarray( value: number | ComplexLike, dtype: Complex128D
* var dt = String( getDType( x ) );
* // returns 'complex64'
*
* var v = x.get();
* // returns <Complex64>
*
* var re = realf( v );
* // returns 1.0
*
* var im = imagf( v );
* // returns 2.0
* var buf = getData( x );
* // buf => <Complex64Array>[ 1.0, 2.0 ]
*/
declare function scalar2ndarray( value: number | ComplexLike, dtype: Complex64DataType, order: Order ): complex64ndarray;

Expand Down