Skip to content

Commit e05b036

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 75f3fb7 commit e05b036

File tree

12 files changed

+732
-0
lines changed

12 files changed

+732
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
### Features
1212

13+
- [`65e3870`](https://github.com/stdlib-js/stdlib/commit/65e38704c7e278a8fa452206d754985320f4e856) - add `isAlmostSameValueFloat64Array` to namespace
14+
- [`61369f9`](https://github.com/stdlib-js/stdlib/commit/61369f9d16a72fadaddb9c7b0a0d066eb85ec4d1) - add `assert/is-almost-same-value-float64array`
1315
- [`392d959`](https://github.com/stdlib-js/stdlib/commit/392d95908d63ba926d6c8eff4dcbe88fd7c7dc11) - add `isAlmostSameValueArray` to namespace
1416
- [`0146356`](https://github.com/stdlib-js/stdlib/commit/01463564c79fa3129032cd6cea71e9c4087a1f11) - add `assert/is-almost-same-value-array`
1517
- [`34719c7`](https://github.com/stdlib-js/stdlib/commit/34719c7f19f4bd3df5f6e0a9bc821f991ffe4696) - update `assert` TypeScript declarations [(#9197)](https://github.com/stdlib-js/stdlib/pull/9197)
@@ -147,6 +149,8 @@ A total of 30 issues were closed in this release:
147149

148150
<details>
149151

152+
- [`65e3870`](https://github.com/stdlib-js/stdlib/commit/65e38704c7e278a8fa452206d754985320f4e856) - **feat:** add `isAlmostSameValueFloat64Array` to namespace _(by Athan Reines)_
153+
- [`61369f9`](https://github.com/stdlib-js/stdlib/commit/61369f9d16a72fadaddb9c7b0a0d066eb85ec4d1) - **feat:** add `assert/is-almost-same-value-float64array` _(by Athan Reines)_
150154
- [`8a20a3e`](https://github.com/stdlib-js/stdlib/commit/8a20a3e35f760bc807bdd9cf3916c660b90b1dd0) - **docs:** fix broken Markdown links in `zswap`, `ssyr2`, and `assert` packages [(#9161)](https://github.com/stdlib-js/stdlib/pull/9161) _(by Almunazza, Philipp Burckhardt)_
151155
- [`392d959`](https://github.com/stdlib-js/stdlib/commit/392d95908d63ba926d6c8eff4dcbe88fd7c7dc11) - **feat:** add `isAlmostSameValueArray` to namespace _(by Athan Reines)_
152156
- [`128202e`](https://github.com/stdlib-js/stdlib/commit/128202ea18e04412d163782a359b9237675b5ffc) - **bench:** use string interpolation _(by Athan Reines)_

‎is-almost-same-value-float64array/README.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# isAlmostSameValueFloat64Array
22+
23+
> Test if two arguments are both [Float64Arrays][@stdlib/array/float64] and contain respective elements which are [approximately the same value][@stdlib/assert/is-almost-same-value] within a specified number of ULPs (units in the last place).
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
<!-- eslint-disable id-length -->
30+
31+
```javascript
32+
var isAlmostSameValueFloat64Array = require( '@stdlib/assert/is-almost-same-value-float64array' );
33+
```
34+
35+
#### isAlmostSameValueFloat64Array( v1, v2, maxULP )
36+
37+
Tests if two arguments are both [Float64Arrays][@stdlib/array/float64] and contain respective elements which are [approximately the same value][@stdlib/assert/is-almost-same-value] within a specified number of ULPs (units in the last place).
38+
39+
<!-- eslint-disable id-length -->
40+
41+
```javascript
42+
var EPS = require( '@stdlib/constants/float64/eps' );
43+
var Float64Array = require( '@stdlib/array/float64' );
44+
45+
var x = new Float64Array( [ 1.0, 2.0 ] );
46+
var y = new Float64Array( [ 1.0+EPS, 2.0 ] );
47+
48+
var bool = isAlmostSameValueFloat64Array( x, y, 0 );
49+
// returns false
50+
51+
bool = isAlmostSameValueFloat64Array( x, y, 1 );
52+
// returns true
53+
54+
bool = isAlmostSameValueFloat64Array( x, [ 1.0, 2.0 ], 1 );
55+
// returns false
56+
```
57+
58+
</section>
59+
60+
<!-- /.usage -->
61+
62+
<section class="notes">
63+
64+
</section>
65+
66+
<!-- /.notes -->
67+
68+
<section class="examples">
69+
70+
## Examples
71+
72+
<!-- eslint-disable id-length -->
73+
74+
<!-- eslint no-undef: "error" -->
75+
76+
```javascript
77+
var Float64Array = require( '@stdlib/array/float64' );
78+
var isAlmostSameValueFloat64Array = require( '@stdlib/assert/is-almost-same-value-float64array' );
79+
80+
var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
81+
var y = new Float64Array( [ 1.0, 2.0, 3.0 ] );
82+
var out = isAlmostSameValueFloat64Array( x, y, 0 );
83+
// returns true
84+
85+
x = new Float64Array( [ -0.0, 0.0, -0.0 ] );
86+
y = new Float64Array( [ 0.0, -0.0, 0.0 ] );
87+
out = isAlmostSameValueFloat64Array( x, y, 0 );
88+
// returns false
89+
90+
x = new Float64Array( [ NaN, NaN, NaN ] );
91+
y = new Float64Array( [ NaN, NaN, NaN ] );
92+
out = isAlmostSameValueFloat64Array( x, y, 0 );
93+
// returns true
94+
```
95+
96+
</section>
97+
98+
<!-- /.examples -->
99+
100+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
101+
102+
<section class="related">
103+
104+
</section>
105+
106+
<!-- /.related -->
107+
108+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
109+
110+
<section class="links">
111+
112+
[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64
113+
114+
[@stdlib/assert/is-almost-same-value]: https://github.com/stdlib-js/assert/tree/main/is-almost-same-value
115+
116+
</section>
117+
118+
<!-- /.links -->

‎is-almost-same-value-float64array/benchmark/benchmark.length.js‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isBoolean = require( './../../is-boolean' ).isPrimitive;
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var zeroTo = require( '@stdlib/array/base/zero-to' );
27+
var Float64Array = require( '@stdlib/array/float64' );
28+
var format = require( '@stdlib/string/format' );
29+
var pkg = require( './../package.json' ).name;
30+
var isAlmostSameValueFloat64Array = require( './../lib' ); // eslint-disable-line id-length
31+
32+
33+
// FUNCTIONS //
34+
35+
/**
36+
* Creates a benchmark function.
37+
*
38+
* @private
39+
* @param {PositiveInteger} len - array length
40+
* @returns {Function} benchmark function
41+
*/
42+
function createBenchmark( len ) {
43+
var x = new Float64Array( zeroTo( len ) );
44+
var y = new Float64Array( zeroTo( len ) );
45+
return benchmark;
46+
47+
/**
48+
* Benchmark function.
49+
*
50+
* @private
51+
* @param {Benchmark} b - benchmark instance
52+
*/
53+
function benchmark( b ) {
54+
var bool;
55+
var i;
56+
57+
b.tic();
58+
for ( i = 0; i < b.iterations; i++ ) {
59+
bool = isAlmostSameValueFloat64Array( x, y, 1 );
60+
if ( typeof bool !== 'boolean' ) {
61+
b.fail( 'should return a boolean' );
62+
}
63+
}
64+
b.toc();
65+
if ( !isBoolean( bool ) ) {
66+
b.fail( 'should return a boolean' );
67+
}
68+
b.pass( 'benchmark finished' );
69+
b.end();
70+
}
71+
}
72+
73+
74+
// MAIN //
75+
76+
/**
77+
* Main execution sequence.
78+
*
79+
* @private
80+
*/
81+
function main() {
82+
var len;
83+
var min;
84+
var max;
85+
var f;
86+
var i;
87+
88+
min = 1; // 10^min
89+
max = 6; // 10^max
90+
91+
for ( i = min; i <= max; i++ ) {
92+
len = pow( 10, i );
93+
f = createBenchmark( len );
94+
bench( format( '%s:len=%d', pkg, len ), f );
95+
}
96+
}
97+
98+
main();

‎is-almost-same-value-float64array/docs/repl.txt‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
{{alias}}( v1, v2, maxULP )
3+
Tests if two arguments are both Float64Arrays and contain respective
4+
elements which are approximately the same value within a specified number of
5+
ULPs (units in the last place).
6+
7+
The function differs from the `===` operator in that the function treats
8+
`-0` and `+0` as distinct and `NaNs` as the same.
9+
10+
Parameters
11+
----------
12+
v1: any
13+
First input value.
14+
15+
v2: any
16+
Second input value.
17+
18+
maxULP: integer
19+
Maximum allowed ULP difference.
20+
21+
Returns
22+
-------
23+
bool: boolean
24+
Boolean indicating whether two arguments are approximately the same
25+
value.
26+
27+
Examples
28+
--------
29+
> var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0 ] );
30+
> var y = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0 ] );
31+
> var bool = {{alias}}( x, y, 1 )
32+
true
33+
34+
> x = new {{alias:@stdlib/array/float64}}( [ NaN, NaN, NaN ] );
35+
> y = new {{alias:@stdlib/array/float64}}( [ NaN, NaN, NaN ] );
36+
> bool = {{alias}}( x, y, 1 )
37+
true
38+
39+
See Also
40+
--------
41+

‎is-almost-same-value-float64array/docs/types/index.d.ts‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/**
22+
* Tests if two arguments are both Float64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).
23+
*
24+
* ## Notes
25+
*
26+
* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same.
27+
*
28+
* @param v1 - first input value
29+
* @param v2 - second input value
30+
* @param maxULP - maximum allowed ULP difference
31+
* @returns boolean indicating whether two arguments are approximately the same value
32+
*
33+
* @example
34+
* var Float64Array = require( '@stdlib/array/float64' );
35+
*
36+
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
37+
* var y = new Float64Array( [ 1.0, 2.0, 3.0 ] );
38+
*
39+
* var out = isAlmostSameValueFloat64Array( x, y, 0 );
40+
* // returns true
41+
*
42+
* @example
43+
* var Float64Array = require( '@stdlib/array/float64' );
44+
*
45+
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
46+
* var y = new Float64Array( [ 1.0, 2.0, 4.0 ] );
47+
*
48+
* var out = isAlmostSameValueFloat64Array( x, y, 1 );
49+
* // returns false
50+
*/
51+
declare function isAlmostSameValueFloat64Array( v1: any, v2: any, maxULP: number ): boolean;
52+
53+
54+
// EXPORTS //
55+
56+
export = isAlmostSameValueFloat64Array;

‎is-almost-same-value-float64array/docs/types/test.ts‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
import isAlmostSameValueFloat64Array = require( './index' );
20+
21+
22+
// TESTS //
23+
24+
// The function returns a boolean...
25+
{
26+
isAlmostSameValueFloat64Array( 3.14, 3.14, 1 ); // $ExpectType boolean
27+
isAlmostSameValueFloat64Array( null, null, 1 ); // $ExpectType boolean
28+
isAlmostSameValueFloat64Array( 'beep', 'boop', 1 ); // $ExpectType boolean
29+
}
30+
31+
// The compiler throws an error if the function is provided a third argument which is not a number...
32+
{
33+
isAlmostSameValueFloat64Array( 3.14, 3.14, '1' ); // $ExpectError
34+
isAlmostSameValueFloat64Array( 3.14, 3.14, true ); // $ExpectError
35+
isAlmostSameValueFloat64Array( 3.14, 3.14, false ); // $ExpectError
36+
isAlmostSameValueFloat64Array( 3.14, 3.14, null ); // $ExpectError
37+
isAlmostSameValueFloat64Array( 3.14, 3.14, undefined ); // $ExpectError
38+
isAlmostSameValueFloat64Array( 3.14, 3.14, [] ); // $ExpectError
39+
isAlmostSameValueFloat64Array( 3.14, 3.14, {} ); // $ExpectError
40+
isAlmostSameValueFloat64Array( 3.14, 3.14, ( x: number ): number => x ); // $ExpectError
41+
}
42+
43+
// The compiler throws an error if the function is provided an unsupported number of arguments...
44+
{
45+
isAlmostSameValueFloat64Array(); // $ExpectError
46+
isAlmostSameValueFloat64Array( 3.14 ); // $ExpectError
47+
isAlmostSameValueFloat64Array( 3.14, 3.14 ); // $ExpectError
48+
isAlmostSameValueFloat64Array( 'beep', 'beep', 2, {} ); // $ExpectError
49+
}

0 commit comments

Comments
 (0)