-
-
Notifications
You must be signed in to change notification settings - Fork 446
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add
complex/float64/base/assert/is-same-value
Ref: #2260
- Loading branch information
Showing
15 changed files
with
1,164 additions
and
0 deletions.
There are no files selected for viewing
245 changes: 245 additions & 0 deletions
245
lib/node_modules/@stdlib/complex/float64/base/assert/is-same-value/README.md
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,245 @@ | ||
<!-- | ||
@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. | ||
--> | ||
|
||
# isSameValue | ||
|
||
> Test whether two double-precision complex floating-point numbers are the same value. | ||
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
||
<section class="intro"> | ||
|
||
</section> | ||
|
||
<!-- /.intro --> | ||
|
||
<!-- Package usage documentation. --> | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var isSameValue = require( '@stdlib/complex/float64/base/assert/is-same-value' ); | ||
``` | ||
|
||
#### isSameValue( z1, z2 ) | ||
|
||
Tests whether two double-precision complex floating-point numbers are the same value. | ||
|
||
```javascript | ||
var Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
|
||
var z1 = new Complex128( 5.0, 3.0 ); | ||
var z2 = new Complex128( 5.0, 3.0 ); | ||
|
||
var out = isSameValue( z1, z2 ); | ||
// returns true | ||
``` | ||
|
||
In contrast to the strict equality operator `===`, the function distinguishes between `+0` and `-0` and treats `NaNs` as the same value. | ||
|
||
```javascript | ||
var Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
|
||
var z1 = new Complex128( NaN, NaN ); | ||
var z2 = new Complex128( NaN, NaN ); | ||
|
||
var out = isSameValue( z1, z2 ); | ||
// returns true | ||
|
||
z1 = new Complex128( -0.0, 0.0 ); | ||
z2 = new Complex128( 0.0, -0.0 ); | ||
|
||
out = isSameValue( z1, z2 ); | ||
// returns false | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="notes"> | ||
|
||
## Notes | ||
|
||
- The function implements the [SameValue Algorithm][ecma-262-same-value-algorithm] as specified in ECMAScript 5. | ||
|
||
</section> | ||
|
||
<!-- /.notes --> | ||
|
||
<!-- Package usage examples. --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
var isSameValue = require( '@stdlib/complex/float64/base/assert/is-same-value' ); | ||
|
||
var z1 = new Complex128( 5.0, 3.0 ); | ||
var z2 = new Complex128( 5.0, 3.0 ); | ||
var out = isSameValue( z1, z2 ); | ||
// returns true | ||
|
||
z1 = new Complex128( -5.0, -3.0 ); | ||
z2 = new Complex128( 5.0, 3.0 ); | ||
out = isSameValue( z1, z2 ); | ||
// returns false | ||
|
||
z1 = new Complex128( NaN, 3.0 ); | ||
z2 = new Complex128( NaN, 3.0 ); | ||
out = isSameValue( z1, z2 ); | ||
// returns true | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
<!-- C interface documentation. --> | ||
|
||
* * * | ||
|
||
<section class="c"> | ||
|
||
## C APIs | ||
|
||
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
||
<section class="intro"> | ||
|
||
</section> | ||
|
||
<!-- /.intro --> | ||
|
||
<!-- C usage documentation. --> | ||
|
||
<section class="usage"> | ||
|
||
### Usage | ||
|
||
```c | ||
#include "stdlib/complex/float64/base/assert/is_same_value.h" | ||
``` | ||
|
||
#### stdlib_base_complex128_is_same_value( z1, z2 ) | ||
|
||
Tests whether two double-precision complex floating-point numbers are the same value. | ||
|
||
```c | ||
#include "stdlib/complex/float64/ctor.h" | ||
#include <stdbool.h> | ||
|
||
stdlib_complex128_t z1 = stdlib_complex128( 5.0, 2.0 ); | ||
stdlib_complex128_t z2 = stdlib_complex128( 5.0, 2.0 ); | ||
|
||
bool v = stdlib_base_complex128_is_same_value( z1, z2 ); | ||
``` | ||
|
||
The function accepts the following arguments: | ||
|
||
- **z1**: `[in] stdlib_complex128_t` first double-precision complex floating-point number. | ||
- **z2**: `[in] stdlib_complex128_t` second double-precision complex floating-point number. | ||
|
||
```c | ||
bool stdlib_base_complex128_is_same_value( const stdlib_complex128_t z1, const stdlib_complex128_t z2 ); | ||
``` | ||
</section> | ||
<!-- /.usage --> | ||
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
<section class="notes"> | ||
</section> | ||
<!-- /.notes --> | ||
<!-- C API usage examples. --> | ||
<section class="examples"> | ||
### Examples | ||
```c | ||
#include "stdlib/complex/float64/base/assert/is_same_value.h" | ||
#include "stdlib/complex/float64/ctor.h" | ||
#include <stdbool.h> | ||
#include <stdio.h> | ||
int main( void ) { | ||
const stdlib_complex128_t z[] = { | ||
stdlib_complex128( 5.0, 2.0 ), | ||
stdlib_complex128( -2.0, 1.0 ), | ||
stdlib_complex128( 0.0, -0.0 ), | ||
stdlib_complex128( 0.0/0.0, 0.0/0.0 ) | ||
}; | ||
bool v; | ||
int i; | ||
for ( i = 0; i < 4; i++ ) { | ||
v = stdlib_base_complex128_is_same_value( z[ i ], z[ i ] ); | ||
printf( "Same value? %s\n", ( v ) ? "True" : "False" ); | ||
} | ||
} | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
</section> | ||
|
||
<!-- /.c --> | ||
|
||
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="references"> | ||
|
||
</section> | ||
|
||
<!-- /.references --> | ||
|
||
<!-- 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"> | ||
|
||
[ecma-262-same-value-algorithm]: http://ecma-international.org/ecma-262/5.1/#sec-9.12 | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
63 changes: 63 additions & 0 deletions
63
lib/node_modules/@stdlib/complex/float64/base/assert/is-same-value/benchmark/benchmark.js
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,63 @@ | ||
/** | ||
* @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 Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
var randu = require( '@stdlib/random/base/randu' ); | ||
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; | ||
var pkg = require( './../package.json' ).name; | ||
var isSameValue = require( './../lib' ); | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg, function benchmark( b ) { | ||
var z1; | ||
var z2; | ||
var v; | ||
var i; | ||
|
||
z1 = [ | ||
new Complex128( randu(), randu() ), | ||
new Complex128( randu(), randu() ) | ||
]; | ||
z2 = [ | ||
new Complex128( randu(), randu() ), | ||
new Complex128( randu(), randu() ), | ||
z1[ 0 ], | ||
z1[ 1 ] | ||
]; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
v = isSameValue( z1[ i%z1.length ], z2[ i%z2.length ] ); | ||
if ( typeof v !== 'boolean' ) { | ||
b.fail( 'should return a boolean' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( !isBoolean( v ) ) { | ||
b.fail( 'should return a boolean' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
}); |
31 changes: 31 additions & 0 deletions
31
lib/node_modules/@stdlib/complex/float64/base/assert/is-same-value/docs/repl.txt
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,31 @@ | ||
|
||
{{alias}}( z1, z2 ) | ||
Tests whether two double-precision complex floating-point numbers are the | ||
same value. | ||
|
||
The function differs from the `===` operator in that the function treats | ||
`-0` and `+0` as distinct and `NaNs` as the same. | ||
|
||
Parameters | ||
---------- | ||
z1: Complex128 | ||
First complex number. | ||
|
||
z2: Complex128 | ||
Second complex number. | ||
|
||
Returns | ||
------- | ||
out: boolean | ||
Result. | ||
|
||
Examples | ||
-------- | ||
> var z1 = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 ); | ||
> var z2 = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 ); | ||
> var v = {{alias}}( z1, z2 ) | ||
true | ||
|
||
See Also | ||
-------- | ||
|
51 changes: 51 additions & 0 deletions
51
lib/node_modules/@stdlib/complex/float64/base/assert/is-same-value/docs/types/index.d.ts
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,51 @@ | ||
/* | ||
* @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 | ||
|
||
import Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
|
||
/** | ||
* Tests whether two double-precision complex floating-point numbers are the same value. | ||
* | ||
* ## Notes | ||
* | ||
* - The function implements the [SameValue Algorithm][ecma-262-same-value-algorithm], as specified in ECMAScript 5. | ||
* - In contrast to the strict equality operator `===`, `-0` and `+0` are distinguishable and `NaNs` are the same. | ||
* | ||
* [ecma-262-same-value-algorithm]: http://ecma-international.org/ecma-262/5.1/#sec-9.12 | ||
* | ||
* @param z1 - first complex number | ||
* @param z2 - second complex number | ||
* @returns boolean indicating if both complex numbers are the same value | ||
* | ||
* @example | ||
* var Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
* | ||
* var z1 = new Complex128( 5.0, 3.0 ); | ||
* var z2 = new Complex128( 5.0, 3.0 ); | ||
* | ||
* var v = isSameValue( z1, z2 ); | ||
* // returns true | ||
*/ | ||
declare function isSameValue( z1: Complex128, z2: Complex128 ): boolean; | ||
|
||
|
||
// EXPORTS // | ||
|
||
export = isSameValue; |
Oops, something went wrong.