-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9874039
commit 60427ff
Showing
13 changed files
with
692 additions
and
5 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
<!-- | ||
@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. | ||
--> | ||
|
||
# isSameComplex64Array | ||
|
||
> Test if two arguments are both [Complex64Arrays][@stdlib/array/complex64] and have the [same values][@stdlib/assert/is-same-value]. | ||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' ); | ||
``` | ||
|
||
#### isSameComplex64Array( v1, v2 ) | ||
|
||
Tests if two arguments are both [Complex64Arrays][@stdlib/array/complex64] and have the [same values][@stdlib/assert/is-same-value]. | ||
|
||
```javascript | ||
var Complex64Array = require( '@stdlib/array/complex64' ); | ||
|
||
var x = new Complex64Array( [ 1.0, 2.0 ] ); | ||
var y = new Complex64Array( [ 1.0, 2.0 ] ); | ||
var bool = isSameComplex64Array( x, y ); | ||
// returns true | ||
|
||
bool = isSameComplex64Array( x, [ 1.0, 2.0 ] ); | ||
// returns false | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="notes"> | ||
|
||
## Notes | ||
|
||
- In contrast to the strict equality operator `===`, the function distinguishes between `+0` and `-0` and treats `NaNs` as the [same value][@stdlib/assert/is-same-value]. | ||
|
||
</section> | ||
|
||
<!-- /.notes --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var Complex64Array = require( '@stdlib/array/complex64' ); | ||
var isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' ); | ||
|
||
var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
var out = isSameComplex64Array( x, y ); | ||
// returns true | ||
|
||
x = new Complex64Array( [ -0.0, 0.0, -0.0, 0.0 ] ); | ||
y = new Complex64Array( [ 0.0, -0.0, 0.0, -0.0 ] ); | ||
out = isSameComplex64Array( x, y ); | ||
// returns false | ||
|
||
x = new Complex64Array( [ NaN, NaN, NaN, NaN ] ); | ||
y = new Complex64Array( [ NaN, NaN, NaN, NaN ] ); | ||
out = isSameComplex64Array( x, y ); | ||
// returns true | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
||
<section class="related"> | ||
|
||
</section> | ||
|
||
<!-- /.related --> | ||
|
||
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="links"> | ||
|
||
[@stdlib/array/complex64]: https://github.com/stdlib-js/array-complex64 | ||
|
||
[@stdlib/assert/is-same-value]: https://github.com/stdlib-js/assert/tree/main/is-same-value | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
/** | ||
* @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 isBoolean = require( './../../is-boolean' ).isPrimitive; | ||
var pow = require( '@stdlib/math/base/special/pow' ); | ||
var zeroTo = require( '@stdlib/array/base/zero-to' ); | ||
var Complex64Array = require( '@stdlib/array/complex64' ); | ||
var pkg = require( './../package.json' ).name; | ||
var isSameComplex64Array = require( './../lib' ); | ||
|
||
|
||
// FUNCTIONS // | ||
|
||
/** | ||
* Creates a benchmark function. | ||
* | ||
* @private | ||
* @param {PositiveInteger} len - array length | ||
* @returns {Function} benchmark function | ||
*/ | ||
function createBenchmark( len ) { | ||
var x = new Complex64Array( zeroTo( len*2 ) ); | ||
var y = new Complex64Array( zeroTo( len*2 ) ); | ||
return benchmark; | ||
|
||
/** | ||
* Benchmark function. | ||
* | ||
* @private | ||
* @param {Benchmark} b - benchmark instance | ||
*/ | ||
function benchmark( b ) { | ||
var bool; | ||
var i; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
bool = isSameComplex64Array( x, y ); | ||
if ( typeof bool !== 'boolean' ) { | ||
b.fail( 'should return a boolean' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( !isBoolean( bool ) ) { | ||
b.fail( 'should return a boolean' ); | ||
} | ||
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+':len='+len, f ); | ||
} | ||
} | ||
|
||
main(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
|
||
{{alias}}( v1, v2 ) | ||
Tests if two arguments are both Complex64Arrays and have the same values. | ||
|
||
The function differs from the `===` operator in that the function treats | ||
`-0` and `+0` as distinct and `NaNs` as the same. | ||
|
||
Parameters | ||
---------- | ||
v1: any | ||
First input value. | ||
|
||
v2: any | ||
Second input value. | ||
|
||
Returns | ||
------- | ||
bool: boolean | ||
Boolean indicating whether two arguments are the same. | ||
|
||
Examples | ||
-------- | ||
> var x = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
> var y = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
> var bool = {{alias}}( x, y ) | ||
true | ||
|
||
> x = new {{alias:@stdlib/array/complex64}}( [ NaN, NaN, NaN, NaN ] ); | ||
> y = new {{alias:@stdlib/array/complex64}}( [ NaN, NaN, NaN, NaN ] ); | ||
> bool = {{alias}}( x, y ) | ||
true | ||
|
||
See Also | ||
-------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/* | ||
* @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. | ||
*/ | ||
|
||
// TypeScript Version: 4.1 | ||
|
||
/** | ||
* Tests if two arguments are both Complex64Arrays and have the same values. | ||
* | ||
* ## Notes | ||
* | ||
* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same. | ||
* | ||
* @param v1 - first input value | ||
* @param v2 - second input value | ||
* @returns boolean indicating whether two arguments are the same | ||
* | ||
* @example | ||
* var Complex64Array = require( '@stdlib/array/complex64' ); | ||
* | ||
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
* | ||
* var out = isSameComplex64Array( x, y ); | ||
* // returns true | ||
* | ||
* @example | ||
* var Complex64Array = require( '@stdlib/array/complex64' ); | ||
* | ||
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
* var y = new Complex64Array( [ 1.0, 2.0, 4.0, 4.0 ] ); | ||
* | ||
* var out = isSameComplex64Array( x, y ); | ||
* // returns false | ||
*/ | ||
declare function isSameComplex64Array( v1: any, v2: any ): boolean; | ||
|
||
|
||
// EXPORTS // | ||
|
||
export = isSameComplex64Array; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
/* | ||
* @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. | ||
*/ | ||
|
||
import isSameComplex64Array = require( './index' ); | ||
|
||
|
||
// TESTS // | ||
|
||
// The function returns a boolean... | ||
{ | ||
isSameComplex64Array( 3.14, 3.14 ); // $ExpectType boolean | ||
isSameComplex64Array( null, null ); // $ExpectType boolean | ||
isSameComplex64Array( 'beep', 'boop' ); // $ExpectType boolean | ||
} | ||
|
||
// The compiler throws an error if the function is provided an unsupported number of arguments... | ||
{ | ||
isSameComplex64Array(); // $ExpectError | ||
isSameComplex64Array( 3.14 ); // $ExpectError | ||
isSameComplex64Array( 'beep', 'beep', 3.14 ); // $ExpectError | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
/** | ||
* @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'; | ||
|
||
var Complex64Array = require( '@stdlib/array/complex64' ); | ||
var isSameComplex64Array = require( './../lib' ); | ||
|
||
var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
var out = isSameComplex64Array( x, y ); | ||
console.log( out ); | ||
// => true | ||
|
||
x = new Complex64Array( [ -0.0, 0.0, -0.0, 0.0 ] ); | ||
y = new Complex64Array( [ 0.0, -0.0, 0.0, -0.0 ] ); | ||
out = isSameComplex64Array( x, y ); | ||
console.log( out ); | ||
// => false | ||
|
||
x = new Complex64Array( [ NaN, NaN, NaN, NaN ] ); | ||
y = new Complex64Array( [ NaN, NaN, NaN, NaN ] ); | ||
out = isSameComplex64Array( x, y ); | ||
console.log( out ); | ||
// => true |
Oops, something went wrong.