Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed May 24, 2024
1 parent fbc0e58 commit c2f6104
Show file tree
Hide file tree
Showing 8 changed files with 658 additions and 3 deletions.
82 changes: 82 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2375,6 +2375,88 @@ im = imagf( z );
// returns 1.0
```

<a name="method-to-sorted"></a>

#### Complex64Array.prototype.toSorted( compareFcn )

Returns a new typed array containing the elements in sorted order.

```javascript
var realf = require( '@stdlib/complex-realf' );
var imagf = require( '@stdlib/complex-imagf' );

function compare( a, b ) {
var re1;
var re2;
var im1;
var im2;
re1 = realf( a );
re2 = realf( b );
if ( re1 < re2 ) {
return -1;
}
if ( re1 > re2 ) {
return 1;
}
im1 = imagf( a );
im2 = imagf( b );
if ( im1 < im2 ) {
return -1;
}
if ( im1 > im2 ) {
return 1;
}
return 0;
}

var arr = new Complex64Array( 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 <Complex64Array>

var z = out.get( 0 );
// returns <Complex64>

var re = realf( z );
// returns 1.0

var im = imagf( z );
// returns -1.0

z = out.get( 1 );
// returns <Complex64>

re = realf( z );
// returns 2.0

im = imagf( z );
// returns -2.0

z = out.get( 2 );
// returns <Complex64>

re = realf( z );
// returns 3.0

im = imagf( 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>

#### Complex64Array.prototype.toString()
Expand Down
88 changes: 88 additions & 0 deletions benchmark/benchmark.to_sorted.js
Original file line number Diff line number Diff line change
@@ -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-harness' );
var isComplex64Array = require( '@stdlib/assert-is-complex64array' );
var realf = require( '@stdlib/complex-realf' );
var imagf = require( '@stdlib/complex-imagf' );
var pkg = require( './../package.json' ).name;
var Complex64Array = require( './../lib' );


// FUNCTIONS //

/**
* Comparison function.
*
* @private
* @param {Complex64} a - first value for comparison
* @param {Complex64} b - second value for comparison
* @returns {number} comparison result
*/
function compareFcn( a, b ) {
var re1;
var re2;
var im1;
var im2;
re1 = realf( a );
re2 = realf( b );
if ( re1 < re2 ) {
return -1;
}
if ( re1 > re2 ) {
return 1;
}
im1 = imagf( a );
im2 = imagf( 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 Complex64Array( [ 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 ( !isComplex64Array( out ) ) {
b.fail( 'should return a Complex64Array' );
}
b.pass( 'benchmark finished' );
b.end();
});
137 changes: 137 additions & 0 deletions benchmark/benchmark.to_sorted.length.js
Original file line number Diff line number Diff line change
@@ -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-harness' );
var isComplex64Array = require( '@stdlib/assert-is-complex64array' );
var realf = require( '@stdlib/complex-realf' );
var imagf = require( '@stdlib/complex-imagf' );
var pow = require( '@stdlib/math-base-special-pow' );
var Complex64 = require( '@stdlib/complex-float32' );
var pkg = require( './../package.json' ).name;
var Complex64Array = require( './../lib' );


// FUNCTIONS //

/**
* Comparison function.
*
* @private
* @param {Complex64} a - first value for comparison
* @param {Complex64} b - second value for comparison
* @returns {number} comparison result
*/
function compareFcn( a, b ) {
var re1;
var re2;
var im1;
var im2;
re1 = realf( a );
re2 = realf( b );
if ( re1 < re2 ) {
return -1;
}
if ( re1 > re2 ) {
return 1;
}
im1 = imagf( a );
im2 = imagf( 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 Complex64( i, i ) );
}
arr = new Complex64Array( 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 ( !isComplex64Array( out ) ) {
b.fail( 'should return a Complex64Array' );
}
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();
2 changes: 1 addition & 1 deletion dist/index.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dist/index.js.map

Large diffs are not rendered by default.

72 changes: 72 additions & 0 deletions docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1377,6 +1377,78 @@ declare class Complex64Array implements Complex64ArrayInterface {
*/
toReversed(): Complex64Array;

/**
* Returns a new typed array containing the elements in sorted order.
*
* @param compareFcn - comparison function
* @returns sorted array
*
* @example
* var realf = require( '@stdlib/complex-realf' );
* var imagf = require( '@stdlib/complex-imagf' );
*
* function compare( a, b ) {
* var re1;
* var re2;
* var im1;
* var im2;
* re1 = realf( a );
* re2 = realf( b );
* if ( re1 < re2 ) {
* return -1;
* }
* if ( re1 > re2 ) {
* return 1;
* }
* im1 = imagf( a );
* im2 = imagf( b );
* if ( im1 < im2 ) {
* return -1;
* }
* if ( im1 > im2 ) {
* return 1;
* }
* return 0;
* }
*
* var arr = new Complex64Array( 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 <Complex64Array>
*
* var z = out.get( 0 );
* // returns <Complex64>
*
* var re = realf( z );
* // returns 1.0
*
* var im = imagf( z );
* // returns -1.0
*
* z = out.get( 1 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 2.0
*
* im = imagf( z );
* // returns -2.0
*
* z = out.get( 2 );
* // returns <Complex64>
*
* re = realf( z );
* // returns 3.0
*
* im = imagf( z );
* // returns -3.0
*/
toSorted( compareFcn: CompareFcn ): Complex64Array;

/**
* Serializes an array as a string.
*
Expand Down
Loading

0 comments on commit c2f6104

Please sign in to comment.