Skip to content

Commit 6cea25a

Browse files
anandkaranubcanandkaranubc
committed
fix: rename function
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 1be4db1 commit 6cea25a

File tree

8 files changed

+76
-76
lines changed

8 files changed

+76
-76
lines changed

‎lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-equal/README.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ limitations under the License.
1818
1919
-->
2020

21-
# isAlmostEqual
21+
# isAlmostEqualf
2222

2323
> Test whether two single-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).
2424
@@ -37,10 +37,10 @@ limitations under the License.
3737
## Usage
3838

3939
```javascript
40-
var isAlmostEqual = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
40+
var isAlmostEqualf = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
4141
```
4242

43-
#### isAlmostEqual( z1, z2, maxULP )
43+
#### isAlmostEqualf( z1, z2, maxULP )
4444

4545
Tests whether two single-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).
4646

@@ -51,10 +51,10 @@ var Complex64 = require( '@stdlib/complex/float32/ctor' );
5151
var z1 = new Complex64( 1.0, 3.0 );
5252
var z2 = new Complex64( 1.0+EPS, 3.0 );
5353

54-
var out = isAlmostEqual( z1, z2, 0 );
54+
var out = isAlmostEqualf( z1, z2, 0 );
5555
// returns false
5656

57-
out = isAlmostEqual( z1, z2, 1 );
57+
out = isAlmostEqualf( z1, z2, 1 );
5858
// returns true
5959
```
6060

@@ -66,16 +66,16 @@ var Complex64 = require( '@stdlib/complex/float32/ctor' );
6666
var z1 = new Complex64( NaN, 3.0 );
6767
var z2 = new Complex64( 1.0, 3.0 );
6868

69-
var out = isAlmostEqual( z1, z2, 1 );
69+
var out = isAlmostEqualf( z1, z2, 1 );
7070
// returns false
7171

72-
out = isAlmostEqual( z2, z1, 1 );
72+
out = isAlmostEqualf( z2, z1, 1 );
7373
// returns false
7474

7575
z1 = new Complex64( NaN, NaN );
7676
z2 = new Complex64( NaN, NaN );
7777

78-
out = isAlmostEqual( z1, z2, 1 );
78+
out = isAlmostEqualf( z1, z2, 1 );
7979
// returns false
8080
```
8181

@@ -87,7 +87,7 @@ var Complex64 = require( '@stdlib/complex/float32/ctor' );
8787
var z1 = new Complex64( 0.0, 0.0 );
8888
var z2 = new Complex64( -0.0, -0.0 );
8989

90-
var out = isAlmostEqual( z1, z2, 0 );
90+
var out = isAlmostEqualf( z1, z2, 0 );
9191
// returns true
9292
```
9393

@@ -114,26 +114,26 @@ var out = isAlmostEqual( z1, z2, 0 );
114114
```javascript
115115
var EPS = require( '@stdlib/constants/float32/eps' );
116116
var Complex64 = require( '@stdlib/complex/float32/ctor' );
117-
var isAlmostEqual = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
117+
var isAlmostEqualf = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
118118

119119
var z1 = new Complex64( 1.0, 3.0+EPS );
120120
var z2 = new Complex64( 1.0+EPS, 3.0 );
121-
console.log( isAlmostEqual( z1, z2, 1 ) );
121+
console.log( isAlmostEqualf( z1, z2, 1 ) );
122122
// => true
123123

124124
z1 = new Complex64( 1.0, 3.0+EPS );
125125
z2 = new Complex64( 1.0+EPS+EPS, 3.0 );
126-
console.log( isAlmostEqual( z1, z2, 1 ) );
126+
console.log( isAlmostEqualf( z1, z2, 1 ) );
127127
// => false
128128

129129
z1 = new Complex64( 0.0, 0.0 );
130130
z2 = new Complex64( -0.0, 0.0 );
131-
console.log( isAlmostEqual( z1, z2, 0 ) );
131+
console.log( isAlmostEqualf( z1, z2, 0 ) );
132132
// => true
133133

