Skip to content

Commit 6bea1e3

Browse files
committed
docs: improve doctests for complex number instances in ndarray/base/unary/lib
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 4304bee commit 6bea1e3

21 files changed

Lines changed: 42 additions & 187 deletions

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,9 @@
4646
* @example
4747
* var Complex64Array = require( '@stdlib/array/complex64' );
4848
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
49-
* var realf = require( '@stdlib/complex/float32/real' );
50-
* var imagf = require( '@stdlib/complex/float32/imag' );
5149
*
5250
* function scale( z ) {
53-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
51+
* return new Complex64( z.re*10.0, z.im*10.0 );
5452
* }
5553
*
5654
* // Create data buffers:
@@ -101,12 +99,7 @@
10199
* unary0d( x, y, scale );
102100
*
103101
* var v = y.data.get( 0 );
104-
*
105-
* var re = realf( v );
106-
* // returns 30.0
107-
*
108-
* var im = imagf( v );
109-
* // returns 40.0
102+
* // returns <Complex64>[ 30.0, 40.0 ]
110103
*/
111104
function unary0d( x, y, fcn ) {
112105
y.accessors[ 1 ]( y.data, y.offset, fcn( x.accessors[ 0 ]( x.data, x.offset ) ) ); // eslint-disable-line max-len

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,9 @@
4949
* @example
5050
* var Complex64Array = require( '@stdlib/array/complex64' );
5151
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
52-
* var realf = require( '@stdlib/complex/float32/real' );
53-
* var imagf = require( '@stdlib/complex/float32/imag' );
5452
*
5553
* function scale( z ) {
56-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
54+
* return new Complex64( z.re*10.0, z.im*10.0 );
5755
* }
5856
*
5957
* // Create data buffers:
@@ -104,12 +102,7 @@
104102
* unary10d( x, y, true, scale );
105103
*
106104
* 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+
* // returns <Complex64>[ 10.0, 20.0 ]
113106
*/
114107
function unary10d( x, y, isRowMajor, fcn ) { // eslint-disable-line max-statements
115108
var xbuf;

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,9 @@ var blockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
5353
* @example
5454
* var Complex64Array = require( '@stdlib/array/complex64' );
5555
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
56-
* var realf = require( '@stdlib/complex/float32/real' );
57-
* var imagf = require( '@stdlib/complex/float32/imag' );
5856
*
5957
* function scale( z ) {
60-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
58+
* return new Complex64( z.re*10.0, z.im*10.0 );
6159
* }
6260
*
6361
* // Create data buffers:
@@ -108,12 +106,7 @@ var blockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
108106
* blockedunary10d( x, y, scale );
109107
*
110108
* var v = y.data.get( 0 );
111-
*
112-
* var re = realf( v );
113-
* // returns 10.0
114-
*
115-
* var im = imagf( v );
116-
* // returns 20.0
109+
* // returns <Complex64>[ 10.0, 20.0 ]
117110
*/
118111
function blockedunary10d( x, y, fcn ) { // eslint-disable-line max-statements, max-lines-per-function
119112
var bsize;

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
* var imagf = require( '@stdlib/complex/float32/imag' );
5151
*
5252
* function scale( z ) {
53-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
53+
* return new Complex64( z.re*10.0, z.im*10.0 );
5454
* }
5555
*
5656
* // Create data buffers:
@@ -101,12 +101,7 @@
101101
* unary1d( x, y, scale );
102102
*
103103
* var v = y.data.get( 0 );
104-
*
105-
* var re = realf( v );
106-
* // returns 10.0
107-
*
108-
* var im = imagf( v );
109-
* // returns 20.0
104+
* // returns <Complex64>[ 10.0, 20.0 ]
110105
*/
111106
function unary1d( x, y, fcn ) {
112107
var xbuf;

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@
4747
* @example
4848
* var Complex64Array = require( '@stdlib/array/complex64' );
4949
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
50-
* var realf = require( '@stdlib/complex/float32/real' );
51-
* var imagf = require( '@stdlib/complex/float32/imag' );
5250
*
5351
* function scale( z ) {
54-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
52+
* return new Complex64( z.re*10.0, z.im*10.0 );
5553
* }
5654
*
5755
* // Create data buffers:
@@ -102,12 +100,7 @@
102100
* unary2d( x, y, true, scale );
103101
*
104102
* var v = y.data.get( 0 );
105-
*
106-
* var re = realf( v );
107-
* // returns 10.0
108-
*
109-
* var im = imagf( v );
110-
* // returns 20.0
103+
* // returns <Complex64>[ 10.0, 20.0 ]
111104
*/
112105
function unary2d( x, y, isRowMajor, fcn ) {
113106
var xbuf;

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,9 @@ var blockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
5151
* @example
5252
* var Complex64Array = require( '@stdlib/array/complex64' );
5353
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
54-
* var realf = require( '@stdlib/complex/float32/real' );
55-
* var imagf = require( '@stdlib/complex/float32/imag' );
5654
*
5755
* function scale( z ) {
58-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
56+
* return new Complex64( z.re*10.0, z.im*10.0 );
5957
* }
6058
*
6159
* // Create data buffers:
@@ -106,12 +104,7 @@ var blockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
106104
* blockedunary2d( x, y, scale );
107105
*
108106
* var v = y.data.get( 0 );
109-
*
110-
* var re = realf( v );
111-
* // returns 10.0
112-
*
113-
* var im = imagf( v );
114-
* // returns 20.0
107+
* // returns <Complex64>[ 10.0, 20.0 ]
115108
*/
116109
function blockedunary2d( x, y, fcn ) {
117110
var bsize;

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@
4747
* @example
4848
* var Complex64Array = require( '@stdlib/array/complex64' );
4949
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
50-
* var realf = require( '@stdlib/complex/float32/real' );
51-
* var imagf = require( '@stdlib/complex/float32/imag' );
5250
*
5351
* function scale( z ) {
54-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
52+
* return new Complex64( z.re*10.0, z.im*10.0 );
5553
* }
5654
*
5755
* // Create data buffers:
@@ -102,12 +100,7 @@
102100
* unary3d( x, y, true, scale );
103101
*
104102
* var v = y.data.get( 0 );
105-
*
106-
* var re = realf( v );
107-
* // returns 10.0
108-
*
109-
* var im = imagf( v );
110-
* // returns 20.0
103+
* // returns <Complex64>[ 10.0, 20.0 ]
111104
*/
112105
function unary3d( x, y, isRowMajor, fcn ) {
113106
var xbuf;

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,9 @@ var blockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
5353
* @example
5454
* var Complex64Array = require( '@stdlib/array/complex64' );
5555
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
56-
* var realf = require( '@stdlib/complex/float32/real' );
57-
* var imagf = require( '@stdlib/complex/float32/imag' );
5856
*
5957
* function scale( z ) {
60-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
58+
* return new Complex64( z.re*10.0, z.im*10.0 );
6159
* }
6260
*
6361
* // Create data buffers:
@@ -108,12 +106,7 @@ var blockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
108106
* blockedunary3d( x, y, scale );
109107
*
110108
* var v = y.data.get( 0 );
111-
*
112-
* var re = realf( v );
113-
* // returns 10.0
114-
*
115-
* var im = imagf( v );
116-
* // returns 20.0
109+
* // returns <Complex64>[ 10.0, 20.0 ]
117110
*/
118111
function blockedunary3d( x, y, fcn ) {
119112
var bsize;

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@
4747
* @example
4848
* var Complex64Array = require( '@stdlib/array/complex64' );
4949
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
50-
* var realf = require( '@stdlib/complex/float32/real' );
51-
* var imagf = require( '@stdlib/complex/float32/imag' );
5250
*
5351
* function scale( z ) {
54-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
52+
* return new Complex64( z.re*10.0, z.im*10.0 );
5553
* }
5654
*
5755
* // Create data buffers:
@@ -102,12 +100,7 @@
102100
* unary4d( x, y, true, scale );
103101
*
104102
* var v = y.data.get( 0 );
105-
*
106-
* var re = realf( v );
107-
* // returns 10.0
108-
*
109-
* var im = imagf( v );
110-
* // returns 20.0
103+
* // returns <Complex64>[ 10.0, 20.0 ]
111104
*/
112105
function unary4d( x, y, isRowMajor, fcn ) {
113106
var xbuf;

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,9 @@ var blockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
5353
* @example
5454
* var Complex64Array = require( '@stdlib/array/complex64' );
5555
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
56-
* var realf = require( '@stdlib/complex/float32/real' );
57-
* var imagf = require( '@stdlib/complex/float32/imag' );
5856
*
5957
* function scale( z ) {
60-
* return new Complex64( realf(z)*10.0, imagf(z)*10.0 );
58+
* return new Complex64( z.re*10.0, z.im*10.0 );
6159
* }
6260
*
6361
* // Create data buffers:
@@ -108,12 +106,7 @@ var blockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
108106
* blockedunary4d( x, y, scale );
109107
*
110108
* var v = y.data.get( 0 );
111-
*
112-
* var re = realf( v );
113-
* // returns 10.0
114-
*
115-
* var im = imagf( v );
116-
* // returns 20.0
109+
* // returns <Complex64>[ 10.0, 20.0 ]
117110
*/
118111
function blockedunary4d( x, y, fcn ) { // eslint-disable-line max-statements
119112
var bsize;

0 commit comments

Comments
 (0)