Skip to content

Commit ed084b9

Browse files
kgrytekgryte
committed
chore: rename variables
--- 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 895d417 commit ed084b9

File tree

40 files changed

+348
-348
lines changed

40 files changed

+348
-348
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-
# isAlmostEqualf
21+
# isAlmostEqual
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 isAlmostEqualf = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
40+
var isAlmostEqual = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
4141
```
4242

43-
#### isAlmostEqualf( z1, z2, maxULP )
43+
#### isAlmostEqual( 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 = isAlmostEqualf( z1, z2, 0 );
54+
var out = isAlmostEqual( z1, z2, 0 );
5555
// returns false
5656

57-
out = isAlmostEqualf( z1, z2, 1 );
57+
out = isAlmostEqual( 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 = isAlmostEqualf( z1, z2, 1 );
69+
var out = isAlmostEqual( z1, z2, 1 );
7070
// returns false
7171

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

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

78-
out = isAlmostEqualf( z1, z2, 1 );
78+
out = isAlmostEqual( 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 = isAlmostEqualf( z1, z2, 0 );
90+
var out = isAlmostEqual( z1, z2, 0 );
9191
// returns true
9292
```
9393

@@ -114,26 +114,26 @@ var out = isAlmostEqualf( z1, z2, 0 );
114114
```javascript
115115
var EPS = require( '@stdlib/constants/float32/eps' );
116116
var Complex64 = require( '@stdlib/complex/float32/ctor' );
117-
var isAlmostEqualf = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
117+
var isAlmostEqual = 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( isAlmostEqualf( z1, z2, 1 ) );
121+
console.log( isAlmostEqual( 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( isAlmostEqualf( z1, z2, 1 ) );
126+
console.log( isAlmostEqual( 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( isAlmostEqualf( z1, z2, 0 ) );
131+
console.log( isAlmostEqual( z1, z2, 0 ) );
132132
// => true
133133

134134
z1 = new Complex64( NaN, 0.0 );
135135
z2 = new Complex64( 1.0, 0.0 );
136-
console.log( isAlmostEqualf( z1, z2, 1 ) );
136+
console.log( isAlmostEqual( 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 isAlmostEqualf = require( './../lib' );
28+
var isAlmostEqual = 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 = isAlmostEqualf( z1[ i%z1.length ], z2[ i%z2.length ], 1 );
52+
v = isAlmostEqual( 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 = isAlmostEqualf( z1, z2, 0 );
43+
* var bool = isAlmostEqual( z1, z2, 0 );
4444
* // returns false
4545
*
46-
* bool = isAlmostEqualf( z1, z2, 1 );
46+
* bool = isAlmostEqual( z1, z2, 1 );
4747
* // returns true
4848
*/
49-
declare function isAlmostEqualf( z1: Complex64, z2: Complex64, maxULP: number ): boolean;
49+
declare function isAlmostEqual( z1: Complex64, z2: Complex64, maxULP: number ): boolean;
5050

5151

5252
// EXPORTS //
5353

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

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

Lines changed: 28 additions & 28 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 isAlmostEqualf = require( './index' );
20+
import isAlmostEqual = require( './index' );
2121

2222

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

30-
isAlmostEqualf( z1, z2, 1 ); // $ExpectType boolean
30+
isAlmostEqual( 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-
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
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
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-
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
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
5757
}
5858

5959
// The compiler throws an error if the function is provided a third argument that is not a number...
6060
{
6161
const z1 = new Complex64( 5.0, 3.0 );
6262
const z2 = new Complex64( 5.0, 3.0 );
6363

64-
isAlmostEqualf( z1, z2, 'abc' ); // $ExpectError
65-
isAlmostEqualf( z1, z2, true ); // $ExpectError
66-
isAlmostEqualf( z1, z2, false ); // $ExpectError
67-
isAlmostEqualf( z1, z2, null ); // $ExpectError
68-
isAlmostEqualf( z1, z2, void 0 ); // $ExpectError
69-
isAlmostEqualf( z1, z2, [] ); // $ExpectError
70-
isAlmostEqualf( z1, z2, {} ); // $ExpectError
71-
isAlmostEqualf( z1, z2, ( x: number ): number => x ); // $ExpectError
64+
isAlmostEqual( z1, z2, 'abc' ); // $ExpectError
65+
isAlmostEqual( z1, z2, true ); // $ExpectError
66+
isAlmostEqual( z1, z2, false ); // $ExpectError
67+
isAlmostEqual( z1, z2, null ); // $ExpectError
68+
isAlmostEqual( z1, z2, void 0 ); // $ExpectError
69+
isAlmostEqual( z1, z2, [] ); // $ExpectError
70+
isAlmostEqual( z1, z2, {} ); // $ExpectError
71+
isAlmostEqual( z1, z2, ( x: number ): number => x ); // $ExpectError
7272
}
7373

7474
// The compiler throws an error if the function is provided an unsupported number of arguments...
7575
{
7676
const z1 = new Complex64( 5.0, 3.0 );
7777
const z2 = new Complex64( 5.0, 3.0 );
7878

79-
isAlmostEqualf(); // $ExpectError
80-
isAlmostEqualf( z1 ); // $ExpectError
81-
isAlmostEqualf( z1, z2 ); // $ExpectError
82-
isAlmostEqualf( z1, z2, 1, 1 ); // $ExpectError
79+
isAlmostEqual(); // $ExpectError
80+
isAlmostEqual( z1 ); // $ExpectError
81+
isAlmostEqual( z1, z2 ); // $ExpectError
82+
isAlmostEqual( z1, z2, 1, 1 ); // $ExpectError
8383
}

‎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 isAlmostEqualf = require( './../lib' );
23+
var isAlmostEqual = 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( isAlmostEqualf( z1, z2, 1 ) );
27+
console.log( isAlmostEqual( 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( isAlmostEqualf( z1, z2, 1 ) );
32+
console.log( isAlmostEqual( 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( isAlmostEqualf( z1, z2, 0 ) );
37+
console.log( isAlmostEqual( z1, z2, 0 ) );
3838
// => true
3939

4040
z1 = new Complex64( NaN, 0.0 );
4141
z2 = new Complex64( 1.0, 0.0 );
42-
console.log( isAlmostEqualf( z1, z2, 1 ) );
42+
console.log( isAlmostEqual( 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 isAlmostEqualf = require( '@stdlib/complex/float32/base/assert/is-almost-equal' );
29+
* var isAlmostEqual = 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 = isAlmostEqualf( z1, z2, 0 );
34+
* var bool = isAlmostEqual( z1, z2, 0 );
3535
* // returns false
3636
*
37-
* bool = isAlmostEqualf( z1, z2, 1 );
37+
* bool = isAlmostEqual( 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 = isAlmostEqualf( z1, z2, 0 );
49+
* var bool = isAlmostEqual( z1, z2, 0 );
5050
* // returns false
5151
*
52-
* bool = isAlmostEqualf( z1, z2, 1 );
52+
* bool = isAlmostEqual( z1, z2, 1 );
5353
* // returns true
5454
*/
55-
function isAlmostEqualf( z1, z2, maxULP ) {
55+
function isAlmostEqual( z1, z2, maxULP ) {
5656
var parts1 = reimf( z1 );
5757
var parts2 = reimf( z2 );
5858
return (
@@ -64,4 +64,4 @@ function isAlmostEqualf( z1, z2, maxULP ) {
6464

6565
// EXPORTS //
6666

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

0 commit comments

Comments
 (0)