refactor: create variable in parent scope and update test messages

Author: kgryte

lib/node_modules/@stdlib/math/base/special/spence/lib/main.js

@@ -41,6 +41,11 @@ var polyvalA = require( './polyval_a.js' );
 var polyvalB = require( './polyval_b.js' );
 
 
+// VARIABLES //
+
+var PI2O6 = PI_SQUARED / 6.0;
+
+
 // MAIN //
 
 /**
@@ -91,7 +96,7 @@ function spence( x ) {
 		return 0.0;
 	}
 	if ( x === 0.0 ) {
-		return ( PI_SQUARED / 6.0 );
+		return PI2O6;
 	}
 	flg = 0;
 	if ( x > 2.0 ) {
@@ -109,7 +114,7 @@ function spence( x ) {
 	}
 	y = -w * polyvalA( w ) / polyvalB( w );
 	if ( flg & 1 ) {
-		y = ( PI_SQUARED/6.0 ) - ( ln( x ) * ln( 1.0-x ) ) - y;
+		y = PI2O6 - ( ln( x ) * ln( 1.0-x ) ) - y;
 	}
 	if ( flg & 2 ) {
 		z = ln( x );

lib/node_modules/@stdlib/math/base/special/spence/src/main.c

@@ -36,6 +36,9 @@
 #include "stdlib/constants/float64/pi_squared.h"
 #include <stdint.h>
 
+// π^2 / 6
+static const double PI2O6 = STDLIB_CONSTANT_FLOAT64_PI_SQUARED / 6.0;
+
 /* Begin auto-generated functions. The following functions are auto-generated. Do not edit directly. */
 
 // BEGIN: polyval_a
@@ -117,7 +120,7 @@ double stdlib_base_spence( const double x ) {
 		return 0.0;
 	}
 	if ( x == 0.0 ) {
-		return ( STDLIB_CONSTANT_FLOAT64_PI_SQUARED / 6.0 );
+		return PI2O6;
 	}
 	flg = 0;
 	xc = x;
@@ -136,7 +139,7 @@ double stdlib_base_spence( const double x ) {
 	}
 	y = -w * polyval_a( w ) / polyval_b( w );
 	if ( flg & 1 ) {
-		y = ( STDLIB_CONSTANT_FLOAT64_PI_SQUARED / 6.0 ) - ( stdlib_base_ln( xc ) * stdlib_base_ln( 1.0 - xc ) ) - y;
+		y = PI2O6 - ( stdlib_base_ln( xc ) * stdlib_base_ln( 1.0 - xc ) ) - y;
 	}
 	if ( flg & 2 ) {
 		z = stdlib_base_ln( xc );

lib/node_modules/@stdlib/math/base/special/spence/test/test.js

@@ -58,7 +58,7 @@ tape( 'the function accurately computes the dilogarithm for small positive numbe
 		v = spence( x[ i ] );
 		delta = abs( v - expected[ i ] );
 		tol = 2.0 * EPS * abs( expected[ i ] );
-		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. Value: ' + v + '. Expected: ' + expected[ i ] + '. Tolerance: ' + tol + '.' );
+		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. actual: ' + v + '. expected: ' + expected[ i ] + '. tol: ' + tol + '. Δ: ' + delta + '.' );
 	}
 	t.end();
 });
@@ -78,7 +78,7 @@ tape( 'the function accurately computes the dilogarithm for medium positive numb
 		v = spence( x[ i ] );
 		delta = abs( v - expected[ i ] );
 		tol = 2.0 * EPS * abs( expected[ i ] );
-		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. Value: ' + v + '. Expected: ' + expected[ i ] + '. Tolerance: ' + tol + '.' );
+		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. actual: ' + v + '. expected: ' + expected[ i ] + '. tol: ' + tol + '. Δ: ' + delta + '.' );
 	}
 	t.end();
 });
@@ -98,7 +98,7 @@ tape( 'the function accurately computes the dilogarithm for large positive numbe
 		v = spence( x[ i ] );
 		delta = abs( v - expected[ i ] );
 		tol = EPS * abs( expected[ i ] );
-		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. Value: ' + v + '. Expected: ' + expected[ i ] + '. Tolerance: ' + tol + '.' );
+		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. actual: ' + v + '. expected: ' + expected[ i ] + '. tol: ' + tol + '. Δ: ' + delta + '.' );
 	}
 	t.end();
 });

lib/node_modules/@stdlib/math/base/special/spence/test/test.native.js

@@ -86,8 +86,10 @@ tape( 'the function accurately computes the dilogarithm for medium positive numb
 	for ( i = 0; i < x.length; i++ ) {
 		v = spence( x[ i ] );
 		delta = abs( v - expected[ i ] );
+
+		// NOTE: the tolerance here is larger than for the JavaScript implementation due to compiler optimizations which may be performed resulting in result divergence. For discussion, see https://github.com/stdlib-js/stdlib/pull/2298#discussion_r1624765205
 		tol = 8.3 * EPS * abs( expected[ i ] );
-		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. Value: ' + v + '. Expected: ' + expected[ i ] + '. Tolerance: ' + tol + '.' );
+		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. actual: ' + v + '. expected: ' + expected[ i ] + '. tol: ' + tol + '. Δ: ' + delta + '.' );
 	}
 	t.end();
 });
@@ -107,7 +109,7 @@ tape( 'the function accurately computes the dilogarithm for large positive numbe
 		v = spence( x[ i ] );
 		delta = abs( v - expected[ i ] );
 		tol = 2.0 * EPS * abs( expected[ i ] );
-		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. Value: ' + v + '. Expected: ' + expected[ i ] + '. Tolerance: ' + tol + '.' );
+		t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. actual: ' + v + '. expected: ' + expected[ i ] + '. tol: ' + tol + '. Δ: ' + delta + '.' );
 	}
 	t.end();
 });