From 3c58261f7af87c2d97f7b48d30ce4d768b9b7a4f Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Wed, 6 May 2026 10:07:42 -0700 Subject: [PATCH] docs: improve doctests for complex number instances in `array/complex128` --- 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: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - 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: passed - task: lint_license_headers status: passed --- --- .../@stdlib/array/complex128/README.md | 373 ++---------------- .../@stdlib/array/complex128/docs/repl.txt | 75 +--- .../array/complex128/docs/types/index.d.ts | 353 ++--------------- .../@stdlib/array/complex128/lib/main.js | 328 +-------------- 4 files changed, 74 insertions(+), 1055 deletions(-) diff --git a/lib/node_modules/@stdlib/array/complex128/README.md b/lib/node_modules/@stdlib/array/complex128/README.md index f700318485c0..2e072d0a4839 100644 --- a/lib/node_modules/@stdlib/array/complex128/README.md +++ b/lib/node_modules/@stdlib/array/complex128/README.md @@ -1147,9 +1147,6 @@ var count = context.count; Returns an array element located at position (index) `i`. ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); - var arr = new Complex128Array( 10 ); // Set the first element: @@ -1157,13 +1154,7 @@ arr.set( [ 1.0, -1.0 ], 0 ); // Get the first element: var z = arr.get( 0 ); -// returns - -var re = real( z ); -// returns 1.0 - -var im = imag( z ); -// returns -1.0 +// returns [ 1.0, -1.0 ] ``` If provided an out-of-bounds index, the method returns `undefined`. @@ -1372,16 +1363,7 @@ arr.set( [ 2.0, -2.0 ], 1 ); arr.set( [ 3.0, -3.0 ], 2 ); var out = arr.map( scale ); -// returns - -var z = out.get( 0 ); -// returns - -var re = real( z ); -// returns 2.0 - -var im = imag( z ); -// returns -2.0 +// returns [ 2.0, -2.0, 4.0, -4.0, 6.0, -6.0 ] ``` The callback function is provided three arguments: @@ -1427,8 +1409,6 @@ var count = context.count; Applies a provided callback function to each element of the array, in order, passing in the return value from the calculation on the preceding element and returning the accumulated result upon completion. ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var cadd = require( '@stdlib/complex/float64/base/add' ); var arr = new Complex128Array( 3 ); @@ -1438,13 +1418,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, 3.0 ], 2 ); var z = arr.reduce( cadd ); -// returns - -var re = real( z ); -// returns 6.0 - -var im = imag( z ); -// returns 6.0 +// returns [ 6.0, 6.0 ] ``` The reducer function is provided four arguments: @@ -1481,8 +1455,6 @@ var z = arr.reduce( reducer, 0.0 ); Applies a provided callback function to each element of the array, in reverse order, passing in the return value from the calculation on the following element and returning the accumulated result upon completion. ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var cadd = require( '@stdlib/complex/float64/base/add' ); var arr = new Complex128Array( 3 ); @@ -1492,13 +1464,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, 3.0 ], 2 ); var z = arr.reduceRight( cadd ); -// returns - -var re = real( z ); -// returns 6.0 - -var im = imag( z ); -// returns 6.0 +// returns [ 6.0, 6.0 ] ``` The reducer function is provided four arguments: @@ -1535,9 +1501,6 @@ var z = arr.reduceRight( reducer, 0.0 ); Reverses an array in-place. ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); - var arr = new Complex128Array( 3 ); arr.set( [ 1.0, 1.0 ], 0 ); @@ -1545,34 +1508,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, 3.0 ], 2 ); var out = arr.reverse(); -// returns - -var z = out.get( 0 ); -// returns - -var re = real( z ); -// returns 3.0 - -var im = imag( z ); -// returns 3.0 - -z = out.get( 1 ); -// returns - -re = real( z ); -// returns 2.0 - -im = imag( z ); -// returns 2.0 - -z = out.get( 2 ); -// returns - -re = real( z ); -// returns 1.0 - -im = imag( z ); -// returns 1.0 +// returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] ``` @@ -1583,74 +1519,44 @@ Sets one or more array elements. ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var arr = new Complex128Array( 10 ); // Get the first element: var z = arr.get( 0 ); -// returns - -var re = real( z ); -// returns 0.0 - -var im = imag( z ); -// returns 0.0 +// returns [ 0.0, 0.0 ] // Set the first element: arr.set( new Complex128( 1.0, -1.0 ) ); // Get the first element: z = arr.get( 0 ); -// returns - -re = real( z ); -// returns 1.0 - -im = imag( z ); -// returns -1.0 +// returns [ 1.0, -1.0 ] ``` By default, the method sets array elements starting at position (index) `i = 0`. To set elements starting elsewhere in the array, provide an index argument `i`. ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var arr = new Complex128Array( 10 ); // Get the fifth element: var z = arr.get( 4 ); -// returns - -var re = real( z ); -// returns 0.0 - -var im = imag( z ); -// returns 0.0 +// returns [ 0.0, 0.0 ] // Set the fifth element: arr.set( new Complex128( 1.0, -1.0 ), 4 ); // Get the fifth element: z = arr.get( 4 ); -// returns - -re = real( z ); -// returns 1.0 - -im = imag( z ); -// returns -1.0 +// returns [ 1.0, -1.0 ] ``` In addition to providing a complex number, to set one or more array elements, provide an array-like object containing either complex numbers ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var arr = new Complex128Array( 10 ); @@ -1666,21 +1572,13 @@ arr.set( buf, 4 ); // Get the sixth element: var z = arr.get( 5 ); -// returns - -var re = real( z ); -// returns 2.0 - -var im = imag( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] ``` or interleaved real and imaginary components ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var arr = new Complex128Array( 10 ); @@ -1692,13 +1590,7 @@ arr.set( buf, 4 ); // Get the sixth element: var z = arr.get( 5 ); -// returns - -var re = real( z ); -// returns 2.0 - -var im = imag( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] ``` A few notes: @@ -1714,91 +1606,37 @@ A few notes: Copies a portion of a typed array to a new typed array. ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); - var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var out = arr.slice(); -// returns +// returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] var len = out.length; // returns 4 - -var z = out.get( 0 ); -// returns - -var re = real( z ); -// returns 1.0 - -var im = imag( z ); -// returns 2.0 - -z = out.get( len-1 ); -// returns - -re = real( z ); -// returns 7.0 - -im = imag( z ); -// returns 8.0 ``` By default, the method returns a typed array beginning with the first array element. To specify an alternative array index at which to begin, provide a `start` index (inclusive). ```javascript -var imag = require( '@stdlib/complex/float64/imag' ); -var real = require( '@stdlib/complex/float64/real' ); - var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var out = arr.slice( 1 ); -// returns +// returns [ 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] var len = out.length; // returns 3 - -var z = out.get( 0 ); -// returns - -var re = real( z ); -// returns 3.0 - -var im = imag( z ); -// returns 4.0 ``` By default, the method returns a typed array which includes all array elements after `start`. To limit the number of array elements after `start`, provide an `end` index (exclusive). ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); - var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var out = arr.slice( 1, -1 ); -// returns +// returns [ 3.0, 4.0, 5.0, 6.0 ] var len = out.length; // returns 2 - -var z = out.get( 0 ); -// returns - -var re = real( z ); -// returns 3.0 - -var im = imag( z ); -// returns 4.0 - -z = out.get( len-1 ); -// returns - -re = real( z ); -// returns 5.0 - -im = imag( z ); -// returns 6.0 ``` @@ -1903,34 +1741,7 @@ arr.set( [ 1.0, -1.0 ], 1 ); arr.set( [ 2.0, -2.0 ], 2 ); var out = arr.sort( compare ); -// returns - -var z = out.get( 0 ); -// returns - -var re = real( z ); -// returns 1.0 - -var im = imag( z ); -// returns -1.0 - -z = out.get( 1 ); -// returns - -re = real( z ); -// returns 2.0 - -im = imag( z ); -// returns -2.0 - -z = out.get( 2 ); -// returns - -re = real( z ); -// returns 3.0 - -im = imag( z ); -// returns -3.0 +// returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] ``` The `compareFcn` determines the order of the elements. The function is called with the following arguments: @@ -1953,91 +1764,37 @@ In contrast to real numbers, one cannot define a default order relation which is Creates a new typed array view over the same underlying [`ArrayBuffer`][@stdlib/array/buffer] and with the same underlying data type as the host array. ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); - var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var subarr = arr.subarray(); -// returns +// returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] var len = subarr.length; // returns 4 - -var z = subarr.get( 0 ); -// returns - -var re = real( z ); -// returns 1.0 - -var im = imag( z ); -// returns 2.0 - -z = subarr.get( len-1 ); -// returns - -re = real( z ); -// returns 7.0 - -im = imag( z ); -// returns 8.0 ``` By default, the method creates a typed array view beginning with the first array element. To specify an alternative array index at which to begin, provide a `begin` index (inclusive). ```javascript -var imag = require( '@stdlib/complex/float64/imag' ); -var real = require( '@stdlib/complex/float64/real' ); - var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var subarr = arr.subarray( 1 ); -// returns +// returns [ 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] var len = subarr.length; // returns 3 - -var z = subarr.get( 0 ); -// returns - -var re = real( z ); -// returns 3.0 - -var im = imag( z ); -// returns 4.0 ``` By default, the method creates a typed array view which includes all array elements after `begin`. To limit the number of array elements after `begin`, provide an `end` index (exclusive). ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); - var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var subarr = arr.subarray( 1, -1 ); -// returns +// returns [ 3.0, 4.0, 5.0, 6.0 ] var len = subarr.length; // returns 2 - -var z = subarr.get( 0 ); -// returns - -var re = real( z ); -// returns 3.0 - -var im = imag( z ); -// returns 4.0 - -z = subarr.get( len-1 ); -// returns - -re = real( z ); -// returns 5.0 - -im = imag( z ); -// returns 6.0 ``` @@ -2068,9 +1825,6 @@ The method supports the following arguments: Returns a new typed array containing the elements in reversed order. ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); - var arr = new Complex128Array( 3 ); arr.set( [ 1.0, 1.0 ], 0 ); @@ -2078,34 +1832,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, 3.0 ], 2 ); var out = arr.toReversed(); -// returns - -var z = out.get( 0 ); -// returns - -var re = real( z ); -// returns 3.0 - -var im = imag( z ); -// returns 3.0 - -z = out.get( 1 ); -// returns - -re = real( z ); -// returns 2.0 - -im = imag( z ); -// returns 2.0 - -z = out.get( 2 ); -// returns - -re = real( z ); -// returns 1.0 - -im = imag( z ); -// returns 1.0 +// returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] ``` @@ -2149,34 +1876,7 @@ arr.set( [ 1.0, -1.0 ], 1 ); arr.set( [ 2.0, -2.0 ], 2 ); var out = arr.toSorted( compare ); -// returns - -var z = out.get( 0 ); -// returns - -var re = real( z ); -// returns 1.0 - -var im = imag( z ); -// returns -1.0 - -z = out.get( 1 ); -// returns - -re = real( z ); -// returns 2.0 - -im = imag( z ); -// returns -2.0 - -z = out.get( 2 ); -// returns - -re = real( z ); -// returns 3.0 - -im = imag( z ); -// returns -3.0 +// returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] ``` The `compareFcn` determines the order of the elements. The function is called with the following arguments: @@ -2216,8 +1916,6 @@ var str = arr.toString(); Returns an iterator for iterating over each value in a typed array. ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var arr = new Complex128Array( 2 ); arr.set( [ 1.0, -1.0 ], 0 ); @@ -2226,22 +1924,10 @@ arr.set( [ 2.0, -2.0 ], 1 ); var iter = arr.values(); var v = iter.next().value; -// returns - -var re = real( v ); -// returns 1.0 - -var im = imag( v ); -// returns -1.0 +// returns [ 1.0, -1.0 ] v = iter.next().value; -// returns - -re = real( v ); -// returns 2.0 - -im = imag( v ); -// returns -2.0 +// returns [ 2.0, -2.0 ] var bool = iter.next().done; // returns true @@ -2259,27 +1945,16 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the Returns a new typed array with the element at a provided index replaced with a provided value. ```javascript -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); var arr = new Complex128Array( 3 ); arr.set( [ 1.0, 1.0 ], 0 ); arr.set( [ 2.0, 2.0 ], 1 ); -arr.set( [ 3.0, 3.0 ], 1 ); +arr.set( [ 3.0, 3.0 ], 2 ); var out = arr.with( 0, new Complex128( 4.0, 4.0 ) ); -// returns - -var z = out.get( 0 ); -// returns - -var re = real( z ); -// returns 4.0 - -var im = imag( z ); -// returns 4.0 +// returns [ 4.0, 4.0, 2.0, 2.0, 3.0, 3.0 ] ``` diff --git a/lib/node_modules/@stdlib/array/complex128/docs/repl.txt b/lib/node_modules/@stdlib/array/complex128/docs/repl.txt index ef7ad30e5ce7..f695ae09dc4e 100644 --- a/lib/node_modules/@stdlib/array/complex128/docs/repl.txt +++ b/lib/node_modules/@stdlib/array/complex128/docs/repl.txt @@ -1105,21 +1105,9 @@ > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] ) > var out = arr.subarray( 1, 3 ) - + [ 2.0, -2.0, 3.0, -3.0 ] > var len = out.length 2 - > var z = out.get( 0 ) - - > var re = {{alias:@stdlib/complex/float64/real}}( z ) - 2.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - -2.0 - > z = out.get( 1 ) - - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 3.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - -3.0 {{alias}}.prototype.toLocaleString( [locales[, options]] ) @@ -1159,25 +1147,7 @@ > var arr = new {{alias}}( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ) > var out = arr.toReversed() - - > var z = out.get( 0 ) - - > var re = {{alias:@stdlib/complex/float64/real}}( z ) - 3.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - 3.0 - > z = out.get( 1 ) - - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 2.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 2.0 - > z = out.get( 2 ) - - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 1.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - 1.0 + [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] {{alias}}.prototype.toSorted( compareFcn ) @@ -1208,25 +1178,8 @@ > function compare( a, b ) { return ( {{alias:@stdlib/complex/float64/real}}( a ) - {{alias:@stdlib/complex/float64/real}}( b ) ); }; > var arr = new {{alias}}( [ 2.0, -2.0, 3.0, -3.0, 1.0, -1.0 ] ) - > var out = arr.toSorted( compare ); - > var z = out.get( 0 ) - - > var re = {{alias:@stdlib/complex/float64/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - -1.0 - > z = out.get( 1 ) - - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 2.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - -2.0 - > z = out.get( 2 ) - - > re = {{alias:@stdlib/complex/float64/real}}( z ) - 3.0 - > im = {{alias:@stdlib/complex/float64/imag}}( z ) - -3.0 + > var out = arr.toSorted( compare ) + [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] {{alias}}.prototype.toString() @@ -1259,17 +1212,9 @@ > var it = arr.values(); > var v = it.next().value - - > var re = {{alias:@stdlib/complex/float64/real}}( v ) - 1.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( v ) - -1.0 + [ 1.0, -1.0 ] > v = it.next().value - - > re = {{alias:@stdlib/complex/float64/real}}( v ) - 2.0 - > im = {{alias:@stdlib/complex/float64/imag}}( v ) - -2.0 + [ 2.0, -2.0 ] > var bool = it.next().done true @@ -1296,13 +1241,7 @@ > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] ) > var out = arr.with( 1, new {{alias:@stdlib/complex/float32/ctor}}( 3.0, -3.0 ) ) - - > var z = out.get( 1 ) - - > var re = {{alias:@stdlib/complex/float64/real}}( z ) - 3.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( z ) - -3.0 + [ 1.0, -1.0, 3.0, -3.0 ] See Also diff --git a/lib/node_modules/@stdlib/array/complex128/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/complex128/docs/types/index.d.ts index 32195acf38f2..3fefa3cdcdb2 100644 --- a/lib/node_modules/@stdlib/array/complex128/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/complex128/docs/types/index.d.ts @@ -352,13 +352,13 @@ declare class Complex128Array implements Complex128ArrayInterface { * var arr = new Complex128Array( 10 ); * * var z = arr.at( 0 ); - * // returns + * // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * arr.set( [ 9.0, -9.0 ], 9 ); * * z = arr.at( -1 ); - * // returns + * // returns [ 9.0, -9.0 ] * * z = arr.at( 100 ); * // returns undefined @@ -526,30 +526,15 @@ declare class Complex128Array implements Complex128ArrayInterface { * @returns modified typed array * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); - * * var arr = new Complex128Array( 3 ); * * arr.fill( new Complex128( 1.0, 1.0 ), 1 ); * * var z = arr.get( 1 ); - * // returns - * - * var re = real( z ); - * // returns 1.0 - * - * var im = imag( z ); - * // returns 1.0 + * // returns [ 1.0, 1.0 ] * * z = arr.get( 2 ); - * // returns - * - * re = real( z ); - * // returns 1.0 - * - * im = imag( z ); - * // returns 1.0 + * // returns [ 1.0, 1.0 ] */ fill( value: ComplexLike, start?: number, end?: number ): Complex128Array; @@ -575,19 +560,10 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 3.0, -3.0 ], 2 ); * * var out = arr.filter( predicate ); - * // returns + * // returns [ 2.0, 2.0 ] * * var len = out.length; * // returns 1 - * - * var z = out.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 2.0 - * - * var im = imag( z ); - * // returns 2.0 */ filter( predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; @@ -613,13 +589,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.find( predicate ); - * // returns - * - * var re = real( z ); - * // returns 1.0 - * - * var im = imag( z ); - * // returns 1.0 + * // returns [ 1.0, 1.0 ] */ find( predicate: Predicate, thisArg?: ThisParameterType> ): Complex128 | void; @@ -671,13 +641,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.findLast( predicate ); - * // returns - * - * var re = real( z ); - * // returns 3.0 - * - * var im = imag( z ); - * // returns 3.0 + * // returns [ 3.0, 3.0 ] */ findLast( predicate: Predicate, thisArg?: ThisParameterType> ): Complex128 | void; @@ -742,7 +706,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * var arr = new Complex128Array( 10 ); * * var z = arr.get( 0 ); - * // returns + * // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * @@ -903,16 +867,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 3.0, -3.0 ], 2 ); * * var out = arr.map( scale ); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 2.0 - * - * var im = imag( z ); - * // returns -2.0 + * // returns [ 2.0, -2.0, 4.0, -4.0, 6.0, -6.0 ] */ map( fcn: MapFcn, thisArg?: ThisParameterType> ): Complex128Array; @@ -924,8 +879,6 @@ declare class Complex128Array implements Complex128ArrayInterface { * @returns accumulated result * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * var cadd = require( '@stdlib/complex/float64/base/add' ); * * var arr = new Complex128Array( 3 ); @@ -935,13 +888,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.reduce( cadd ); - * // returns - * - * var re = real( z ); - * // returns 6.0 - * - * var im = imag( z ); - * // returns 6.0 + * // returns [ 6.0, 6.0 ] */ reduce( reducer: Reducer, initialValue?: U ): U; @@ -953,8 +900,6 @@ declare class Complex128Array implements Complex128ArrayInterface { * @returns accumulated result * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * var cadd = require( '@stdlib/complex/float64/base/add' ); * * var arr = new Complex128Array( 3 ); @@ -964,13 +909,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.reduceRight( cadd ); - * // returns - * - * var re = real( z ); - * // returns 6.0 - * - * var im = imag( z ); - * // returns 6.0 + * // returns [ 6.0, 6.0 ] */ reduceRight( reducer: Reducer, initialValue?: U ): U; @@ -980,9 +919,6 @@ declare class Complex128Array implements Complex128ArrayInterface { * @returns reversed array * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); - * * var arr = new Complex128Array( 3 ); * * arr.set( [ 1.0, 1.0 ], 0 ); @@ -990,34 +926,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.reverse(); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 3.0 - * - * var im = imag( z ); - * // returns 3.0 - * - * z = out.get( 1 ); - * // returns - * - * re = real( z ); - * // returns 2.0 - * - * im = imag( z ); - * // returns 2.0 - * - * z = out.get( 2 ); - * // returns - * - * re = real( z ); - * // returns 1.0 - * - * im = imag( z ); - * // returns 1.0 + * // returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] */ reverse(): Complex128Array; @@ -1053,30 +962,15 @@ declare class Complex128Array implements Complex128ArrayInterface { * @throws target array lacks sufficient storage to accommodate source values * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); - * * var arr = new Complex128Array( 10 ); * * var z = arr.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 0.0 - * - * var im = imag( z ); - * // returns 0.0 + * // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * * z = arr.get( 0 ); - * // returns - * - * re = real( z ); - * // returns 1.0 - * - * im = imag( z ); - * // returns -1.0 + * // returns [ 1.0, -1.0 ] */ set( value: ArrayLike | RealOrComplexTypedArray | ComplexLike, i?: number ): void; @@ -1089,9 +983,6 @@ declare class Complex128Array implements Complex128ArrayInterface { * @returns output array * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); - * * var arr = new Complex128Array( 5 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -1101,52 +992,10 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 5.0, -5.0 ], 4 ); * * var out = arr.slice(); - * // returns - * - * var len = out.length; - * // returns 5 - * - * var z = out.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 1.0 - * - * var im = imag( z ); - * // returns -1.0 - * - * z = out.get( len-1 ); - * // returns - * - * re = real( z ); - * // returns 5.0 - * - * im = imag( z ); - * // returns -5.0 + * // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0, 5.0, -5.0 ] * * out = arr.slice( 1, -2 ); - * // returns - * - * len = out.length; - * // returns 2 - * - * z = out.get( 0 ); - * // returns - * - * re = real( z ); - * // returns 2.0 - * - * im = imag( z ); - * // returns -2.0 - * - * z = out.get( len-1 ); - * // returns - * - * re = real( z ); - * // returns 3.0 - * - * im = imag( z ); - * // returns -3.0 + * // returns [ 2.0, -2.0, 3.0, -3.0 ] */ slice( start?: number, end?: number ): Complex128Array; @@ -1217,34 +1066,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 2.0, -2.0 ], 2 ); * * var out = arr.sort( compare ); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 1.0 - * - * var im = imag( z ); - * // returns -1.0 - * - * z = out.get( 1 ); - * // returns - * - * re = real( z ); - * // returns 2.0 - * - * im = imag( z ); - * // returns -2.0 - * - * z = out.get( 2 ); - * // returns - * - * re = real( z ); - * // returns 3.0 - * - * im = imag( z ); - * // returns -3.0 + * // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] */ sort( compareFcn: CompareFcn ): Complex128Array; @@ -1257,9 +1079,6 @@ declare class Complex128Array implements Complex128ArrayInterface { * @returns subarray * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); - * * var arr = new Complex128Array( 5 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -1269,52 +1088,10 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 5.0, -5.0 ], 4 ); * * var subarr = arr.subarray(); - * // returns - * - * var len = subarr.length; - * // returns 5 - * - * var z = subarr.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 1.0 - * - * var im = imag( z ); - * // returns -1.0 - * - * z = subarr.get( len-1 ); - * // returns - * - * re = real( z ); - * // returns 5.0 - * - * im = imag( z ); - * // returns -5.0 + * // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0, 5.0, -5.0 ] * * subarr = arr.subarray( 1, -2 ); - * // returns - * - * len = subarr.length; - * // returns 2 - * - * z = subarr.get( 0 ); - * // returns - * - * re = real( z ); - * // returns 2.0 - * - * im = imag( z ); - * // returns -2.0 - * - * z = subarr.get( len-1 ); - * // returns - * - * re = real( z ); - * // returns 3.0 - * - * im = imag( z ); - * // returns -3.0 + * // returns [ 2.0, -2.0, 3.0, -3.0 ] */ subarray( begin?: number, end?: number ): Complex128Array; @@ -1342,9 +1119,6 @@ declare class Complex128Array implements Complex128ArrayInterface { * @returns reversed array * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); - * * var arr = new Complex128Array( 3 ); * * arr.set( [ 1.0, 1.0 ], 0 ); @@ -1352,34 +1126,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.toReversed(); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 3.0 - * - * var im = imag( z ); - * // returns 3.0 - * - * z = out.get( 1 ); - * // returns - * - * re = real( z ); - * // returns 2.0 - * - * im = imag( z ); - * // returns 2.0 - * - * z = out.get( 2 ); - * // returns - * - * re = real( z ); - * // returns 1.0 - * - * im = imag( z ); - * // returns 1.0 + * // returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] */ toReversed(): Complex128Array; @@ -1424,34 +1171,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 2.0, -2.0 ], 2 ); * * var out = arr.toSorted( compare ); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 1.0 - * - * var im = imag( z ); - * // returns -1.0 - * - * z = out.get( 1 ); - * // returns - * - * re = real( z ); - * // returns 2.0 - * - * im = imag( z ); - * // returns -2.0 - * - * z = out.get( 2 ); - * // returns - * - * re = real( z ); - * // returns 3.0 - * - * im = imag( z ); - * // returns -3.0 + * // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] */ toSorted( compareFcn: CompareFcn ): Complex128Array; @@ -1477,8 +1197,6 @@ declare class Complex128Array implements Complex128ArrayInterface { * @returns iterator * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * var arr = new Complex128Array( 2 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -1487,22 +1205,10 @@ declare class Complex128Array implements Complex128ArrayInterface { * var iter = arr.values(); * * var v = iter.next().value; - * // returns - * - * var re = real( v ); - * // returns 1.0 - * - * var im = imag( v ); - * // returns -1.0 + * // returns [ 1.0, -1.0 ] * * v = iter.next().value; - * // returns - * - * re = real( v ); - * // returns 2.0 - * - * im = imag( v ); - * // returns -2.0 + * // returns [ 2.0, -2.0 ] * * var bool = iter.next().done; * // returns true @@ -1520,8 +1226,6 @@ declare class Complex128Array implements Complex128ArrayInterface { * @returns modified typed array * * @example - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * * var arr = new Complex128Array( 3 ); @@ -1531,16 +1235,7 @@ declare class Complex128Array implements Complex128ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.with( 0, new Complex128( 4.0, 4.0 ) ); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = real( z ); - * // returns 4.0 - * - * var im = imag( z ); - * // returns 4.0 + * // returns [ 4.0, 4.0, 2.0, 2.0, 3.0, 3.0 ] */ with( index: number, value: ComplexLike ): Complex128Array; } diff --git a/lib/node_modules/@stdlib/array/complex128/lib/main.js b/lib/node_modules/@stdlib/array/complex128/lib/main.js index 49bd1f0ac59c..0addc527f7d2 100644 --- a/lib/node_modules/@stdlib/array/complex128/lib/main.js +++ b/lib/node_modules/@stdlib/array/complex128/lib/main.js @@ -1121,13 +1121,7 @@ setReadOnly( Complex128Array.prototype, 'findIndex', function findIndex( predica * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.findLast( predicate ); -* // returns -* -* var re = real( z ); -* // returns 3.0 -* -* var im = imag( z ); -* // returns 3.0 +* // returns [ 3.0, 3.0 ] */ setReadOnly( Complex128Array.prototype, 'findLast', function findLast( predicate, thisArg ) { var buf; @@ -1253,28 +1247,14 @@ setReadOnly( Complex128Array.prototype, 'forEach', function forEach( fcn, thisAr * * @example * var arr = new Complex128Array( 10 ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var z = arr.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 0.0 -* -* var im = imag( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * * z = arr.get( 0 ); -* // returns -* -* re = real( z ); -* // returns 1.0 -* -* im = imag( z ); -* // returns -1.0 +* // returns [ 1.0, -1.0 ] * * z = arr.get( 100 ); * // returns undefined @@ -1697,16 +1677,7 @@ setReadOnly( Complex128Array.prototype, 'lastIndexOf', function lastIndexOf( sea * arr.set( [ 3.0, -3.0 ], 2 ); * * var out = arr.map( scale ); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 2.0 -* -* var im = imag( z ); -* // returns -2.0 +* // returns [ 2.0, -2.0, 4.0, -4.0, 6.0, -6.0 ] */ setReadOnly( Complex128Array.prototype, 'map', function map( fcn, thisArg ) { var outbuf; @@ -1752,8 +1723,6 @@ setReadOnly( Complex128Array.prototype, 'map', function map( fcn, thisArg ) { * @returns {*} accumulated result * * @example -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var cadd = require( '@stdlib/complex/float64/base/add' ); * * var arr = new Complex128Array( 3 ); @@ -1763,13 +1732,7 @@ setReadOnly( Complex128Array.prototype, 'map', function map( fcn, thisArg ) { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.reduce( cadd ); -* // returns -* -* var re = real( z ); -* // returns 6.0 -* -* var im = imag( z ); -* // returns 6.0 +* // returns [ 6.0, 6.0 ] */ setReadOnly( Complex128Array.prototype, 'reduce', function reduce( reducer, initialValue ) { var buf; @@ -1817,8 +1780,6 @@ setReadOnly( Complex128Array.prototype, 'reduce', function reduce( reducer, init * @returns {*} accumulated result * * @example -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var cadd = require( '@stdlib/complex/float64/base/add' ); * * var arr = new Complex128Array( 3 ); @@ -1828,13 +1789,7 @@ setReadOnly( Complex128Array.prototype, 'reduce', function reduce( reducer, init * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.reduceRight( cadd ); -* // returns -* -* var re = real( z ); -* // returns 6.0 -* -* var im = imag( z ); -* // returns 6.0 +* // returns [ 6.0, 6.0 ] */ setReadOnly( Complex128Array.prototype, 'reduceRight', function reduceRight( reducer, initialValue ) { var buf; @@ -1878,9 +1833,6 @@ setReadOnly( Complex128Array.prototype, 'reduceRight', function reduceRight( red * @returns {Complex128Array} reversed array * * @example -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); -* * var arr = new Complex128Array( 3 ); * * arr.set( [ 1.0, 1.0 ], 0 ); @@ -1888,34 +1840,7 @@ setReadOnly( Complex128Array.prototype, 'reduceRight', function reduceRight( red * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.reverse(); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 3.0 -* -* var im = imag( z ); -* // returns 3.0 -* -* z = out.get( 1 ); -* // returns -* -* re = real( z ); -* // returns 2.0 -* -* im = imag( z ); -* // returns 2.0 -* -* z = out.get( 2 ); -* // returns -* -* re = real( z ); -* // returns 1.0 -* -* im = imag( z ); -* // returns 1.0 +* // returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] */ setReadOnly( Complex128Array.prototype, 'reverse', function reverse() { var buf; @@ -1979,30 +1904,15 @@ setReadOnly( Complex128Array.prototype, 'reverse', function reverse() { * @returns {void} * * @example -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); -* * var arr = new Complex128Array( 10 ); * * var z = arr.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 0.0 -* -* var im = imag( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * * z = arr.get( 0 ); -* // returns -* -* re = real( z ); -* // returns 1.0 -* -* im = imag( z ); -* // returns -1.0 +* // returns [ 1.0, -1.0 ] */ setReadOnly( Complex128Array.prototype, 'set', function set( value ) { /* eslint-disable no-underscore-dangle */ @@ -2147,9 +2057,6 @@ setReadOnly( Complex128Array.prototype, 'set', function set( value ) { * @returns {Complex128Array} complex number array * * @example -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); -* * var arr = new Complex128Array( 5 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -2159,52 +2066,10 @@ setReadOnly( Complex128Array.prototype, 'set', function set( value ) { * arr.set( [ 5.0, -5.0 ], 4 ); * * var out = arr.slice(); -* // returns -* -* var len = out.length; -* // returns 5 -* -* var z = out.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 1.0 -* -* var im = imag( z ); -* // returns -1.0 -* -* z = out.get( len-1 ); -* // returns -* -* re = real( z ); -* // returns 5.0 -* -* im = imag( z ); -* // returns -5.0 +* // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0, 5.0, -5.0 ] * * out = arr.slice( 1, -2 ); -* // returns -* -* len = out.length; -* // returns 2 -* -* z = out.get( 0 ); -* // returns -* -* re = real( z ); -* // returns 2.0 -* -* im = imag( z ); -* // returns -2.0 -* -* z = out.get( len-1 ); -* // returns -* -* re = real( z ); -* // returns 3.0 -* -* im = imag( z ); -* // returns -3.0 +* // returns [ 2.0, -2.0, 3.0, -3.0 ] */ setReadOnly( Complex128Array.prototype, 'slice', function slice( start, end ) { var outlen; @@ -2356,34 +2221,7 @@ setReadOnly( Complex128Array.prototype, 'some', function some( predicate, thisAr * arr.set( [ 2.0, -2.0 ], 2 ); * * var out = arr.sort( compare ); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 1.0 -* -* var im = imag( z ); -* // returns -1.0 -* -* z = out.get( 1 ); -* // returns -* -* re = real( z ); -* // returns 2.0 -* -* im = imag( z ); -* // returns -2.0 -* -* z = out.get( 2 ); -* // returns -* -* re = real( z ); -* // returns 3.0 -* -* im = imag( z ); -* // returns -3.0 +* // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] */ setReadOnly( Complex128Array.prototype, 'sort', function sort( compareFcn ) { var tmp; @@ -2426,9 +2264,6 @@ setReadOnly( Complex128Array.prototype, 'sort', function sort( compareFcn ) { * @returns {Complex64Array} subarray * * @example -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); -* * var arr = new Complex128Array( 5 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -2438,52 +2273,10 @@ setReadOnly( Complex128Array.prototype, 'sort', function sort( compareFcn ) { * arr.set( [ 5.0, -5.0 ], 4 ); * * var subarr = arr.subarray(); -* // returns -* -* var len = subarr.length; -* // returns 5 -* -* var z = subarr.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 1.0 -* -* var im = imag( z ); -* // returns -1.0 -* -* z = subarr.get( len-1 ); -* // returns -* -* re = real( z ); -* // returns 5.0 -* -* im = imag( z ); -* // returns -5.0 +* // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0, 5.0, -5.0 ] * * subarr = arr.subarray( 1, -2 ); -* // returns -* -* len = subarr.length; -* // returns 2 -* -* z = subarr.get( 0 ); -* // returns -* -* re = real( z ); -* // returns 2.0 -* -* im = imag( z ); -* // returns -2.0 -* -* z = subarr.get( len-1 ); -* // returns -* -* re = real( z ); -* // returns 3.0 -* -* im = imag( z ); -* // returns -3.0 +* // returns [ 2.0, -2.0, 3.0, -3.0 ] */ setReadOnly( Complex128Array.prototype, 'subarray', function subarray( begin, end ) { var offset; @@ -2599,9 +2392,6 @@ setReadOnly( Complex128Array.prototype, 'toLocaleString', function toLocaleStrin * @returns {Complex128Array} reversed array * * @example -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); -* * var arr = new Complex128Array( 3 ); * * arr.set( [ 1.0, 1.0 ], 0 ); @@ -2609,34 +2399,7 @@ setReadOnly( Complex128Array.prototype, 'toLocaleString', function toLocaleStrin * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.toReversed(); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 3.0 -* -* var im = imag( z ); -* // returns 3.0 -* -* z = out.get( 1 ); -* // returns -* -* re = real( z ); -* // returns 2.0 -* -* im = imag( z ); -* // returns 2.0 -* -* z = out.get( 2 ); -* // returns -* -* re = real( z ); -* // returns 1.0 -* -* im = imag( z ); -* // returns 1.0 +* // returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] */ setReadOnly( Complex128Array.prototype, 'toReversed', function toReversed() { var outbuf; @@ -2706,34 +2469,7 @@ setReadOnly( Complex128Array.prototype, 'toReversed', function toReversed() { * arr.set( [ 2.0, -2.0 ], 2 ); * * var out = arr.sort( compare ); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 1.0 -* -* var im = imag( z ); -* // returns -1.0 -* -* z = out.get( 1 ); -* // returns -* -* re = real( z ); -* // returns 2.0 -* -* im = imag( z ); -* // returns -2.0 -* -* z = out.get( 2 ); -* // returns -* -* re = real( z ); -* // returns 3.0 -* -* im = imag( z ); -* // returns -3.0 +* // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] */ setReadOnly( Complex128Array.prototype, 'toSorted', function toSorted( compareFcn ) { var tmp; @@ -2799,9 +2535,6 @@ setReadOnly( Complex128Array.prototype, 'toString', function toString() { * @returns {Iterator} iterator * * @example -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); -* * var arr = new Complex128Array( 2 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -2810,22 +2543,10 @@ setReadOnly( Complex128Array.prototype, 'toString', function toString() { * var iter = arr.values(); * * var v = iter.next().value; -* // returns -* -* var re = real( v ); -* // returns 1.0 -* -* var im = imag( v ); -* // returns -1.0 +* // returns [ 1.0, -1.0 ] * * v = iter.next().value; -* // returns -* -* re = real( v ); -* // returns 2.0 -* -* im = imag( v ); -* // returns -2.0 +* // returns [ 2.0, -2.0 ] * * var bool = iter.next().done; * // returns true @@ -2922,8 +2643,6 @@ setReadOnly( Complex128Array.prototype, 'values', function values() { * @returns {Complex128Array} new typed array * * @example -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * * var arr = new Complex128Array( 3 ); @@ -2933,16 +2652,7 @@ setReadOnly( Complex128Array.prototype, 'values', function values() { * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.with( 0, new Complex128( 4.0, 4.0 ) ); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = real( z ); -* // returns 4.0 -* -* var im = imag( z ); -* // returns 4.0 +* // returns [ 4.0, 4.0, 2.0, 2.0, 3.0, 3.0 ] */ setReadOnly( Complex128Array.prototype, 'with', function copyWith( index, value ) { var buf;