From ecad6bf4e6fb22092531d48ddc213fd439b8b761 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Wed, 6 May 2026 09:52:03 -0700 Subject: [PATCH] docs: improve doctests for complex number instances in `array/complex64` --- 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/complex64/README.md | 671 ++---------------- .../@stdlib/array/complex64/docs/repl.txt | 345 +++------ .../array/complex64/docs/types/index.d.ts | 344 +-------- .../@stdlib/array/complex64/lib/main.js | 402 +---------- 4 files changed, 206 insertions(+), 1556 deletions(-) diff --git a/lib/node_modules/@stdlib/array/complex64/README.md b/lib/node_modules/@stdlib/array/complex64/README.md index d0a652b7aa03..f9dcd1f979ce 100644 --- a/lib/node_modules/@stdlib/array/complex64/README.md +++ b/lib/node_modules/@stdlib/array/complex64/README.md @@ -282,14 +282,10 @@ The iterator returned by an iterable must return either a complex number or an a ```javascript var ITERATOR_SYMBOL = require( '@stdlib/symbol/iterator' ); var Float32Array = require( '@stdlib/array/float32' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var iter; var arr; var len; -var re; -var im; var z; // Define a function which returns an iterator protocol-compliant object... @@ -331,13 +327,7 @@ if ( ITERATOR_SYMBOL === null ) { // returns 2 z = arr.get( 0 ); - // returns - - re = realf( z ); - // returns 1.0 - - im = imagf( z ); - // returns -1.0 + // returns [ 1.0, -1.0 ] } ``` @@ -363,13 +353,7 @@ var len = arr.length; // returns 1 var z = arr.get( 0 ); -// returns - -var re = realf( z ); -// returns 2.0 - -var im = imagf( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] ``` or an array-like object containing real and imaginary components @@ -403,22 +387,10 @@ var len = arr.length; // returns 2 var z = arr.get( 0 ); -// returns - -var re = realf( z ); -// returns 2.0 - -var im = imagf( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] z = arr.get( 1 ); -// returns - -re = realf( z ); -// returns 4.0 - -im = imagf( z ); -// returns -4.0 +// returns [ 4.0, -4.0 ] ``` If `src` is an array-like object containing interleaved real and imaginary components, the callback is invoked for each component and should return the transformed component value. @@ -426,8 +398,6 @@ If `src` is an array-like object containing interleaved real and imaginary compo ```javascript var Float32Array = require( '@stdlib/array/float32' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); function map( v ) { return v * 2.0; @@ -444,13 +414,7 @@ var len = arr.length; // returns 1 var z = arr.get( 0 ); -// returns - -var re = realf( z ); -// returns 2.0 - -var im = imagf( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] ``` A callback function is provided two arguments: @@ -521,9 +485,6 @@ len = arr.length; Returns an array element located at integer position (index) `i`, with support for both nonnegative and negative integer positions. ```javascript -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); - var arr = new Complex64Array( 10 ); // Set the first, second, and last elements: @@ -533,23 +494,11 @@ arr.set( [ 9.0, -9.0 ], 9 ); // Get the first element: var z = arr.at( 0 ); -// returns - -var re = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns -1.0 +// returns [ 1.0, -1.0 ] // Get the last element: z = arr.at( -1 ); -// returns - -re = realf( z ); -// returns 9.0 - -im = imagf( z ); -// returns -9.0 +// returns [ 9.0, -9.0 ] ``` If provided an out-of-bounds index, the method returns `undefined`. @@ -572,8 +521,6 @@ Copies a sequence of elements within the array starting at `start` and ending at ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 4 ); @@ -585,54 +532,28 @@ arr.set( new Complex64( 4.0, -4.0 ), 3 ); // Get the first array element: var z = arr.get( 0 ); -// returns - -var re = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns -1.0 +// returns [ 1.0, -1.0 ] // Get the second array element: z = arr.get( 1 ); -// returns - -re = realf( z ); -// returns 2.0 - -im = imagf( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] // Copy the last two elements to the first two elements: arr.copyWithin( 0, 2 ); // Get the first array element: z = arr.get( 0 ); -// returns - -re = realf( z ); -// returns 3.0 - -im = imagf( z ); -// returns -3.0 +// returns [ 3.0, -3.0 ] // Get the second array element: z = arr.get( 1 ); -// returns - -re = realf( z ); -// returns 4.0 - -im = imagf( z ); -// returns -4.0 +// returns [ 4.0, -4.0 ] ``` By default, `end` equals the number of array elements (i.e., one more than the last array index). To limit the sequence length, provide an `end` argument. ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 4 ); @@ -644,54 +565,28 @@ arr.set( new Complex64( 4.0, -4.0 ), 3 ); // Get the third array element: var z = arr.get( 2 ); -// returns - -var re = realf( z ); -// returns 3.0 - -var im = imagf( z ); -// returns -3.0 +// returns [ 3.0, -3.0 ] // Get the last array element: z = arr.get( 3 ); -// returns - -re = realf( z ); -// returns 4.0 - -im = imagf( z ); -// returns -4.0 +// returns [ 4.0, -4.0 ] // Copy the first two elements to the last two elements: arr.copyWithin( 2, 0, 2 ); // Get the third array element: z = arr.get( 2 ); -// returns - -re = realf( z ); -// returns 1.0 - -im = imagf( z ); -// returns -1.0 +// returns [ 1.0, -1.0 ] // Get the last array element: z = arr.get( 3 ); -// returns - -re = realf( z ); -// returns 2.0 - -im = imagf( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] ``` When a `target`, `start`, and/or `end` index is negative, the respective index is determined relative to the last array element. The following example achieves the same behavior as the previous example: ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 4 ); @@ -703,46 +598,22 @@ arr.set( new Complex64( 4.0, -4.0 ), 3 ); // Get the third array element: var z = arr.get( 2 ); -// returns - -var re = realf( z ); -// returns 3.0 - -var im = imagf( z ); -// returns -3.0 +// returns [ 3.0, -3.0 ] // Get the last array element: z = arr.get( 3 ); -// returns - -re = realf( z ); -// returns 4.0 - -im = imagf( z ); -// returns -4.0 +// returns [ 4.0, -4.0 ] // Copy the first two elements to the last two elements using negative indices: arr.copyWithin( -2, -4, -2 ); // Get the third array element: z = arr.get( 2 ); -// returns - -re = realf( z ); -// returns 1.0 - -im = imagf( z ); -// returns -1.0 +// returns [ 1.0, -1.0 ] // Get the last array element: z = arr.get( 3 ); -// returns - -re = realf( z ); -// returns 2.0 - -im = imagf( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] ``` @@ -753,8 +624,6 @@ Returns an iterator for iterating over array key-value pairs. ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = [ new Complex64( 1.0, -1.0 ), @@ -768,31 +637,13 @@ var it = arr.entries(); // Iterate over the key-value pairs... var v = it.next().value; -// returns [ 0, ] - -var re = realf( v[ 1 ] ); -// returns 1.0 - -var im = imagf( v[ 1 ] ); -// returns -1.0 +// returns [ 0, [ 1.0, -1.0 ] ] v = it.next().value; -// returns [ 1, ] - -re = realf( v[ 1 ] ); -// returns 2.0 - -im = imagf( v[ 1 ] ); -// returns -2.0 +// returns [ 1, [ 2.0, -2.0 ] ] v = it.next().value; -// returns [ 2, ] - -re = realf( v[ 1 ] ); -// returns 3.0 - -im = imagf( v[ 1 ] ); -// returns -3.0 +// returns [ 2, [ 3.0, -3.0 ] ] var bool = it.next().done; // returns true @@ -869,8 +720,6 @@ Returns a modified typed array filled with a fill value. ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 3 ); @@ -878,72 +727,34 @@ var arr = new Complex64Array( 3 ); arr.fill( new Complex64( 1.0, 1.0 ) ); var z = arr.get( 0 ); -// returns - -var re = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns 1.0 +// returns [ 1.0, 1.0 ] z = arr.get( 2 ); -// returns - -re = realf( z ); -// returns 1.0 - -im = imagf( z ); -// returns 1.0 +// returns [ 1.0, 1.0 ] // Fill all elements starting from the second element: arr.fill( new Complex64( 2.0, 2.0 ), 1 ); z = arr.get( 1 ); -// returns - -re = realf( z ); -// returns 2.0 - -im = imagf( z ); -// returns 2.0 +// returns [ 2.0, 2.0 ] z = arr.get( 2 ); -// returns - -re = realf( z ); -// returns 2.0 - -im = imagf( z ); -// returns 2.0 +// returns [ 2.0, 2.0 ] // Fill all elements from first element until the second-to-last element: arr.fill( new Complex64( 3.0, 3.0 ), 0, 2 ); z = arr.get( 0 ); -// returns - -re = realf( z ); -// returns 3.0 - -im = imagf( z ); -// returns 3.0 +// returns [ 3.0, 3.0 ] z = arr.get( 1 ); -// returns - -re = realf( z ); -// returns 3.0 - -im = imagf( z ); -// returns 3.0 +// returns [ 3.0, 3.0 ] ``` When a `start` and/or `end` index is negative, the respective index is determined relative to the last array element. ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 3 ); @@ -951,22 +762,10 @@ var arr = new Complex64Array( 3 ); arr.fill( new Complex64( 1.0, 1.0 ), 0, -1 ); var z = arr.get( 0 ); -// returns - -var re = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns 1.0 +// returns [ 1.0, 1.0 ] z = arr.get( arr.length - 1 ); -// returns - -re = realf( z ); -// returns 0.0 - -im = imagf( z ); -// returns 0.0 +// returns [ 0.0, 0.0 ] ``` @@ -997,13 +796,7 @@ var len = out.length; // returns 1 var z = out.get( 0 ); -// returns - -var re = realf( z ); -// returns 2.0 - -var im = imagf( z ); -// returns 2.0 +// returns [ 2.0, 2.0 ] ``` The `predicate` function is provided three arguments: @@ -1067,13 +860,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, 3.0 ], 2 ); var z = arr.find( predicate ); -// returns - -var re = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns 1.0 +// returns [ 1.0, 1.0 ] ``` The `predicate` function is provided three arguments: @@ -1105,13 +892,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, 3.0 ], 2 ); var z = arr.find( predicate, context ); -// returns - -var re = realf( z ); -// returns 2.0 - -var im = imagf( z ); -// returns 2.0 +// returns [ 2.0, 2.0 ] var count = context.count; // returns 2 @@ -1200,13 +981,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, 3.0 ], 2 ); var z = arr.findLast( predicate ); -// returns - -var re = realf( z ); -// returns 3.0 - -var im = imagf( z ); -// returns 3.0 +// returns [ 3.0, 3.0 ] ``` The `predicate` function is provided three arguments: @@ -1238,13 +1013,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, -3.0 ], 2 ); var z = arr.findLast( predicate, context ); -// returns - -var re = realf( z ); -// returns 2.0 - -var im = imagf( z ); -// returns 2.0 +// returns [ 2.0, 2.0 ] var count = context.count; // returns 2 @@ -1383,9 +1152,6 @@ var count = context.count; Returns an array element located at a nonnegative integer position (index) `i`. ```javascript -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); - var arr = new Complex64Array( 10 ); // Set the first element: @@ -1393,13 +1159,7 @@ arr.set( [ 1.0, -1.0 ], 0 ); // Get the first element: var z = arr.get( 0 ); -// returns - -var re = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns -1.0 +// returns [ 1.0, -1.0 ] ``` If provided an out-of-bounds index, the method returns `undefined`. @@ -1611,13 +1371,7 @@ var out = arr.map( scale ); // returns var z = out.get( 0 ); -// returns - -var re = realf( z ); -// returns 2.0 - -var im = imagf( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] ``` The callback function is provided three arguments: @@ -1663,8 +1417,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 realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var caddf = require( '@stdlib/complex/float32/base/add' ); var arr = new Complex64Array( 3 ); @@ -1674,13 +1426,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, 3.0 ], 2 ); var z = arr.reduce( caddf ); -// returns - -var re = realf( z ); -// returns 6.0 - -var im = imagf( z ); -// returns 6.0 +// returns [ 6.0, 6.0 ] ``` The reducer function is provided four arguments: @@ -1717,8 +1463,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 realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var caddf = require( '@stdlib/complex/float32/base/add' ); var arr = new Complex64Array( 3 ); @@ -1728,13 +1472,7 @@ arr.set( [ 2.0, 2.0 ], 1 ); arr.set( [ 3.0, 3.0 ], 2 ); var z = arr.reduceRight( caddf ); -// returns - -var re = realf( z ); -// returns 6.0 - -var im = imagf( z ); -// returns 6.0 +// returns [ 6.0, 6.0 ] ``` The reducer function is provided four arguments: @@ -1771,9 +1509,6 @@ var z = arr.reduceRight( reducer, 0.0 ); Reverses an array in-place. ```javascript -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); - var arr = new Complex64Array( 3 ); arr.set( [ 1.0, 1.0 ], 0 ); @@ -1781,34 +1516,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 = realf( z ); -// returns 3.0 - -var im = imagf( z ); -// returns 3.0 - -z = out.get( 1 ); -// returns - -re = realf( z ); -// returns 2.0 - -im = imagf( z ); -// returns 2.0 - -z = out.get( 2 ); -// returns - -re = realf( z ); -// returns 1.0 - -im = imagf( z ); -// returns 1.0 +// returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] ``` @@ -1819,74 +1527,44 @@ Sets one or more array elements. ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 10 ); // Get the first element: var z = arr.get( 0 ); -// returns - -var re = realf( z ); -// returns 0.0 - -var im = imagf( z ); -// returns 0.0 +// returns [ 0.0, 0.0 ] // Set the first element: arr.set( new Complex64( 1.0, -1.0 ) ); // Get the first element: z = arr.get( 0 ); -// returns - -re = realf( z ); -// returns 1.0 - -im = imagf( 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 Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 10 ); // Get the fifth element: var z = arr.get( 4 ); -// returns - -var re = realf( z ); -// returns 0.0 - -var im = imagf( z ); -// returns 0.0 +// returns [ 0.0, 0.0 ] // Set the fifth element: arr.set( new Complex64( 1.0, -1.0 ), 4 ); // Get the fifth element: z = arr.get( 4 ); -// returns - -re = realf( z ); -// returns 1.0 - -im = imagf( 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 Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 10 ); @@ -1902,21 +1580,13 @@ arr.set( buf, 4 ); // Get the sixth element: var z = arr.get( 5 ); -// returns - -var re = realf( z ); -// returns 2.0 - -var im = imagf( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] ``` or interleaved real and imaginary components ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 10 ); @@ -1928,13 +1598,7 @@ arr.set( buf, 4 ); // Get the sixth element: var z = arr.get( 5 ); -// returns - -var re = realf( z ); -// returns 2.0 - -var im = imagf( z ); -// returns -2.0 +// returns [ 2.0, -2.0 ] ``` A few notes: @@ -1950,91 +1614,37 @@ A few notes: Copies a portion of a typed array to a new typed array. ```javascript -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); - var arr = new Complex64Array( [ 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 = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns 2.0 - -z = out.get( len-1 ); -// returns - -re = realf( z ); -// returns 7.0 - -im = imagf( 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 imagf = require( '@stdlib/complex/float32/imag' ); -var realf = require( '@stdlib/complex/float32/real' ); - var arr = new Complex64Array( [ 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 = realf( z ); -// returns 3.0 - -var im = imagf( 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 realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); - var arr = new Complex64Array( [ 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 = realf( z ); -// returns 3.0 - -var im = imagf( z ); -// returns 4.0 - -z = out.get( len-1 ); -// returns - -re = realf( z ); -// returns 5.0 - -im = imagf( z ); -// returns 6.0 ``` @@ -2139,34 +1749,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 = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns -1.0 - -z = out.get( 1 ); -// returns - -re = realf( z ); -// returns 2.0 - -im = imagf( z ); -// returns -2.0 - -z = out.get( 2 ); -// returns - -re = realf( z ); -// returns 3.0 - -im = imagf( 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: @@ -2189,91 +1772,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 realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); - var arr = new Complex64Array( [ 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 = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns 2.0 - -z = subarr.get( len-1 ); -// returns - -re = realf( z ); -// returns 7.0 - -im = imagf( 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 imagf = require( '@stdlib/complex/float32/imag' ); -var realf = require( '@stdlib/complex/float32/real' ); - var arr = new Complex64Array( [ 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 = realf( z ); -// returns 3.0 - -var im = imagf( 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 realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); - var arr = new Complex64Array( [ 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 = realf( z ); -// returns 3.0 - -var im = imagf( z ); -// returns 4.0 - -z = subarr.get( len-1 ); -// returns - -re = realf( z ); -// returns 5.0 - -im = imagf( z ); -// returns 6.0 ``` @@ -2304,9 +1833,6 @@ The method supports the following arguments: Returns a new typed array containing the elements in reversed order. ```javascript -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); - var arr = new Complex64Array( 3 ); arr.set( [ 1.0, 1.0 ], 0 ); @@ -2314,34 +1840,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 = realf( z ); -// returns 3.0 - -var im = imagf( z ); -// returns 3.0 - -z = out.get( 1 ); -// returns - -re = realf( z ); -// returns 2.0 - -im = imagf( z ); -// returns 2.0 - -z = out.get( 2 ); -// returns - -re = realf( z ); -// returns 1.0 - -im = imagf( z ); -// returns 1.0 +// returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] ``` @@ -2385,34 +1884,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 = realf( z ); -// returns 1.0 - -var im = imagf( z ); -// returns -1.0 - -z = out.get( 1 ); -// returns - -re = realf( z ); -// returns 2.0 - -im = imagf( z ); -// returns -2.0 - -z = out.get( 2 ); -// returns - -re = realf( z ); -// returns 3.0 - -im = imagf( 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: @@ -2452,8 +1924,6 @@ var str = arr.toString(); Returns an iterator for iterating over each value in a typed array. ```javascript -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var arr = new Complex64Array( 2 ); arr.set( [ 1.0, -1.0 ], 0 ); @@ -2462,22 +1932,10 @@ arr.set( [ 2.0, -2.0 ], 1 ); var iter = arr.values(); var v = iter.next().value; -// returns - -var re = realf( v ); -// returns 1.0 - -var im = imagf( v ); -// returns -1.0 +// returns [ 1.0, -1.0 ] v = iter.next().value; -// returns - -re = realf( v ); -// returns 2.0 - -im = imagf( v ); -// returns -2.0 +// returns [ 2.0, -2.0 ] var bool = iter.next().done; // returns true @@ -2495,27 +1953,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 realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); var arr = new Complex64Array( 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 Complex64( 4.0, 4.0 ) ); -// returns - -var z = out.get( 0 ); -// returns - -var re = realf( z ); -// returns 4.0 - -var im = imagf( 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/complex64/docs/repl.txt b/lib/node_modules/@stdlib/array/complex64/docs/repl.txt index ae7603c7df65..b15e1707976e 100644 --- a/lib/node_modules/@stdlib/array/complex64/docs/repl.txt +++ b/lib/node_modules/@stdlib/array/complex64/docs/repl.txt @@ -164,12 +164,12 @@ thisArg: Any (optional) Callback execution context. - + Returns ------- out: Complex64Array A typed array. - + Examples -------- > function clbkFcn( v ) { return v * 2.0 }; @@ -178,11 +178,7 @@ > var len = arr.length 2 > var z = arr.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] {{alias}}.of( element0[, element1[, ...elementN]] ) @@ -218,11 +214,7 @@ > len = arr.length 2 > var z = arr.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -1.0 + [ 1.0, -1.0 ] {{alias}}.BYTES_PER_ELEMENT @@ -326,11 +318,7 @@ > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] ) > var z = arr.at( 1 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] {{alias}}.prototype.copyWithin( target, start[, end] ) @@ -341,10 +329,10 @@ ---------- target: integer Target start index position. - + start: integer Source start index position. - + end: integer (optional) Source end index position. Default: out.length. @@ -352,19 +340,15 @@ ------- out: Complex64Array Modified array. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] ) > arr.copyWithin( 0, 2 ) - + [ 3.0, -3.0, 4.0, -4.0, 3.0, -3.0, 4.0, -4.0 ] > var z = arr.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -3.0 + [ 3.0, -3.0 ] {{alias}}.prototype.entries() @@ -381,22 +365,11 @@ > var it = arr.entries(); > var v = it.next().value - [ 0, ] - > var re = {{alias:@stdlib/complex/float32/real}}( v[ 1 ] ) - 1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( v[ 1 ] ) - -1.0 + [ 0, [ 1.0, -1.0 ] ] > v = it.next().value - [ 1, ] - > re = {{alias:@stdlib/complex/float32/real}}( v[ 1 ] ) - 2.0 - > im = {{alias:@stdlib/complex/float32/imag}}( v[ 1 ] ) - -2.0 + [ 1, [ 2.0, -2.0 ] ] > v = it.next().value - [ 2, ] - > re = {{alias:@stdlib/complex/float32/real}}( v[ 1 ] ) - 3.0 - > im = {{alias:@stdlib/complex/float32/imag}}( v[ 1 ] ) + [ 2, [ 3.0, -3.0 ] ] -3.0 > var bool = it.next().done true @@ -455,30 +428,18 @@ ------- out: Complex64Array Modified array. - + Examples -------- > var arr = new {{alias}}( 3 ) > arr.fill( new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 1.0 ) ); > var z = arr.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - 1.0 + [ 1.0, 1.0 ] > z = arr.get( 1 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - 1.0 + [ 1.0, 1.0 ] > z = arr.get( 2 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - 1.0 + [ 1.0, 1.0 ] {{alias}}.prototype.filter( predicate[, thisArg] ) @@ -507,22 +468,18 @@ ------- out: Complex64Array A new typed array. - + Examples -------- > function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); }; > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, 2.0, 3.0, -3.0 ] ) > var out = arr.filter( predicate ) - + [ 2.0, 2.0 ] > var len = out.length 1 > var z = out.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - 2.0 + [ 2.0, 2.0 ] {{alias}}.prototype.find( predicate[, thisArg] ) @@ -545,23 +502,19 @@ thisArg: Any (optional) Execution context. - + Returns ------- out: Complex64|void Array element or `undefined`. - + Examples -------- > function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); }; > var arr = new {{alias}}( [ 1.0, 1.0, 2.0, 2.0, 3.0, -3.0 ] ) > var z = arr.find( predicate ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - 1.0 + [ 1.0, 1.0 ] {{alias}}.prototype.findIndex( predicate[, thisArg] ) @@ -584,12 +537,12 @@ thisArg: Any (optional) Execution context. - + Returns ------- out: integer Array index or `-1`. - + Examples -------- > function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); }; @@ -618,24 +571,20 @@ Predicate function which tests array elements. thisArg: Any (optional) - Execution context. - + Execution context. + Returns ------- out: Complex64|void Array element or `undefined`. - + Examples -------- > function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); }; > var arr = new {{alias}}( [ 1.0, 1.0, 2.0, 2.0, 3.0, -3.0 ] ) > var z = arr.findLast( predicate ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - 2.0 + [ 2.0, 2.0 ] {{alias}}.prototype.findLastIndex( predicate[, thisArg] ) @@ -663,7 +612,7 @@ ------- out: integer Array index or `-1`. - + Examples -------- > function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); }; @@ -689,7 +638,7 @@ thisArg: Any (optional) Execution context. - + Examples -------- > var str = '%'; @@ -711,22 +660,18 @@ ---------- i: integer Element index. - + Returns ------- out: Complex64|void Array element or `undefined`. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] ) > var z = arr.get( 1 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] {{alias}}.prototype.includes( searchElement[, fromIndex] ) @@ -741,12 +686,12 @@ Array index at which to start the search. If provided a negative value, the method resolves the start index relative to the last array element. Default: 0. - + Returns ------- bool: boolean Boolean indicating whether an array includes a search element. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] ) @@ -776,7 +721,7 @@ ------- out: integer Array index or `-1`. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] ) @@ -795,12 +740,12 @@ ---------- separator: string (optional) Separator string. Default: ','. - + Returns ------- out: string Array serialized as a string. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] ) @@ -818,7 +763,7 @@ ------- iterator: Iterator Iterator for iterating over array index keys. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] ) @@ -846,12 +791,12 @@ Array index at which to start the search. If provided a negative value, the method resolves the start index relative to the last array element. Default: out.length-1. - + Returns ------- out: integer Array index or `-1`. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 1.0, -1.0 ] ) @@ -886,26 +831,18 @@ ------- out: Complex64Array A new typed array. - + Examples -------- > function clbk( v ) { return v; }; > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] ) > var out = arr.map( clbk ) - + [ 1.0, -1.0, 2.0, -2.0 ] > var z = out.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -1.0 + [ 1.0, -1.0 ] > z = out.get( 1 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] {{alias}}.prototype.reduce( reducerFn[, initialValue] ) @@ -931,26 +868,22 @@ Parameters ---------- reducerFn: Function - Function to apply to each array element. + Function to apply to each array element. initialValue: any (optional) Initial accumulation value. - + Returns ------- out: any Accumulated result. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] ) > var z = arr.reduce( {{alias:@stdlib/complex/float32/base/add}} ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -3.0 + [ 3.0, -3.0 ] {{alias}}.prototype.reduceRight( reducerFn[, initialValue] ) @@ -980,22 +913,18 @@ initialValue: any (optional) Initial accumulation value. - + Returns ------- out: any Accumulated result. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] ) > var z = arr.reduceRight( {{alias:@stdlib/complex/float32/base/add}} ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -3.0 + [ 3.0, -3.0 ] {{alias}}.prototype.reverse() @@ -1014,23 +943,11 @@ > arr.reverse(); > var z = arr.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -3.0 + [ 3.0, -3.0 ] > z = arr.get( 1 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] > z = arr.get( 2 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -1.0 + [ 1.0, -1.0 ] {{alias}}.prototype.set( z[, i] ) @@ -1057,18 +974,10 @@ > arr.set( new {{alias:@stdlib/complex/float32/ctor}}( 1.0, -1.0 ) ); > var z = arr.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -1.0 + [ 1.0, -1.0 ] > arr.set( new {{alias:@stdlib/complex/float32/ctor}}( 2.0, -2.0 ), 1 ); > z = arr.get( 1 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] {{alias}}.prototype.slice( [start[, end]] ) @@ -1083,32 +992,24 @@ end: integer (optional) End index (non-inclusive). If less than zero, the end index is resolved relative to the last array element. Default: out.length. - + Returns ------- out: Complex64Array New typed array. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] ) > var out = arr.slice( 1 ) - + [ 2.0, -2.0, 3.0, -3.0 ] > var len = out.length 2 > var z = out.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] > z = out.get( 1 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -3.0 + [ 3.0, -3.0 ] {{alias}}.prototype.some( predicate[, thisArg] ) @@ -1126,15 +1027,15 @@ Predicate function which tests array elements. If a predicate function returns a truthy value, an array element passes; otherwise, an array element fails. - + thisArg: Any (optional) Execution context. - + Returns ------- bool: boolean Boolean indicating whether at least one element passes the test. - + Examples -------- > function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); }; @@ -1161,12 +1062,12 @@ ---------- compareFunction: Function Comparison function. - + Returns ------- out: Complex64Array Modified array. - + Examples -------- > function compare( a, b ) { return ( {{alias:@stdlib/complex/float32/real}}( a ) - {{alias:@stdlib/complex/float32/real}}( b ) ); }; @@ -1174,23 +1075,11 @@ > arr.sort( compare ); > var z = arr.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -1.0 + [ 1.0, -1.0 ] > z = arr.get( 1 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] > z = arr.get( 2 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -3.0 + [ 3.0, -3.0 ] {{alias}}.prototype.subarray( [begin[, end]] ) @@ -1217,21 +1106,13 @@ > 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/float32/real}}( z ) - 2.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] > z = out.get( 1 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -3.0 + [ 3.0, -3.0 ] {{alias}}.prototype.toLocaleString( [locales[, options]] ) @@ -1241,10 +1122,10 @@ ---------- locales: string|Array (optional) Locale identifier(s). - + options: Object (optional) An object containing serialization options. - + Returns ------- str: string @@ -1265,31 +1146,19 @@ ------- out: Complex64Array New typed array. - + Examples -------- > var arr = new {{alias}}( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ) > var out = arr.toReversed() - + [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] > var z = out.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - 3.0 + [ 3.0, 3.0 ] > z = out.get( 1 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - 2.0 + [ 2.0, 2.0 ] > z = out.get( 2 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - 1.0 + [ 1.0, 1.0 ] {{alias}}.prototype.toSorted( compareFcn ) @@ -1309,12 +1178,12 @@ ---------- compareFcn: Function Comparison function. - + Returns ------- out: Complex64Array New typed array. - + Examples -------- > function compare( a, b ) { return ( {{alias:@stdlib/complex/float32/real}}( a ) - {{alias:@stdlib/complex/float32/real}}( b ) ); }; @@ -1322,23 +1191,11 @@ > var out = arr.toSorted( compare ); > var z = out.get( 0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -1.0 + [ 1.0, -1.0 ] > z = out.get( 1 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 2.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -2.0 + [ 2.0, -2.0 ] > z = out.get( 2 ) - - > re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > im = {{alias:@stdlib/complex/float32/imag}}( z ) - -3.0 + [ 3.0, -3.0 ] {{alias}}.prototype.toString() @@ -1348,7 +1205,7 @@ ------- str: string String serialization of the array. - + Examples -------- > var arr = new {{alias}}( [ 1.0, 1.0, 2.0, -2.0, 3.0, 3.0 ] ) @@ -1364,24 +1221,16 @@ ------- iterator: Iterator Iterator for iterating over array values. - + Examples -------- > var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] ) > var it = arr.values(); > var v = it.next().value - - > var re = {{alias:@stdlib/complex/float32/real}}( v ) - 1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( v ) - -1.0 + [ 1.0, -1.0 ] > v = it.next().value - - > re = {{alias:@stdlib/complex/float32/real}}( v ) - 2.0 - > im = {{alias:@stdlib/complex/float32/imag}}( v ) - -2.0 + [ 2.0, -2.0 ] > var bool = it.next().done true @@ -1394,27 +1243,23 @@ ---------- index: integer Element index. - + value: Complex64 - Element value. + Element value. Returns ------- out: Complex64Array New typed array. - + Examples -------- > 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 ) ) - + [ 1.0, -1.0, 3.0, -3.0 ] > var z = out.get( 1 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( z ) - 3.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( z ) - -3.0 + [ 3.0, -3.0 ] See Also diff --git a/lib/node_modules/@stdlib/array/complex64/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/complex64/docs/types/index.d.ts index 3ecdd35d3950..ba2692a17f46 100644 --- a/lib/node_modules/@stdlib/array/complex64/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/complex64/docs/types/index.d.ts @@ -352,13 +352,13 @@ declare class Complex64Array implements Complex64ArrayInterface { * var arr = new Complex64Array( 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 @@ -433,8 +433,6 @@ declare class Complex64Array implements Complex64ArrayInterface { * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); * * var arr = new Complex64Array( 4 ); * @@ -449,12 +447,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * * // Get the last array element: * var z = arr.get( 3 ); - * - * var re = realf( z ); - * // returns 2.0 - * - * var im = imagf( z ); - * // returns 2.0 + * // returns [ 2.0, 2.0 ] */ copyWithin( target: number, start: number, end?: number ): Complex64Array; @@ -526,30 +519,15 @@ declare class Complex64Array implements Complex64ArrayInterface { * @returns modified typed array * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); - * * var arr = new Complex64Array( 3 ); * * arr.fill( new Complex64( 1.0, 1.0 ), 1 ); * * var z = arr.get( 1 ); - * // returns - * - * var re = realf( z ); - * // returns 1.0 - * - * var im = imagf( z ); - * // returns 1.0 + * // returns [ 1.0, 1.0 ] * * z = arr.get( 2 ); - * // returns - * - * re = realf( z ); - * // returns 1.0 - * - * im = imagf( z ); - * // returns 1.0 + * // returns [ 1.0, 1.0 ] */ fill( value: ComplexLike, start?: number, end?: number ): Complex64Array; @@ -581,13 +559,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * // returns 1 * * var z = out.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 2.0 - * - * var im = imagf( z ); - * // returns 2.0 + * // returns [ 2.0, 2.0 ] */ filter( predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; @@ -614,13 +586,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.find( predicate ); - * // returns - * - * var re = realf( z ); - * // returns 1.0 - * - * var im = imagf( z ); - * // returns 1.0 + * // returns [ 1.0, 1.0 ] */ find( predicate: Predicate, thisArg?: ThisParameterType> ): Complex64 | void; @@ -674,13 +640,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.findLast( predicate ); - * // returns - * - * var re = realf( z ); - * // returns 3.0 - * - * var im = imagf( z ); - * // returns 3.0 + * // returns [ 3.0, 3.0 ] */ findLast( predicate: Predicate, thisArg?: ThisParameterType> ): Complex64 | void; @@ -746,7 +706,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * var arr = new Complex64Array( 10 ); * * var z = arr.get( 0 ); - * // returns + * // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * @@ -908,13 +868,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * // returns * * var z = out.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 2.0 - * - * var im = imagf( z ); - * // returns -2.0 + * // returns [ 2.0, -2.0 ] */ map( fcn: MapFcn, thisArg?: ThisParameterType> ): Complex64Array; @@ -926,8 +880,6 @@ declare class Complex64Array implements Complex64ArrayInterface { * @returns accumulated result * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); * var caddf = require( '@stdlib/complex/float32/base/add' ); * * var arr = new Complex64Array( 3 ); @@ -937,13 +889,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.reduce( caddf ); - * // returns - * - * var re = realf( z ); - * // returns 6.0 - * - * var im = imagf( z ); - * // returns 6.0 + * // returns [ 6.0, 6.0 ] */ reduce( reducer: Reducer, initialValue?: U ): U; @@ -955,8 +901,6 @@ declare class Complex64Array implements Complex64ArrayInterface { * @returns accumulated result * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); * var caddf = require( '@stdlib/complex/float32/base/add' ); * * var arr = new Complex64Array( 3 ); @@ -966,13 +910,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.reduceRight( caddf ); - * // returns - * - * var re = realf( z ); - * // returns 6.0 - * - * var im = imagf( z ); - * // returns 6.0 + * // returns [ 6.0, 6.0 ] */ reduceRight( reducer: Reducer, initialValue?: U ): U; @@ -982,9 +920,6 @@ declare class Complex64Array implements Complex64ArrayInterface { * @returns reversed array * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); - * * var arr = new Complex64Array( 3 ); * * arr.set( [ 1.0, 1.0 ], 0 ); @@ -992,34 +927,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.reverse(); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 3.0 - * - * var im = imagf( z ); - * // returns 3.0 - * - * z = out.get( 1 ); - * // returns - * - * re = realf( z ); - * // returns 2.0 - * - * im = imagf( z ); - * // returns 2.0 - * - * z = out.get( 2 ); - * // returns - * - * re = realf( z ); - * // returns 1.0 - * - * im = imagf( z ); - * // returns 1.0 + * // returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] */ reverse(): Complex64Array; @@ -1055,30 +963,15 @@ declare class Complex64Array implements Complex64ArrayInterface { * @throws target array lacks sufficient storage to accommodate source values * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); - * * var arr = new Complex64Array( 10 ); * * var z = arr.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 0.0 - * - * var im = imagf( z ); - * // returns 0.0 + * // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * * z = arr.get( 0 ); - * // returns - * - * re = realf( z ); - * // returns 1.0 - * - * im = imagf( z ); - * // returns -1.0 + * // returns [ 1.0, -1.0 ] */ set( value: ArrayLike | RealOrComplexTypedArray | ComplexLike, i?: number ): void; @@ -1091,9 +984,6 @@ declare class Complex64Array implements Complex64ArrayInterface { * @returns output array * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); - * * var arr = new Complex64Array( 5 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -1103,52 +993,16 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 5.0, -5.0 ], 4 ); * * var out = arr.slice(); - * // returns + * // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0, 5.0, -5.0 ] * * var len = out.length; * // returns 5 * - * var z = out.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 1.0 - * - * var im = imagf( z ); - * // returns -1.0 - * - * z = out.get( len-1 ); - * // returns - * - * re = realf( z ); - * // returns 5.0 - * - * im = imagf( z ); - * // returns -5.0 - * * out = arr.slice( 1, -2 ); - * // returns + * // returns [ 2.0, -2.0, 3.0, -3.0 ] * * len = out.length; * // returns 2 - * - * z = out.get( 0 ); - * // returns - * - * re = realf( z ); - * // returns 2.0 - * - * im = imagf( z ); - * // returns -2.0 - * - * z = out.get( len-1 ); - * // returns - * - * re = realf( z ); - * // returns 3.0 - * - * im = imagf( z ); - * // returns -3.0 */ slice( start?: number, end?: number ): Complex64Array; @@ -1219,34 +1073,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 2.0, -2.0 ], 2 ); * * var out = arr.sort( compare ); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 1.0 - * - * var im = imagf( z ); - * // returns -1.0 - * - * z = out.get( 1 ); - * // returns - * - * re = realf( z ); - * // returns 2.0 - * - * im = imagf( z ); - * // returns -2.0 - * - * z = out.get( 2 ); - * // returns - * - * re = realf( z ); - * // returns 3.0 - * - * im = imagf( z ); - * // returns -3.0 + * // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] */ sort( compareFcn: CompareFcn ): Complex64Array; @@ -1259,9 +1086,6 @@ declare class Complex64Array implements Complex64ArrayInterface { * @returns subarray * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); - * * var arr = new Complex64Array( 5 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -1271,52 +1095,16 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 5.0, -5.0 ], 4 ); * * var subarr = arr.subarray(); - * // returns + * // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0, 5.0, -5.0 ] * * var len = subarr.length; * // returns 5 * - * var z = subarr.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 1.0 - * - * var im = imagf( z ); - * // returns -1.0 - * - * z = subarr.get( len-1 ); - * // returns - * - * re = realf( z ); - * // returns 5.0 - * - * im = imagf( z ); - * // returns -5.0 - * * subarr = arr.subarray( 1, -2 ); - * // returns + * // returns [ 2.0, -2.0, 3.0, -3.0 ] * * len = subarr.length; * // returns 2 - * - * z = subarr.get( 0 ); - * // returns - * - * re = realf( z ); - * // returns 2.0 - * - * im = imagf( z ); - * // returns -2.0 - * - * z = subarr.get( len-1 ); - * // returns - * - * re = realf( z ); - * // returns 3.0 - * - * im = imagf( z ); - * // returns -3.0 */ subarray( begin?: number, end?: number ): Complex64Array; @@ -1344,9 +1132,6 @@ declare class Complex64Array implements Complex64ArrayInterface { * @returns reversed array * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); - * * var arr = new Complex64Array( 3 ); * * arr.set( [ 1.0, 1.0 ], 0 ); @@ -1354,34 +1139,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.toReversed(); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 3.0 - * - * var im = imagf( z ); - * // returns 3.0 - * - * z = out.get( 1 ); - * // returns - * - * re = realf( z ); - * // returns 2.0 - * - * im = imagf( z ); - * // returns 2.0 - * - * z = out.get( 2 ); - * // returns - * - * re = realf( z ); - * // returns 1.0 - * - * im = imagf( z ); - * // returns 1.0 + * // returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] */ toReversed(): Complex64Array; @@ -1426,34 +1184,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 2.0, -2.0 ], 2 ); * * var out = arr.toSorted( compare ); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 1.0 - * - * var im = imagf( z ); - * // returns -1.0 - * - * z = out.get( 1 ); - * // returns - * - * re = realf( z ); - * // returns 2.0 - * - * im = imagf( z ); - * // returns -2.0 - * - * z = out.get( 2 ); - * // returns - * - * re = realf( z ); - * // returns 3.0 - * - * im = imagf( z ); - * // returns -3.0 + * // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] */ toSorted( compareFcn: CompareFcn ): Complex64Array; @@ -1479,8 +1210,6 @@ declare class Complex64Array implements Complex64ArrayInterface { * @returns iterator * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); * var arr = new Complex64Array( 2 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -1489,22 +1218,10 @@ declare class Complex64Array implements Complex64ArrayInterface { * var iter = arr.values(); * * var v = iter.next().value; - * // returns - * - * var re = realf( v ); - * // returns 1.0 - * - * var im = imagf( v ); - * // returns -1.0 + * // returns [ 1.0, -1.0 ] * * v = iter.next().value; - * // returns - * - * re = realf( v ); - * // returns 2.0 - * - * im = imagf( v ); - * // returns -2.0 + * // returns [ 2.0, -2.0 ] * * var bool = iter.next().done; * // returns true @@ -1522,8 +1239,6 @@ declare class Complex64Array implements Complex64ArrayInterface { * @returns modified typed array * * @example - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); * var Complex64 = require( '@stdlib/complex/float32/ctor' ); * * var arr = new Complex64Array( 3 ); @@ -1533,16 +1248,7 @@ declare class Complex64Array implements Complex64ArrayInterface { * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.with( 0, new Complex64( 4.0, 4.0 ) ); - * // returns - * - * var z = out.get( 0 ); - * // returns - * - * var re = realf( z ); - * // returns 4.0 - * - * var im = imagf( z ); - * // returns 4.0 + * // returns [ 4.0, 4.0, 2.0, 2.0, 3.0, 3.0 ] */ with( index: number, value: ComplexLike ): Complex64Array; } diff --git a/lib/node_modules/@stdlib/array/complex64/lib/main.js b/lib/node_modules/@stdlib/array/complex64/lib/main.js index 9dc561cb824b..3b03522c0791 100644 --- a/lib/node_modules/@stdlib/array/complex64/lib/main.js +++ b/lib/node_modules/@stdlib/array/complex64/lib/main.js @@ -551,39 +551,19 @@ setReadOnly( Complex64Array, 'of', function of() { * * @example * var arr = new Complex64Array( 10 ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var z = arr.at( 0 ); -* // returns -* -* var re = realf( z ); -* // returns 0.0 -* -* var im = imagf( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * arr.set( [ 2.0, -2.0 ], 1 ); * arr.set( [ 9.0, -9.0 ], 9 ); * * z = arr.at( 0 ); -* // returns -* -* re = realf( z ); -* // returns 1.0 -* -* im = imagf( z ); -* // returns -1.0 +* // returns [ 1.0, -1.0 ] * * z = arr.at( -1 ); -* // returns -* -* re = realf( z ); -* // returns 9.0 -* -* im = imagf( z ); -* // returns -9.0 +* // returns [ 9.0, -9.0 ] * * z = arr.at( 100 ); * // returns undefined @@ -692,8 +672,6 @@ setReadOnly( Complex64Array.prototype, 'BYTES_PER_ELEMENT', Complex64Array.BYTES * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var arr = new Complex64Array( 4 ); * @@ -708,12 +686,7 @@ setReadOnly( Complex64Array.prototype, 'BYTES_PER_ELEMENT', Complex64Array.BYTES * * // Get the last array element: * var z = arr.get( 3 ); -* -* var re = realf( z ); -* // returns 2.0 -* -* var im = imagf( z ); -* // returns 2.0 +* // returns [ 2.0, 2.0 ] */ setReadOnly( Complex64Array.prototype, 'copyWithin', function copyWithin( target, start ) { if ( !isComplexArray( this ) ) { @@ -903,30 +876,15 @@ setReadOnly( Complex64Array.prototype, 'every', function every( predicate, thisA * @returns {Complex64Array} modified array * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); -* * var arr = new Complex64Array( 3 ); * * arr.fill( new Complex64( 1.0, 1.0 ), 1 ); * * var z = arr.get( 1 ); -* // returns -* -* var re = realf( z ); -* // returns 1.0 -* -* var im = imagf( z ); -* // returns 1.0 +* // returns [ 1.0, 1.0 ] * * z = arr.get( 2 ); -* // returns -* -* re = realf( z ); -* // returns 1.0 -* -* im = imagf( z ); -* // returns 1.0 +* // returns [ 1.0, 1.0 ] */ setReadOnly( Complex64Array.prototype, 'fill', function fill( value, start, end ) { var buf; @@ -1010,19 +968,10 @@ setReadOnly( Complex64Array.prototype, 'fill', function fill( value, start, end * 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 = realf( z ); -* // returns 2.0 -* -* var im = imagf( z ); -* // returns 2.0 */ setReadOnly( Complex64Array.prototype, 'filter', function filter( predicate, thisArg ) { var buf; @@ -1061,7 +1010,6 @@ setReadOnly( Complex64Array.prototype, 'filter', function filter( predicate, thi * @example * var realf = require( '@stdlib/complex/float32/real' ); * var imagf = require( '@stdlib/complex/float32/imag' ); -* var Complex64 = require( '@stdlib/complex/float32/ctor' ); * * function predicate( v ) { * return ( realf( v ) === imagf( v ) ); @@ -1074,13 +1022,7 @@ setReadOnly( Complex64Array.prototype, 'filter', function filter( predicate, thi * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.find( predicate ); -* // returns -* -* var re = realf( z ); -* // returns 1.0 -* -* var im = imagf( z ); -* // returns 1.0 +* // returns [ 1.0, 1.0 ] */ setReadOnly( Complex64Array.prototype, 'find', function find( predicate, thisArg ) { var buf; @@ -1166,7 +1108,6 @@ setReadOnly( Complex64Array.prototype, 'findIndex', function findIndex( predicat * @example * var realf = require( '@stdlib/complex/float32/real' ); * var imagf = require( '@stdlib/complex/float32/imag' ); -* var Complex64 = require( '@stdlib/complex/float32/ctor' ); * * function predicate( v ) { * return ( realf( v ) === imagf( v ) ); @@ -1179,13 +1120,7 @@ setReadOnly( Complex64Array.prototype, 'findIndex', function findIndex( predicat * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.findLast( predicate ); -* // returns -* -* var re = realf( z ); -* // returns 3.0 -* -* var im = imagf( z ); -* // returns 3.0 +* // returns [ 3.0, 3.0 ] */ setReadOnly( Complex64Array.prototype, 'findLast', function findLast( predicate, thisArg ) { var buf; @@ -1312,28 +1247,14 @@ setReadOnly( Complex64Array.prototype, 'forEach', function forEach( fcn, thisArg * * @example * var arr = new Complex64Array( 10 ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var z = arr.get( 0 ); -* // returns -* -* var re = realf( z ); -* // returns 0.0 -* -* var im = imagf( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * * z = arr.get( 0 ); -* // returns -* -* re = realf( z ); -* // returns 1.0 -* -* im = imagf( z ); -* // returns -1.0 +* // returns [ 1.0, -1.0 ] * * z = arr.get( 100 ); * // returns undefined @@ -1756,16 +1677,7 @@ setReadOnlyAccessor( Complex64Array.prototype, 'length', function get() { * arr.set( [ 3.0, -3.0 ], 2 ); * * var out = arr.map( scale ); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = realf( z ); -* // returns 2 -* -* var im = imagf( z ); -* // returns -2 +* // returns [ 2.0, -2.0, 4.0, -4.0, 6.0, -6.0 ] */ setReadOnly( Complex64Array.prototype, 'map', function map( fcn, thisArg ) { var outbuf; @@ -1811,8 +1723,6 @@ setReadOnly( Complex64Array.prototype, 'map', function map( fcn, thisArg ) { * @returns {*} accumulated result * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var caddf = require( '@stdlib/complex/float32/base/add' ); * * var arr = new Complex64Array( 3 ); @@ -1822,13 +1732,7 @@ setReadOnly( Complex64Array.prototype, 'map', function map( fcn, thisArg ) { * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.reduce( caddf ); -* // returns -* -* var re = realf( z ); -* // returns 6.0 -* -* var im = imagf( z ); -* // returns 6.0 +* // returns [ 6.0, 6.0 ] */ setReadOnly( Complex64Array.prototype, 'reduce', function reduce( reducer, initialValue ) { var buf; @@ -1876,8 +1780,6 @@ setReadOnly( Complex64Array.prototype, 'reduce', function reduce( reducer, initi * @returns {*} accumulated result * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var caddf = require( '@stdlib/complex/float32/base/add' ); * * var arr = new Complex64Array( 3 ); @@ -1887,13 +1789,7 @@ setReadOnly( Complex64Array.prototype, 'reduce', function reduce( reducer, initi * arr.set( [ 3.0, 3.0 ], 2 ); * * var z = arr.reduceRight( caddf ); -* // returns -* -* var re = realf( z ); -* // returns 6.0 -* -* var im = imagf( z ); -* // returns 6.0 +* // returns [ 6.0, 6.0 ] */ setReadOnly( Complex64Array.prototype, 'reduceRight', function reduceRight( reducer, initialValue ) { var buf; @@ -1937,9 +1833,6 @@ setReadOnly( Complex64Array.prototype, 'reduceRight', function reduceRight( redu * @returns {Complex64Array} reversed array * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); -* * var arr = new Complex64Array( 3 ); * * arr.set( [ 1.0, 1.0 ], 0 ); @@ -1947,34 +1840,7 @@ setReadOnly( Complex64Array.prototype, 'reduceRight', function reduceRight( redu * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.reverse(); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = realf( z ); -* // returns 3.0 -* -* var im = imagf( z ); -* // returns 3.0 -* -* z = out.get( 1 ); -* // returns -* -* re = realf( z ); -* // returns 2.0 -* -* im = imagf( z ); -* // returns 2.0 -* -* z = out.get( 2 ); -* // returns -* -* re = realf( z ); -* // returns 1.0 -* -* im = imagf( z ); -* // returns 1.0 +* // returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] */ setReadOnly( Complex64Array.prototype, 'reverse', function reverse() { var buf; @@ -2038,30 +1904,15 @@ setReadOnly( Complex64Array.prototype, 'reverse', function reverse() { * @returns {void} * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); -* * var arr = new Complex64Array( 10 ); * * var z = arr.get( 0 ); -* // returns -* -* var re = realf( z ); -* // returns 0.0 -* -* var im = imagf( z ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * arr.set( [ 1.0, -1.0 ], 0 ); * * z = arr.get( 0 ); -* // returns -* -* re = realf( z ); -* // returns 1.0 -* -* im = imagf( z ); -* // returns -1.0 +* // returns [ 1.0, -1.0 ] */ setReadOnly( Complex64Array.prototype, 'set', function set( value ) { /* eslint-disable no-underscore-dangle */ @@ -2206,9 +2057,6 @@ setReadOnly( Complex64Array.prototype, 'set', function set( value ) { * @returns {Complex64Array} complex number array * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); -* * var arr = new Complex64Array( 5 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -2218,52 +2066,10 @@ setReadOnly( Complex64Array.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 = realf( z ); -* // returns 1.0 -* -* var im = imagf( z ); -* // returns -1.0 -* -* z = out.get( len-1 ); -* // returns -* -* re = realf( z ); -* // returns 5.0 -* -* im = imagf( 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 = realf( z ); -* // returns 2.0 -* -* im = imagf( z ); -* // returns -2.0 -* -* z = out.get( len-1 ); -* // returns -* -* re = realf( z ); -* // returns 3.0 -* -* im = imagf( z ); -* // returns -3.0 +* // returns [ 2.0, -2.0, 3.0, -3.0 ] */ setReadOnly( Complex64Array.prototype, 'slice', function slice( start, end ) { var outlen; @@ -2415,34 +2221,7 @@ setReadOnly( Complex64Array.prototype, 'some', function some( predicate, thisArg * arr.set( [ 2.0, -2.0 ], 2 ); * * var out = arr.sort( compare ); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = realf( z ); -* // returns 1.0 -* -* var im = imagf( z ); -* // returns -1.0 -* -* z = out.get( 1 ); -* // returns -* -* re = realf( z ); -* // returns 2.0 -* -* im = imagf( z ); -* // returns -2.0 -* -* z = out.get( 2 ); -* // returns -* -* re = realf( z ); -* // returns 3.0 -* -* im = imagf( z ); -* // returns -3.0 +* // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] */ setReadOnly( Complex64Array.prototype, 'sort', function sort( compareFcn ) { var tmp; @@ -2485,9 +2264,6 @@ setReadOnly( Complex64Array.prototype, 'sort', function sort( compareFcn ) { * @returns {Complex64Array} subarray * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); -* * var arr = new Complex64Array( 5 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -2497,52 +2273,10 @@ setReadOnly( Complex64Array.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 = realf( z ); -* // returns 1.0 -* -* var im = imagf( z ); -* // returns -1.0 -* -* z = subarr.get( len-1 ); -* // returns -* -* re = realf( z ); -* // returns 5.0 -* -* im = imagf( 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 = realf( z ); -* // returns 2.0 -* -* im = imagf( z ); -* // returns -2.0 -* -* z = subarr.get( len-1 ); -* // returns -* -* re = realf( z ); -* // returns 3.0 -* -* im = imagf( z ); -* // returns -3.0 +* // returns [ 2.0, -2.0, 3.0, -3.0 ] */ setReadOnly( Complex64Array.prototype, 'subarray', function subarray( begin, end ) { var offset; @@ -2658,9 +2392,6 @@ setReadOnly( Complex64Array.prototype, 'toLocaleString', function toLocaleString * @returns {Complex64Array} reversed array * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); -* * var arr = new Complex64Array( 3 ); * * arr.set( [ 1.0, 1.0 ], 0 ); @@ -2668,34 +2399,7 @@ setReadOnly( Complex64Array.prototype, 'toLocaleString', function toLocaleString * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.toReversed(); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = realf( z ); -* // returns 3.0 -* -* var im = imagf( z ); -* // returns 3.0 -* -* z = out.get( 1 ); -* // returns -* -* re = realf( z ); -* // returns 2.0 -* -* im = imagf( z ); -* // returns 2.0 -* -* z = out.get( 2 ); -* // returns -* -* re = realf( z ); -* // returns 1.0 -* -* im = imagf( z ); -* // returns 1.0 +* // returns [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] */ setReadOnly( Complex64Array.prototype, 'toReversed', function toReversed() { var outbuf; @@ -2765,34 +2469,7 @@ setReadOnly( Complex64Array.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 = realf( z ); -* // returns 1.0 -* -* var im = imagf( z ); -* // returns -1.0 -* -* z = out.get( 1 ); -* // returns -* -* re = realf( z ); -* // returns 2.0 -* -* im = imagf( z ); -* // returns -2.0 -* -* z = out.get( 2 ); -* // returns -* -* re = realf( z ); -* // returns 3.0 -* -* im = imagf( z ); -* // returns -3.0 +* // returns [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] */ setReadOnly( Complex64Array.prototype, 'toSorted', function toSorted( compareFcn ) { var tmp; @@ -2858,8 +2535,6 @@ setReadOnly( Complex64Array.prototype, 'toString', function toString() { * @returns {Iterator} iterator * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var arr = new Complex64Array( 2 ); * * arr.set( [ 1.0, -1.0 ], 0 ); @@ -2868,22 +2543,10 @@ setReadOnly( Complex64Array.prototype, 'toString', function toString() { * var iter = arr.values(); * * var v = iter.next().value; -* // returns -* -* var re = realf( v ); -* // returns 1.0 -* -* var im = imagf( v ); -* // returns -1.0 +* // returns [ 1.0, -1.0 ] * * v = iter.next().value; -* // returns -* -* re = realf( v ); -* // returns 2.0 -* -* im = imagf( v ); -* // returns -2.0 +* // returns [ 2.0, -2.0 ] * * var bool = iter.next().done; * // returns true @@ -2980,8 +2643,6 @@ setReadOnly( Complex64Array.prototype, 'values', function values() { * @returns {Complex64Array} new typed array * * @example -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var Complex64 = require( '@stdlib/complex/float32/ctor' ); * * var arr = new Complex64Array( 3 ); @@ -2991,16 +2652,7 @@ setReadOnly( Complex64Array.prototype, 'values', function values() { * arr.set( [ 3.0, 3.0 ], 2 ); * * var out = arr.with( 0, new Complex64( 4.0, 4.0 ) ); -* // returns -* -* var z = out.get( 0 ); -* // returns -* -* var re = realf( z ); -* // returns 4.0 -* -* var im = imagf( z ); -* // returns 4.0 +* // returns [ 4.0, 4.0, 2.0, 2.0, 3.0, 3.0 ] */ setReadOnly( Complex64Array.prototype, 'with', function copyWith( index, value ) { var buf;