Auto-generated commit

complex128/README.md

@@ -2335,6 +2335,88 @@ im = imag( z );
 // returns 1.0
 ```
 
+<a name="method-to-sorted"></a>
+
+#### Complex128Array.prototype.toSorted( compareFcn )
+
+Returns a new typed array containing the elements in sorted order.
+
+```javascript
+var real = require( '@stdlib/complex/real' );
+var imag = require( '@stdlib/complex/imag' );
+
+function compare( a, b ) {
+    var re1;
+    var re2;
+    var im1;
+    var im2;
+    re1 = real( a );
+    re2 = real( b );
+    if ( re1 < re2 ) {
+        return -1;
+    }
+    if ( re1 > re2 ) {
+        return 1;
+    }
+    im1 = imag( a );
+    im2 = imag( b );
+    if ( im1 < im2 ) {
+        return -1;
+    }
+    if ( im1 > im2 ) {
+        return 1;
+    }
+    return 0;
+}
+
+var arr = new Complex128Array( 3 );
+
+arr.set( [ 3.0, -3.0 ], 0 );
+arr.set( [ 1.0, -1.0 ], 1 );
+arr.set( [ 2.0, -2.0 ], 2 );
+
+var out = arr.toSorted( compare );
+// returns <Complex128Array>
+
+var z = out.get( 0 );
+// returns <Complex128>
+
+var re = real( z );
+// returns 1.0
+
+var im = imag( z );
+// returns -1.0
+
+z = out.get( 1 );
+// returns <Complex128>
+
+re = real( z );
+// returns 2.0
+
+im = imag( z );
+// returns -2.0
+
+z = out.get( 2 );
+// returns <Complex128>
+
+re = real( z );
+// returns 3.0
+
+im = imag( z );
+// returns -3.0
+```
+
+The `compareFcn` determines the order of the elements. The function is called with the following arguments:
+
+-   **a**: the first element for comparison.
+-   **b**: the second element for comparison.
+
+The function should return a number where:
+
+-   a negative value indicates that `a` should come before `b`.
+-   a positive value indicates that `a` should come after `b`.
+-   zero or `NaN` indicates that `a` and `b` are considered equal.
+
 <a name="method-to-string"></a>
 
 #### Complex128Array.prototype.toString()

complex128/benchmark/benchmark.to_sorted.js

@@ -0,0 +1,88 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isComplex128Array = require( '@stdlib/assert/is-complex128array' );
+var real = require( '@stdlib/complex/real' );
+var imag = require( '@stdlib/complex/imag' );
+var pkg = require( './../package.json' ).name;
+var Complex128Array = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Comparison function.
+*
+* @private
+* @param {Complex128} a - first value for comparison
+* @param {Complex128} b - second value for comparison
+* @returns {number} comparison result
+*/
+function compareFcn( a, b ) {
+	var re1;
+	var re2;
+	var im1;
+	var im2;
+	re1 = real( a );
+	re2 = real( b );
+	if ( re1 < re2 ) {
+		return -1;
+	}
+	if ( re1 > re2 ) {
+		return 1;
+	}
+	im1 = imag( a );
+	im2 = imag( b );
+	if ( im1 < im2 ) {
+		return -1;
+	}
+	if ( im1 > im2 ) {
+		return 1;
+	}
+	return 0;
+}
+
+
+// MAIN //
+
+bench( pkg+':toSorted', function benchmark( b ) {
+	var out;
+	var arr;
+	var i;
+
+	arr = new Complex128Array( [ 1, 2, 3, 4, 5, 6 ] );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = arr.toSorted( compareFcn );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isComplex128Array( out ) ) {
+		b.fail( 'should return a Complex128Array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

complex128/benchmark/benchmark.to_sorted.length.js

@@ -0,0 +1,137 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isComplex128Array = require( '@stdlib/assert/is-complex128array' );
+var real = require( '@stdlib/complex/real' );
+var imag = require( '@stdlib/complex/imag' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var Complex128 = require( '@stdlib/complex/float64' );
+var pkg = require( './../package.json' ).name;
+var Complex128Array = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Comparison function.
+*
+* @private
+* @param {Complex128} a - first value for comparison
+* @param {Complex128} b - second value for comparison
+* @returns {number} comparison result
+*/
+function compareFcn( a, b ) {
+	var re1;
+	var re2;
+	var im1;
+	var im2;
+	re1 = real( a );
+	re2 = real( b );
+	if ( re1 < re2 ) {
+		return -1;
+	}
+	if ( re1 > re2 ) {
+		return 1;
+	}
+	im1 = imag( a );
+	im2 = imag( b );
+	if ( im1 < im2 ) {
+		return -1;
+	}
+	if ( im1 > im2 ) {
+		return 1;
+	}
+	return 0;
+}
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var arr;
+	var i;
+
+	arr = [];
+	for ( i = 0; i < len; i++ ) {
+		arr.push( new Complex128( i, i ) );
+	}
+	arr = new Complex128Array( arr );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = arr.toSorted( compareFcn );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an object' );
+			}
+		}
+		b.toc();
+		if ( !isComplex128Array( out ) ) {
+			b.fail( 'should return a Complex128Array' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':toSorted:len='+len, f );
+	}
+}
+
+main();

complex128/docs/types/index.d.ts

@@ -1375,6 +1375,78 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	*/
 	toReversed(): Complex128Array;
 
+	/**
+	* Returns a new typed array containing the elements in sorted order.
+	*
+	* @param compareFcn - comparison function
+	* @returns sorted array
+	*
+	* @example
+	* var real = require( '@stdlib/complex/real' );
+	* var imag = require( '@stdlib/complex/imag' );
+	*
+	* function compare( a, b ) {
+	*     var re1;
+	*     var re2;
+	*     var im1;
+	*     var im2;
+	*     re1 = real( a );
+	*     re2 = real( b );
+	*     if ( re1 < re2 ) {
+	*         return -1;
+	*     }
+	*     if ( re1 > re2 ) {
+	*         return 1;
+	*     }
+	*     im1 = imag( a );
+	*     im2 = imag( b );
+	*     if ( im1 < im2 ) {
+	*         return -1;
+	*     }
+	*     if ( im1 > im2 ) {
+	*         return 1;
+	*     }
+	*     return 0;
+	* }
+	*
+	* var arr = new Complex128Array( 3 );
+	*
+	* arr.set( [ 3.0, -3.0 ], 0 );
+	* arr.set( [ 1.0, -1.0 ], 1 );
+	* arr.set( [ 2.0, -2.0 ], 2 );
+	*
+	* var out = arr.toSorted( compare );
+	* // returns <Complex128Array>
+	*
+	* var z = out.get( 0 );
+	* // returns <Complex128>
+	*
+	* var re = real( z );
+	* // returns 1.0
+	*
+	* var im = imag( z );
+	* // returns -1.0
+	*
+	* z = out.get( 1 );
+	* // returns <Complex128>
+	*
+	* re = real( z );
+	* // returns 2.0
+	*
+	* im = imag( z );
+	* // returns -2.0
+	*
+	* z = out.get( 2 );
+	* // returns <Complex128>
+	*
+	* re = real( z );
+	* // returns 3.0
+	*
+	* im = imag( z );
+	* // returns -3.0
+	*/
+	toSorted( compareFcn: CompareFcn ): Complex128Array;
+
 	/**
 	* Serializes an array as a string.
 	*