Skip to content

test: migrate math/base/special/ellipk to ULP-based assertions #13943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
Aug 6, 2026
+18 −76
Merged

test: migrate math/base/special/ellipk to ULP-based assertions #13943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f3d61c
test: migrate `math/base/special/ellipk` to ULP-based assertions
Aug 5, 2026
af8d4a1
Apply suggestions from code review
kgryte Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 9 additions & 38 deletions lib/node_modules/@stdlib/math/base/special/ellipk/test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,11 @@
// MODULES //

var tape = require( 'tape' );
var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var PINF = require( '@stdlib/constants/float64/pinf' );
var NINF = require( '@stdlib/constants/float64/ninf' );
var HALF_PI = require( '@stdlib/constants/float64/half-pi' );
var EPS = require( '@stdlib/constants/float64/eps' );
var abs = require( '@stdlib/math/base/special/abs' );
var ellipk = require( './../lib' );


Expand All @@ -48,92 +47,64 @@

tape( 'the function evaluates the complete elliptic integral of the first kind (medium positive values)', function test( t ) {
var expected;
var delta;
var tol;
var x;
var y;
var i;

expected = mediumPositive.expected;
x = mediumPositive.x;

for ( i = 0; i < x.length; i++ ) {
y = ellipk( x[i] );
if ( y === expected[i] ) {
t.strictEqual( y, expected[i], 'x: '+x[i]+', y: '+y+', expected: '+expected[i] );
} else {
delta = abs( y - expected[i] );
tol = 25.0 * EPS * abs( expected[i] );
t.strictEqual( delta <= tol, true, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' );
}
t.strictEqual( isAlmostSameValue( y, expected[ i ], 25 ), true, 'returns expected value' );
}
t.end();
});

tape( 'the function evaluates the complete elliptic integral of the first kind (values close to positive unity)', function test( t ) {
var expected;
var delta;
var tol;
var x;
var y;
var i;

expected = closeToUnity.expected;
x = closeToUnity.x;

for ( i = 0; i < x.length; i++ ) {
y = ellipk( x[i] );
if ( y === expected[i] ) {
t.strictEqual( y, expected[i], 'x: '+x[i]+', y: '+y+', expected: '+expected[i] );
} else {
delta = abs( y - expected[i] );
tol = 8000.0 * EPS * abs( expected[i] );
t.strictEqual( delta <= tol, true, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' );
}
t.strictEqual( isAlmostSameValue( y, expected[ i ], 12065 ), true, 'returns expected value' ); // FIXME: investigate the reason for this large discrepancy

Check warning on line 75 in lib/node_modules/@stdlib/math/base/special/ellipk/test/test.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected 'fixme' comment: 'FIXME: investigate the reason for this...'
}
t.end();
});

tape( 'the function evaluates the complete elliptic integral of the first kind (medium negative values)', function test( t ) {
var expected;
var delta;
var tol;
var x;
var y;
var i;

expected = mediumNegative.expected;
x = mediumNegative.x;

for ( i = 0; i < x.length; i++ ) {
y = ellipk( x[i] );
if ( y === expected[i] ) {
t.strictEqual( y, expected[i], 'x: '+x[i]+', y: '+y+', expected: '+expected[i] );
} else {
delta = abs( y - expected[i] );
tol = 1.5 * EPS * abs( expected[i] );
t.strictEqual( delta <= tol, true, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' );
}
t.strictEqual( isAlmostSameValue( y, expected[ i ], 2 ), true, 'returns expected value' );
}
t.end();
});

tape( 'the function evaluates the complete elliptic integral of the first kind (large negative values)', function test( t ) {
var expected;
var delta;
var tol;
var x;
var y;
var i;

expected = largeNegative.expected;
x = largeNegative.x;

for ( i = 0; i < x.length; i++ ) {
y = ellipk( x[i] );
if ( y === expected[i] ) {
t.strictEqual( y, expected[i], 'x: '+x[i]+', y: '+y+', expected: '+expected[i] );
} else {
delta = abs( y - expected[i] );
tol = 1e9 * EPS * abs( expected[i] );
t.strictEqual( delta <= tol, true, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' );
}
t.strictEqual( isAlmostSameValue( y, expected[ i ], 204773163 ), true, 'returns expected value' ); // FIXME: investigate the reason for this large discrepancy

Check warning on line 107 in lib/node_modules/@stdlib/math/base/special/ellipk/test/test.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected 'fixme' comment: 'FIXME: investigate the reason for this...'
}
t.end();
});
Expand Down
47 changes: 9 additions & 38 deletions lib/node_modules/@stdlib/math/base/special/ellipk/test/test.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,11 @@

var resolve = require( 'path' ).resolve;
var tape = require( 'tape' );
var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var PINF = require( '@stdlib/constants/float64/pinf' );
var NINF = require( '@stdlib/constants/float64/ninf' );
var HALF_PI = require( '@stdlib/constants/float64/half-pi' );
var EPS = require( '@stdlib/constants/float64/eps' );
var abs = require( '@stdlib/math/base/special/abs' );
var tryRequire = require( '@stdlib/utils/try-require' );


Expand Down Expand Up @@ -57,92 +56,64 @@

tape( 'the function evaluates the complete elliptic integral of the first kind (medium positive values)', opts, function test( t ) {
var expected;
var delta;
var tol;
var x;
var y;
var i;

expected = mediumPositive.expected;
x = mediumPositive.x;

for ( i = 0; i < x.length; i++ ) {
y = ellipk( x[i] );
if ( y === expected[i] ) {
t.strictEqual( y, expected[i], 'x: '+x[i]+', y: '+y+', expected: '+expected[i] );
} else {
delta = abs( y - expected[i] );
tol = 25.0 * EPS * abs( expected[i] );
t.strictEqual( delta <= tol, true, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' );
}
t.strictEqual( isAlmostSameValue( y, expected[ i ], 25 ), true, 'returns expected value' );
}
t.end();
});

tape( 'the function evaluates the complete elliptic integral of the first kind (values close to positive unity)', opts, function test( t ) {
var expected;
var delta;
var tol;
var x;
var y;
var i;

expected = closeToUnity.expected;
x = closeToUnity.x;

for ( i = 0; i < x.length; i++ ) {
y = ellipk( x[i] );
if ( y === expected[i] ) {
t.strictEqual( y, expected[i], 'x: '+x[i]+', y: '+y+', expected: '+expected[i] );
} else {
delta = abs( y - expected[i] );
tol = 8000.0 * EPS * abs( expected[i] );
t.strictEqual( delta <= tol, true, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' );
}
t.strictEqual( isAlmostSameValue( y, expected[ i ], 12065 ), true, 'returns expected value' ); // FIXME: investigate the reason for this large discrepancy

Check warning on line 84 in lib/node_modules/@stdlib/math/base/special/ellipk/test/test.native.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected 'fixme' comment: 'FIXME: investigate the reason for this...'
}
t.end();
});

tape( 'the function evaluates the complete elliptic integral of the first kind (medium negative values)', opts, function test( t ) {
var expected;
var delta;
var tol;
var x;
var y;
var i;

expected = mediumNegative.expected;
x = mediumNegative.x;

for ( i = 0; i < x.length; i++ ) {
y = ellipk( x[i] );
if ( y === expected[i] ) {
t.strictEqual( y, expected[i], 'x: '+x[i]+', y: '+y+', expected: '+expected[i] );
} else {
delta = abs( y - expected[i] );
tol = 1.5 * EPS * abs( expected[i] );
t.strictEqual( delta <= tol, true, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' );
}
t.strictEqual( isAlmostSameValue( y, expected[ i ], 2 ), true, 'returns expected value' );
}
t.end();
});

tape( 'the function evaluates the complete elliptic integral of the first kind (large negative values)', opts, function test( t ) {
var expected;
var delta;
var tol;
var x;
var y;
var i;

expected = largeNegative.expected;
x = largeNegative.x;

for ( i = 0; i < x.length; i++ ) {
y = ellipk( x[i] );
if ( y === expected[i] ) {
t.strictEqual( y, expected[i], 'x: '+x[i]+', y: '+y+', expected: '+expected[i] );
} else {
delta = abs( y - expected[i] );
tol = 1e9 * EPS * abs( expected[i] );
t.strictEqual( delta <= tol, true, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+expected[i]+'. Δ: '+delta+'. tol: '+tol+'.' );
}
t.strictEqual( isAlmostSameValue( y, expected[ i ], 204773163 ), true, 'returns expected value' ); // FIXME: investigate the reason for this large discrepancy

Check warning on line 116 in lib/node_modules/@stdlib/math/base/special/ellipk/test/test.native.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected 'fixme' comment: 'FIXME: investigate the reason for this...'
}
t.end();
});
Expand Down