134134
z1 = new Complex64( NaN, 0.0 );
135135
z2 = new Complex64( 1.0, 0.0 );
136-
console.log( isAlmostEqual( z1, z2, 1 ) );
136+
console.log( isAlmostEqualf( z1, z2, 1 ) );
137137
// => false
138138
```
139139

‎lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-equal/benchmark/benchmark.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ var Complex64 = require( '@stdlib/complex/float32/ctor' );
2525
var randu = require( '@stdlib/random/base/randu' );
2626
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
2727
var pkg = require( './../package.json' ).name;
28-
var isAlmostEqual = require( './../lib' );
28+
var isAlmostEqualf = require( './../lib' );
2929

3030

3131
// MAIN //
@@ -49,7 +49,7 @@ bench( pkg, function benchmark( b ) {
4949

5050
b.tic();
5151
for ( i = 0; i < b.iterations; i++ ) {
52-
v = isAlmostEqual( z1[ i%z1.length ], z2[ i%z2.length ], 1 );
52+
v = isAlmostEqualf( z1[ i%z1.length ], z2[ i%z2.length ], 1 );
5353
if ( typeof v !== 'boolean' ) {
5454
b.fail( 'should return a boolean' );
5555
}

‎lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-equal/docs/types/index.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ import Complex64 = require( '@stdlib/complex/float32/ctor' );
4040
* var z1 = new Complex64( 1.0, 3.0 );
4141
* var z2 = new Complex64( 1.0+EPS, 3.0 );
4242
*
43-
* var bool = isAlmostEqual( z1, z2, 0 );
43+
* var bool = isAlmostEqualf( z1, z2, 0 );
4444
* // returns false
4545
*
46-
* bool = isAlmostEqual( z1, z2, 1 );
46+
* bool = isAlmostEqualf( z1, z2, 1 );
4747
* // returns true
4848
*/
49-
declare function isAlmostEqual( z1: Complex64, z2: Complex64, maxULP: number ): boolean;
49+
declare function isAlmostEqualf( z1: Complex64, z2: Complex64, maxULP: number ): boolean;
5050

5151

5252
// EXPORTS //
5353

54-
export = isAlmostEqual;
54+
export = isAlmostEqualf;

‎lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-equal/docs/types/test.ts‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
*/
1818

1919
import Complex64 = require( '@stdlib/complex/float32/ctor' );
20-
import isAlmostEqual = require( './index' );
20+
import isAlmostEqualf = require( './index' );
2121

2222

2323
// TESTS //
@@ -27,42 +27,42 @@ import isAlmostEqual = require( './index' );
2727
const z1 = new Complex64( 5.0, 3.0 );
2828
const z2 = new Complex64( 5.0, 3.0 );
2929

30-
isAlmostEqual( z1, z2, 1 ); // $ExpectType boolean
30+
isAlmostEqualf( z1, z2, 1 ); // $ExpectType boolean
3131
}
3232

3333
// The compiler throws an error if the function is provided a first argument that is not a complex number...
3434
{
3535
const z2 = new Complex64( 5.0, 3.0 );
3636

37-
isAlmostEqual( 'abc', z2, 1 ); // $ExpectError
38-
isAlmostEqual( 123, z2, 1 ); // $ExpectError
39-
isAlmostEqual( true, z2, 1 ); // $ExpectError
40-
isAlmostEqual( false, z2, 1 ); // $ExpectError
41-
isAlmostEqual( [], z2, 1 ); // $ExpectError
42-
isAlmostEqual( {}, z2, 1 ); // $ExpectError
43-
isAlmostEqual( ( x: number ): number => x, z2, 1 ); // $ExpectError
37+
isAlmostEqualf( 'abc', z2, 1 ); // $ExpectError
38+
isAlmostEqualf( 123, z2, 1 ); // $ExpectError
39+
isAlmostEqualf( true, z2, 1 ); // $ExpectError
40+
isAlmostEqualf( false, z2, 1 ); // $ExpectError
41+
isAlmostEqualf( [], z2, 1 ); // $ExpectError
42+
isAlmostEqualf( {}, z2, 1 ); // $ExpectError
43+
isAlmostEqualf( ( x: number ): number => x, z2, 1 ); // $ExpectError
4444
}
4545

4646
// The compiler throws an error if the function is provided a second argument that is not a complex number...
4747
{
4848
const z1 = new Complex64( 5.0, 3.0 );
4949

50-
isAlmostEqual( z1, 'abc', 1 ); // $ExpectError
51-
isAlmostEqual( z1, 123, 1 ); // $ExpectError
52-
isAlmostEqual( z1, true, 1 ); // $ExpectError
53-
isAlmostEqual( z1, false, 1 ); // $ExpectError
54-
isAlmostEqual( z1, [], 1 ); // $ExpectError
55-
isAlmostEqual( z1, {}, 1 ); // $ExpectError
56-
isAlmostEqual( z1, ( x: number ): number => x, 1 ); // $ExpectError
50+
isAlmostEqualf( z1, 'abc', 1 ); // $ExpectError
51+
isAlmostEqualf( z1, 123, 1 ); // $ExpectError
52+
isAlmostEqualf( z1, true, 1 ); // $ExpectError
53+
isAlmostEqualf( z1, false, 1 ); // $ExpectError
54+
isAlmostEqualf( z1, [], 1 ); // $ExpectError
55+
isAlmostEqualf( z1, {}, 1 ); // $ExpectError
56+
isAlmostEqualf( z1, ( x: number ): number => x, 1 ); // $ExpectError
5757
}
5858

5959
// The compiler throws an error if the function is provided an unsupported number of arguments...
6060
{
6161
const z1 = new Complex64( 5.0, 3.0 );
6262
const z2 = new Complex64( 5.0, 3.0 );
6363

64-
isAlmostEqual(); // $ExpectError
65-
isAlmostEqual( z1 ); // $ExpectError
66-
isAlmostEqual( z1, z2 ); // $ExpectError
67-
isAlmostEqual( z1, z2, 1, 1 ); // $ExpectError
64+
isAlmostEqualf(); // $ExpectError
65+
isAlmostEqualf( z1 ); // $ExpectError
66+
isAlmostEqualf( z1, z2 ); // $ExpectError
67+
isAlmostEqualf( z1, z2, 1, 1 ); // $ExpectError
6868
}

‎lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-equal/examples/index.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,24 @@
2020

2121
var EPS = require( '@stdlib/constants/float32/eps' );
2222
var Complex64 = require( '@stdlib/complex/float32/ctor' );
23-
var isAlmostEqual = require( './../lib' );
23+
var isAlmostEqualf = require( './../lib' );
2424

2525
var z1 = new Complex64( 1.0, 3.0+EPS );
2626
var z2 = new Complex64( 1.0+EPS, 3.0 );
27-
console.log( isAlmostEqual( z1, z2, 1 ) );
27+
console.log( isAlmostEqualf( z1, z2, 1 ) );
2828
// => true
2929

3030
z1 = new Complex64( 1.0, 3.0+EPS );
3131
z2 = new Complex64( 1.0+EPS+EPS, 3.0 );
32-
console.log( isAlmostEqual( z1, z2, 1 ) );
32+
console.log( isAlmostEqualf( z1, z2, 1 ) );
3333
// => false
3434

3535
z1 = new Complex64( 0.0, 0.0 );
3636
z2 = new Complex64( -0.0, 0.0 );
37-
console.log( isAlmostEqual( z1, z2, 0 ) );
37+
console.log( isAlmostEqualf( z1, z2, 0 ) );
3838
// => true
3939

4040
z1 = new Complex64( NaN, 0.0 );
4141
z2 = new Complex64( 1.0, 0.0 );
42-
console.log( isAlmostEqual( z1, z2, 1 ) );
42+
console.log( isAlmostEqualf( z1, z2, 1 ) );
4343
// => false

‎lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-equal/lib/index.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@
2626
* @example
2727
* var EPS = require( '@stdlib/constants/float32/eps' );
2828
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
29-
* var isAlmostEqual = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
29+
* var isAlmostEqualf = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
3030
*
3131
* var z1 = new Complex64( 1.0, 3.0 );
3232
* var z2 = new Complex64( 1.0+EPS, 3.0 );
3333
*
34-
* var bool = isAlmostEqual( z1, z2, 0 );
34+
* var bool = isAlmostEqualf( z1, z2, 0 );
3535
* // returns false
3636
*
37-
* bool = isAlmostEqual( z1, z2, 1 );
37+
* bool = isAlmostEqualf( z1, z2, 1 );
3838
* // returns true
3939
*/
4040

‎lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-equal/lib/main.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ var reimf = require( '@stdlib/complex/float32/reim' );
4646
* var z1 = new Complex64( 1.0, 3.0 );
4747
* var z2 = new Complex64( 1.0+EPS, 3.0 );
4848
*
49-
* var bool = isAlmostEqual( z1, z2, 0 );
49+
* var bool = isAlmostEqualf( z1, z2, 0 );
5050
* // returns false
5151
*
52-
* bool = isAlmostEqual( z1, z2, 1 );
52+
* bool = isAlmostEqualf( z1, z2, 1 );
5353
* // returns true
5454
*/
55-
function isAlmostEqual( z1, z2, maxULP ) {
55+
function isAlmostEqualf( z1, z2, maxULP ) {
5656
var parts1 = reimf( z1 );
5757
var parts2 = reimf( z2 );
5858
return (
@@ -64,4 +64,4 @@ function isAlmostEqual( z1, z2, maxULP ) {
6464

6565
// EXPORTS //
6666

67-
module.exports = isAlmostEqual;
67+
module.exports = isAlmostEqualf;

‎lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-equal/test/test.js‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@
2323
var tape = require( 'tape' );
2424
var Complex64 = require( '@stdlib/complex/float32/ctor' );
2525
var EPS = require( '@stdlib/constants/float32/eps' );
26-
var isAlmostEqual = require( './../lib' );
26+
var isAlmostEqualf = require( './../lib' );
2727

2828

2929
// TESTS //
3030

3131
tape( 'main export is a function', function test( t ) {
3232
t.ok( true, __filename );
33-
t.strictEqual( typeof isAlmostEqual, 'function', 'main export is a function' );
33+
t.strictEqual( typeof isAlmostEqualf, 'function', 'main export is a function' );
3434
t.end();
3535
});
3636

@@ -40,17 +40,17 @@ tape( 'the function returns `false` if provided `NaN` as either real or imaginar
4040

4141
z1 = new Complex64( NaN, 3.14 );
4242
z2 = new Complex64( 5.0, 3.14 );
43-
t.strictEqual( isAlmostEqual( z1, z2, 1 ), false, 'returns expected value' );
44-
t.strictEqual( isAlmostEqual( z2, z1, 1 ), false, 'returns expected value' );
43+
t.strictEqual( isAlmostEqualf( z1, z2, 1 ), false, 'returns expected value' );
44+
t.strictEqual( isAlmostEqualf( z2, z1, 1 ), false, 'returns expected value' );
4545

4646
z2 = new Complex64( 5.0, NaN );
47-
t.strictEqual( isAlmostEqual( z1, z2, 1 ), false, 'returns expected value' );
48-
t.strictEqual( isAlmostEqual( z2, z1, 1 ), false, 'returns expected value' );
47+
t.strictEqual( isAlmostEqualf( z1, z2, 1 ), false, 'returns expected value' );
48+
t.strictEqual( isAlmostEqualf( z2, z1, 1 ), false, 'returns expected value' );
4949

5050
z1 = new Complex64( NaN, NaN );
5151
z2 = new Complex64( NaN, NaN );
52-
t.strictEqual( isAlmostEqual( z1, z2, 1 ), false, 'returns expected value' );
53-
t.strictEqual( isAlmostEqual( z2, z1, 1 ), false, 'returns expected value' );
52+
t.strictEqual( isAlmostEqualf( z1, z2, 1 ), false, 'returns expected value' );
53+
t.strictEqual( isAlmostEqualf( z2, z1, 1 ), false, 'returns expected value' );
5454

5555
t.end();
5656
});
@@ -60,19 +60,19 @@ tape( 'the function returns `true` if provided two complex single-precision floa
6060
var z2;
6161

6262
z1 = new Complex64( 5.0, 3.0 );
63-
t.strictEqual( isAlmostEqual( z1, z1, 0 ), true, 'returns expected value' );
63+
t.strictEqual( isAlmostEqualf( z1, z1, 0 ), true, 'returns expected value' );
6464

6565
z1 = new Complex64( 5.0, 3.0 );
6666
z2 = new Complex64( 5.0, 3.0 );
67-
t.strictEqual( isAlmostEqual( z1, z2, 1 ), true, 'returns expected value' );
67+
t.strictEqual( isAlmostEqualf( z1, z2, 1 ), true, 'returns expected value' );
6868

6969
z1 = new Complex64( -5.0, -3.0 );
7070
z2 = new Complex64( -5.0, -3.0 );
71-
t.strictEqual( isAlmostEqual( z1, z2, 0 ), true, 'returns expected value' );
71+
t.strictEqual( isAlmostEqualf( z1, z2, 0 ), true, 'returns expected value' );
7272

7373
z1 = new Complex64( 0.0, 0.0 );
7474
z2 = new Complex64( 0.0, 0.0 );
75-
t.strictEqual( isAlmostEqual( z1, z2, 0 ), true, 'returns expected value' );
75+
t.strictEqual( isAlmostEqualf( z1, z2, 0 ), true, 'returns expected value' );
7676

7777
t.end();
7878
});
@@ -83,12 +83,12 @@ tape( 'the function returns `true` if provided two complex single-precision floa
8383

8484
z1 = new Complex64( 1.0, 3.0 );
8585
z2 = new Complex64( 1.0+EPS, 3.0 );
86-
t.strictEqual( isAlmostEqual( z1, z2, 1 ), true, 'returns expected value' );
87-
t.strictEqual( isAlmostEqual( z2, z1, 1 ), true, 'returns expected value' );
86+
t.strictEqual( isAlmostEqualf( z1, z2, 1 ), true, 'returns expected value' );
87+
t.strictEqual( isAlmostEqualf( z2, z1, 1 ), true, 'returns expected value' );
8888

8989
z2 = new Complex64( 1.0+EPS+EPS, 3.0 );
90-
t.strictEqual( isAlmostEqual( z1, z2, 2 ), true, 'returns expected value' );
91-
t.strictEqual( isAlmostEqual( z2, z1, 2 ), true, 'returns expected value' );
90+
t.strictEqual( isAlmostEqualf( z1, z2, 2 ), true, 'returns expected value' );
91+
t.strictEqual( isAlmostEqualf( z2, z1, 2 ), true, 'returns expected value' );
9292

9393
t.end();
9494
});
@@ -99,12 +99,12 @@ tape( 'the function returns `false` if provided two complex single-precision flo
9999

100100
z1 = new Complex64( 1.0, 3.0 );
101101
z2 = new Complex64( 1.0+EPS, 3.0 );
102-
t.strictEqual( isAlmostEqual( z1, z2, 0 ), false, 'returns expected value' );
103-
t.strictEqual( isAlmostEqual( z2, z1, 0 ), false, 'returns expected value' );
102+
t.strictEqual( isAlmostEqualf( z1, z2, 0 ), false, 'returns expected value' );
103+
t.strictEqual( isAlmostEqualf( z2, z1, 0 ), false, 'returns expected value' );
104104

105105
z2 = new Complex64( 1.0+EPS+EPS, 3.0 );
106-
t.strictEqual( isAlmostEqual( z1, z2, 1 ), false, 'returns expected value' );
107-
t.strictEqual( isAlmostEqual( z2, z1, 1 ), false, 'returns expected value' );
106+
t.strictEqual( isAlmostEqualf( z1, z2, 1 ), false, 'returns expected value' );
107+
t.strictEqual( isAlmostEqualf( z2, z1, 1 ), false, 'returns expected value' );
108108

109109
t.end();
110110
});
@@ -115,11 +115,11 @@ tape( 'the function returns `true` if signed zeros are provided as real or imagi
115115

116116
z1 = new Complex64( 0.0, 0.0 );
117117
z2 = new Complex64( -0.0, -0.0 );
118-
t.strictEqual( isAlmostEqual( z1, z2, 0 ), true, 'returns expected value' );
119-
t.strictEqual( isAlmostEqual( z2, z1, 0 ), true, 'returns expected value' );
118+
t.strictEqual( isAlmostEqualf( z1, z2, 0 ), true, 'returns expected value' );
119+
t.strictEqual( isAlmostEqualf( z2, z1, 0 ), true, 'returns expected value' );
120120

121-
t.strictEqual( isAlmostEqual( z1, z2, 1 ), true, 'returns expected value' );
122-
t.strictEqual( isAlmostEqual( z2, z1, 1 ), true, 'returns expected value' );
121+
t.strictEqual( isAlmostEqualf( z1, z2, 1 ), true, 'returns expected value' );
122+
t.strictEqual( isAlmostEqualf( z2, z1, 1 ), true, 'returns expected value' );
123123

124124
t.end();
125125
});

0 commit comments

Comments
 (0)