From 8064435f494bad150afc7ce1edc27a6e59f6b612 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 24 May 2024 08:39:19 +0000 Subject: [PATCH] Auto-generated commit --- complex128/README.md | 82 ++++++++ complex128/benchmark/benchmark.sort.js | 88 +++++++++ complex128/benchmark/benchmark.sort.length.js | 137 +++++++++++++ complex128/docs/types/index.d.ts | 81 ++++++++ complex128/lib/main.js | 102 ++++++++++ complex128/test/test.sort.js | 181 ++++++++++++++++++ 6 files changed, 671 insertions(+) create mode 100644 complex128/benchmark/benchmark.sort.js create mode 100644 complex128/benchmark/benchmark.sort.length.js create mode 100644 complex128/test/test.sort.js diff --git a/complex128/README.md b/complex128/README.md index 3809b9dc..2145d65f 100644 --- a/complex128/README.md +++ b/complex128/README.md @@ -2091,6 +2091,88 @@ var count = context.count; // returns 2 ``` + + +#### Complex128Array.prototype.sort( compareFcn ) + +Sorts an array in-place. + +```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.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 +``` + +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. + #### Complex128Array.prototype.subarray( \[begin\[, end]] ) diff --git a/complex128/benchmark/benchmark.sort.js b/complex128/benchmark/benchmark.sort.js new file mode 100644 index 00000000..5da4b985 --- /dev/null +++ b/complex128/benchmark/benchmark.sort.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+':sort', 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.sort( 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(); +}); diff --git a/complex128/benchmark/benchmark.sort.length.js b/complex128/benchmark/benchmark.sort.length.js new file mode 100644 index 00000000..52d6f5ec --- /dev/null +++ b/complex128/benchmark/benchmark.sort.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.sort( 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+':sort:len='+len, f ); + } +} + +main(); diff --git a/complex128/docs/types/index.d.ts b/complex128/docs/types/index.d.ts index 0d186363..2c1069f9 100644 --- a/complex128/docs/types/index.d.ts +++ b/complex128/docs/types/index.d.ts @@ -259,6 +259,15 @@ type QuaternaryReducer = ( acc: U, value: Complex128, index: number, arr: Com */ type Reducer = NullaryReducer | UnaryReducer | BinaryReducer | TernaryReducer | QuaternaryReducer; +/** +* Comparator function. +* +* @param a - first value for comparison +* @param b - second value for comparison +* @returns number indicating comparison result +*/ +type CompareFcn = ( a: Complex128, b: Complex128 ) => number; + /** * Class for creating a 128-bit complex number array. */ @@ -1159,6 +1168,78 @@ declare class Complex128Array implements Complex128ArrayInterface { */ some( predicate: Predicate, thisArg?: ThisParameterType> ): boolean; + /** + * Sorts an array in-place. + * + * @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.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 + */ + sort( compareFcn: CompareFcn ): Complex128Array; + /** * Creates a new typed array view over the same underlying `ArrayBuffer` and with the same underlying data type as the host array. * diff --git a/complex128/lib/main.js b/complex128/lib/main.js index a6577b9b..469b6028 100644 --- a/complex128/lib/main.js +++ b/complex128/lib/main.js @@ -2370,6 +2370,108 @@ setReadOnly( Complex128Array.prototype, 'some', function some( predicate, thisAr return false; }); +/** +* Sorts an array in-place. +* +* @name sort +* @memberof Complex128Array.prototype +* @type {Function} +* @param {Function} compareFcn - comparison function +* @throws {TypeError} `this` must be a complex number array +* @throws {TypeError} first argument must be a function +* @returns {Complex128Array} 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.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 +*/ +setReadOnly( Complex128Array.prototype, 'sort', function sort( compareFcn ) { + var tmp; + var buf; + var len; + var i; + var j; + if ( !isComplexArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a complex number array.' ); + } + if ( !isFunction( compareFcn ) ) { + throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', compareFcn ) ); + } + buf = this._buffer; + len = this._length; + tmp = []; + for ( i = 0; i < len; i++ ) { + tmp.push( getComplex128( buf, i ) ); + } + tmp.sort( compareFcn ); + for ( i = 0; i < len; i++ ) { + j = 2 * i; + buf[ j ] = real( tmp[i] ); + buf[ j+1 ] = imag( tmp[i] ); + } + return this; +}); + /** * Creates a new typed array view over the same underlying `ArrayBuffer` and with the same underlying data type as the host array. * diff --git a/complex128/test/test.sort.js b/complex128/test/test.sort.js new file mode 100644 index 00000000..a2d36b7b --- /dev/null +++ b/complex128/test/test.sort.js @@ -0,0 +1,181 @@ +/** +* @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 tape = require( 'tape' ); +var hasOwnProp = require( '@stdlib/assert/has-own-property' ); +var isFunction = require( '@stdlib/assert/is-function' ); +var real = require( '@stdlib/complex/real' ); +var reinterpret128 = require( '@stdlib/strided/base/reinterpret-complex128' ); +var instanceOf = require( '@stdlib/assert/instance-of' ); +var imag = require( '@stdlib/complex/imag' ); +var Float64Array = require( './../../float64' ); +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; +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof Complex128Array, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'attached to the prototype of the main export is a `sort` method', function test( t ) { + t.strictEqual( hasOwnProp( Complex128Array.prototype, 'sort' ), true, 'has property' ); + t.strictEqual( isFunction( Complex128Array.prototype.sort ), true, 'has method' ); + t.end(); +}); + +tape( 'the method throws an error if invoked with a `this` context which is not a complex number array instance', function test( t ) { + var values; + var arr; + var i; + + arr = new Complex128Array( 5 ); + + values = [ + '5', + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + function noop() {} + ]; + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + return arr.sort.call( value, compareFcn ); + }; + } +}); + +tape( 'the method throws an error if provided a first argument which is not a function', function test( t ) { + var values; + var arr; + var i; + + arr = new Complex128Array( 10 ); + + values = [ + '5', + 3.14, + NaN, + true, + false, + null, + void 0, + {}, + [] + ]; + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + return arr.sort( value ); + }; + } +}); + +tape( 'the method returns an empty array if operating on an empty complex number array', function test( t ) { + var arr; + var out; + + arr = new Complex128Array(); + out = arr.sort( compareFcn ); + + t.strictEqual( out.buffer, arr.buffer, 'returns expected value' ); + t.strictEqual( out.length, 0, 'returns expected value' ); + t.end(); +}); + +tape( 'the method sorts elements of a complex number array in-place', function test( t ) { + var expected; + var arr; + var out; + + arr = new Complex128Array( [ 3.0, -3.0, 1.0, -1.0, 2.0, -2.0 ] ); + expected = new Float64Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] ); + out = arr.sort( compareFcn ); + + t.strictEqual( instanceOf( arr, Complex128Array ), true, 'returns expected value' ); + t.strictEqual( out, arr, 'returns expected value' ); + t.strictEqual( arr.length, expected.length/2, 'returns expected value' ); + t.deepEqual( reinterpret128( arr, 0 ), expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the method does not change the array length', function test( t ) { + var arr; + var out; + + arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] ); + out = arr.sort( compareFcn ); + + t.strictEqual( out.length, arr.length, 'returns expected value' ); + t.end(); +});