Skip to content

Commit 224ba51

Browse files
committed
docs: update return annotations to use ndarray instance notation
1 parent 143189d commit 224ba51

File tree

4 files changed

+8
-33
lines changed

4 files changed

+8
-33
lines changed

lib/node_modules/@stdlib/blas/ext/base/ndarray/cfill/README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,8 @@ var x = new ndarray( 'complex64', buffer, [ 2 ], [ 1 ], 0, 'row-major' );
4242

4343
var alpha = new Complex64( 10.0, 10.0 );
4444

45-
cfill( x, alpha );
46-
47-
var v = x.get( 0 );
48-
// returns <Complex64>
49-
50-
var re = v.re;
51-
// returns 10.0
52-
53-
var im = v.im;
54-
// returns 10.0
45+
var out = cfill( x, alpha );
46+
// returns <ndarray>[ <Complex64>[ 10.0, 10.0 ], <Complex64>[ 10.0, 10.0 ] ]
5547
```
5648

5749
## Examples

lib/node_modules/@stdlib/blas/ext/base/ndarray/cfill/docs/repl.txt

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,9 @@
2222
<Complex64Array>
2323
> var x = {{alias:@stdlib/ndarray/ctor}}( 'complex64', buf, [ 2 ], [ 1 ], 0, 'row-major' )
2424
<ndarray>
25-
> var alpha = new {{alias:@stdlib/complex/float32/ctor}}( 10.0, 10.0 )
26-
<Complex64>
25+
> var alpha = new {{alias:@stdlib/complex/float32/ctor}}( 10.0, 10.0 );
2726
> {{alias}}( x, alpha )
28-
<ndarray>
29-
> var v = x.get( 0 )
30-
<Complex64>
31-
> var re = v.re
32-
10.0
33-
> var im = v.im
34-
10.0
27+
<ndarray>[ <Complex64>[ 10.0, 10.0 ], <Complex64>[ 10.0, 10.0 ] ]
3528

3629
See Also
3730
--------

lib/node_modules/@stdlib/blas/ext/base/ndarray/cfill/docs/types/index.d.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,8 @@ import { Complex64 } from '@stdlib/types/complex';
4040
*
4141
* var alpha = new Complex64( 10.0, 10.0 );
4242
*
43-
* cfill( x, alpha );
44-
*
45-
* var v = x.get( 0 );
46-
* // returns <Complex64>
43+
* var out = cfill( x, alpha );
44+
* // returns <ndarray>[ <Complex64>[ 10.0, 10.0 ], <Complex64>[ 10.0, 10.0 ] ]
4745
*/
4846
declare function cfill( x: complex64ndarray, alpha: Complex64 ): complex64ndarray;
4947

lib/node_modules/@stdlib/blas/ext/base/ndarray/cfill/lib/index.js

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,8 @@
3434
*
3535
* var alpha = new Complex64( 10.0, 10.0 );
3636
*
37-
* cfill( x, alpha );
38-
*
39-
* var v = x.get( 0 );
40-
* // returns <Complex64>
41-
*
42-
* var re = v.re;
43-
* // returns 10.0
44-
*
45-
* var im = v.im;
46-
* // returns 10.0
37+
* var out = cfill( x, alpha );
38+
* // returns <ndarray>[ <Complex64>[ 10.0, 10.0 ], <Complex64>[ 10.0, 10.0 ] ]
4739
*/
4840

4941
// MODULES //

0 commit comments

Comments
 (0)