Skip to content

Commit 62e29f4

Browse files
docs: improve doctests for complex number typed arrays in ndarray/base/map
PR-URL: #12050 Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: stdlib-js/metr-issue-tracker#523 Ref: #4833
1 parent 051da21 commit 62e29f4

21 files changed

Lines changed: 21 additions & 168 deletions

lib/node_modules/@stdlib/ndarray/base/map/lib/0d_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,7 @@
102102
*
103103
* // Apply function:
104104
* map0d( x, y, scale, {} );
105-
*
106-
* var v = y.data.get( 0 );
107-
*
108-
* var re = realf( v );
109-
* // returns 30.0
110-
*
111-
* var im = imagf( v );
112-
* // returns 40.0
105+
* // ybuf => <Complex64Array>[ 30.0, 40.0, 0.0, 0.0 ]
113106
*/
114107
function map0d( x, y, fcn, thisArg ) {
115108
y.accessors[ 1 ]( y.data, y.offset, fcn.call( thisArg, x.accessors[ 0 ]( x.data, x.offset ), [], x.ref ) ); // eslint-disable-line max-len

lib/node_modules/@stdlib/ndarray/base/map/lib/10d_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
112112
*
113113
* // Apply function:
114114
* map10d( x, y, true, scale, {} );
115-
*
116-
* var v = y.data.get( 0 );
117-
*
118-
* var re = realf( v );
119-
* // returns 10.0
120-
*
121-
* var im = imagf( v );
122-
* // returns 20.0
115+
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
123116
*/
124117
function map10d( x, y, isRowMajor, fcn, thisArg ) { // eslint-disable-line max-statements
125118
var xbuf;

lib/node_modules/@stdlib/ndarray/base/map/lib/10d_blocked_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
112112
*
113113
* // Apply function:
114114
* blockedmap10d( x, y, scale, {} );
115-
*
116-
* var v = y.data.get( 0 );
117-
*
118-
* var re = realf( v );
119-
* // returns 10.0
120-
*
121-
* var im = imagf( v );
122-
* // returns 20.0
115+
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
123116
*/
124117
function blockedmap10d( x, y, fcn, thisArg ) { // eslint-disable-line max-statements, max-lines-per-function
125118
var bsize;

lib/node_modules/@stdlib/ndarray/base/map/lib/1d_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,7 @@
102102
*
103103
* // Apply function:
104104
* map1d( x, y, scale, {} );
105-
*
106-
* var v = y.data.get( 0 );
107-
*
108-
* var re = realf( v );
109-
* // returns 10.0
110-
*
111-
* var im = imagf( v );
112-
* // returns 20.0
105+
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
113106
*/
114107
function map1d( x, y, fcn, thisArg ) {
115108
var xbuf;

lib/node_modules/@stdlib/ndarray/base/map/lib/2d_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
110110
*
111111
* // Apply function:
112112
* map2d( x, y, true, scale, {} );
113-
*
114-
* var v = y.data.get( 0 );
115-
*
116-
* var re = realf( v );
117-
* // returns 10.0
118-
*
119-
* var im = imagf( v );
120-
* // returns 20.0
113+
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
121114
*/
122115
function map2d( x, y, isRowMajor, fcn, thisArg ) {
123116
var xbuf;

lib/node_modules/@stdlib/ndarray/base/map/lib/2d_blocked_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
110110
*
111111
* // Apply function:
112112
* blockedmap2d( x, y, scale, {} );
113-
*
114-
* var v = y.data.get( 0 );
115-
*
116-
* var re = realf( v );
117-
* // returns 10.0
118-
*
119-
* var im = imagf( v );
120-
* // returns 20.0
113+
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
121114
*/
122115
function blockedmap2d( x, y, fcn, thisArg ) {
123116
var bsize;

lib/node_modules/@stdlib/ndarray/base/map/lib/3d_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
110110
*
111111
* // Apply function:
112112
* map3d( x, y, true, scale, {} );
113-
*
114-
* var v = y.data.get( 0 );
115-
*
116-
* var re = realf( v );
117-
* // returns 10.0
118-
*
119-
* var im = imagf( v );
120-
* // returns 20.0
113+
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
121114
*/
122115
function map3d( x, y, isRowMajor, fcn, thisArg ) {
123116
var xbuf;

lib/node_modules/@stdlib/ndarray/base/map/lib/3d_blocked_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
112112
*
113113
* // Apply function:
114114
* blockedmap3d( x, y, scale, {} );
115-
*
116-
* var v = y.data.get( 0 );
117-
*
118-
* var re = realf( v );
119-
* // returns 10.0
120-
*
121-
* var im = imagf( v );
122-
* // returns 20.0
115+
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
123116
*/
124117
function blockedmap3d( x, y, fcn, thisArg ) {
125118
var bsize;

lib/node_modules/@stdlib/ndarray/base/map/lib/4d_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
110110
*
111111
* // Apply function:
112112
* map4d( x, y, true, scale, {} );
113-
*
114-
* var v = y.data.get( 0 );
115-
*
116-
* var re = realf( v );
117-
* // returns 10.0
118-
*
119-
* var im = imagf( v );
120-
* // returns 20.0
113+
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
121114
*/
122115
function map4d( x, y, isRowMajor, fcn, thisArg ) {
123116
var xbuf;

lib/node_modules/@stdlib/ndarray/base/map/lib/4d_blocked_accessors.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
112112
*
113113
* // Apply function:
114114
* blockedmap4d( x, y, scale, {} );
115-
*
116-
* var v = y.data.get( 0 );
117-
*
118-
* var re = realf( v );
119-
* // returns 10.0
120-
*
121-
* var im = imagf( v );
122-
* // returns 20.0
115+
* // ybuf => <Complex64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0 ]
123116
*/
124117
function blockedmap4d( x, y, fcn, thisArg ) { // eslint-disable-line max-statements
125118
var bsize;

0 commit comments

Comments
 (0)