Enhance t_is() to handle Inf values appropriately.

Author: rdzman

CHANGES.md

@@ -2,6 +2,13 @@ Change history for MP-Test
 ==========================
 
 
+Since version 8.0
+-----------------
+
+#### 3/21/25
+  - Enhance `t_is()` to handle Inf values appropriately.
+
+
 Version 8.0 - *May 10, 2024*
 ----------------------------
 

lib/t/t_test_fcns.m

@@ -21,8 +21,8 @@ function t_test_fcns(quiet)
 end
 
 ntests = 5;
-npass = 29;
-nfail = 18;
+npass = 34;
+nfail = 27;
 
 g = [];
 e = [];
@@ -62,36 +62,90 @@ function t_test_fcns(quiet)
 got = 3;
 g(k) = t_is(got, expected, tol, t);
 
+k = k + 1; e(k) = 1;
+t = sprintf('%s : t_is(Inf, Inf, ...)', f(e(k)));
+expected = Inf;
+got = Inf;
+g(k) = t_is(got, expected, tol, t);
+
+k = k + 1; e(k) = 1;
+t = sprintf('%s : t_is(-Inf, -Inf, ...)', f(e(k)));
+expected = -Inf;
+got = -Inf;
+g(k) = t_is(got, expected, tol, t);
+
 k = k + 1; e(k) = 0;
 t = sprintf('%s : t_is(1, 3, ...)', f(e(k)));
 expected = 3;
 got = 1;
 g(k) = t_is(got, expected, tol, t);
 
+k = k + 1; e(k) = 0;
+t = sprintf('%s : t_is(Inf, 3, ...)', f(e(k)));
+expected = 3;
+got = Inf;
+g(k) = t_is(got, expected, tol, t);
+
+k = k + 1; e(k) = 0;
+t = sprintf('%s : t_is(1, -Inf, ...)', f(e(k)));
+expected = -Inf;
+got = 1;
+g(k) = t_is(got, expected, tol, t);
+
 k = k + 1; e(k) = 1;
 t = sprintf('%s : t_is([3 3; 3 3], 3, ...)', f(e(k)));
 expected = 3;
 got = [3 3; 3 3];
 g(k) = t_is(got, expected, tol, t);
 
+k = k + 1; e(k) = 1;
+t = sprintf('%s : t_is([Inf Inf; Inf Inf], Inf, ...)', f(e(k)));
+expected = Inf;
+got = [Inf Inf; Inf Inf];
+g(k) = t_is(got, expected, tol, t);
+
 k = k + 1; e(k) = 0;
 t = sprintf('%s : t_is([3 4; 3 3], 3, ...)', f(e(k)));
 expected = 3;
 got = [3 4; 3 3];
 g(k) = t_is(got, expected, tol, t);
 
+k = k + 1; e(k) = 0;
+t = sprintf('%s : t_is([Inf 4; Inf Inf], Inf, ...)', f(e(k)));
+expected = Inf;
+got = [Inf 4; Inf Inf];
+g(k) = t_is(got, expected, tol, t);
+
 k = k + 1; e(k) = 1;
 t = sprintf('%s : t_is([3 3; 4 3], [3 3; 4 3], ...)', f(e(k)));
 expected = [3 3; 4 3];
 got = [3 3; 4 3];
 g(k) = t_is(got, expected, tol, t);
 
+k = k + 1; e(k) = 1;
+t = sprintf('%s : t_is([3 -Inf; 4 3], [3 -Inf; 4 3], ...)', f(e(k)));
+expected = [3 -Inf; 4 3];
+got = [3 -Inf; 4 3];
+g(k) = t_is(got, expected, tol, t);
+
 k = k + 1; e(k) = 0;
 t = sprintf('%s : t_is([3 4; 3 3], [3 3; 4 3], ...)', f(e(k)));
 expected = [3 3; 4 3];
 got = [3 4; 3 3];
 g(k) = t_is(got, expected, tol, t);
 
+k = k + 1; e(k) = 0;
+t = sprintf('%s : t_is([3 4; 3 -Inf], [3 3; 4 3], ...)', f(e(k)));
+expected = [3 3; 4 3];
+got = [3 4; 3 -Inf];
+g(k) = t_is(got, expected, tol, t);
+
+k = k + 1; e(k) = 0;
+t = sprintf('%s : t_is([3 3; 4 -Inf], [3 3; 4 Inf], ...)', f(e(k)));
+expected = [3 3; 4 Inf];
+got = [3 3; 4 -Inf];
+g(k) = t_is(got, expected, tol, t);
+
 k = k + 1; e(k) = 1;
 t = sprintf('%s : t_is(ones(2,4,3), ones(2,4,3), ...)', f(e(k)));
 expected = ones(2,4,3);
@@ -148,12 +202,42 @@ function t_test_fcns(quiet)
 got = NaN;
 g(k) = t_is(got, expected, tol, t);
 
+k = k + 1; e(k) = 0;
+t = sprintf('%s : t_is(-Inf, NaN, ...)', f(e(k)));
+expected = NaN;
+got = -Inf;
+g(k) = t_is(got, expected, tol, t);
+
+k = k + 1; e(k) = 0;
+t = sprintf('%s : t_is(NaN, Inf, ...)', f(e(k)));
+expected = Inf;
+got = NaN;
+g(k) = t_is(got, expected, tol, t);
+
 k = k + 1; e(k) = 1;
 t = sprintf('%s : t_is(NaN(3,2), NaN, ...)', f(e(k)));
 expected = NaN;
 got = NaN(3,2);
 g(k) = t_is(got, expected, tol, t);
 
+k = k + 1; e(k) = 1;
+t = sprintf('%s : t_is([3 4; NaN Inf], [3 4; NaN Inf], ...)', f(e(k)));
+expected = [3 4; NaN Inf];
+got = [3 4; NaN Inf];
+g(k) = t_is(got, expected, tol, t);
+
+k = k + 1; e(k) = 0;
+t = sprintf('%s : t_is([3 4; NaN Inf], [3 4; Inf NaN], ...)', f(e(k)));
+expected = [3 4; Inf NaN];
+got = [3 4; NaN Inf];
+g(k) = t_is(got, expected, tol, t);
+
+k = k + 1; e(k) = 0;
+t = sprintf('%s : t_is([3 4.001; NaN Inf], [3 4; NaN Inf], ...)', f(e(k)));
+expected = [3 4; NaN Inf];
+got = [3 4.001; NaN Inf];
+g(k) = t_is(got, expected, 4, t);
+
 k = k + 1; e(k) = 0;
 t = sprintf('%s : t_is(int32(0.6), 1.0, ...)', f(e(k)));
 expected = 0.6;

lib/t_is.m

@@ -25,7 +25,7 @@
 % The input values can be real or complex, and they can be scalar, vector,
 % or 2-d or higher matrices. If ``got`` is a vector or matrix and
 % ``expected`` is a scalar or *NaN*, all elements must match the scalar.
-% *NaN* values are considered to be equal to each other.
+% *NaN* values are considered to be equal to each other, as are Inf values.
 %
 % Intended to be called between calls to t_begin and t_end.
 %
@@ -41,7 +41,7 @@
 % See also t_ok, t_file_match, t_str_match, t_skip, t_begin, t_end, t_run_tests.
 
 %   MP-Test
-%   Copyright (c) 2004-2024, Power Systems Engineering Research Center (PSERC)
+%   Copyright (c) 2004-2025, Power Systems Engineering Research Center (PSERC)
 %   by Ray Zimmerman, PSERC Cornell
 %
 %   This file is part of MP-Test.
@@ -86,14 +86,36 @@
         elseif all(isnan(expected(:))) && all(isnan(got(:)))
             condition = true;
         else
+            have_inf = any(isinf(got(:))) || any(isinf(expected(:)));
+            if have_inf
+                pi_got = find(got(:) == Inf);
+                ni_got = find(got(:) == -Inf);
+                pi_expected = find(expected(:) == Inf);
+                ni_expected = find(expected(:) == -Inf);
+                got(pi_got) = 1e10;
+                got(ni_got) = -1e10;
+                expected(pi_expected) = 1e10;
+                expected(ni_expected) = -1e10;
+            end
             got_minus_expected = got - expected;
-            max_diff = max(abs(got_minus_expected(:)));
+            [max_diff, i] = max(abs(got_minus_expected(:)));
             condition = ( max_diff < 10^(-prec) );
+
+            if ~condition && have_inf
+                if ismember(i, [pi_got; ni_got; pi_expected; ni_expected]) || ...
+                        (isscalar(expected) && ismember(1, [pi_expected; ni_expected]))
+                    max_diff = Inf;
+                end
+                got(pi_got) = Inf;
+                got(ni_got) = -Inf;
+                expected(pi_expected) = Inf;
+                expected(ni_expected) = -Inf;
+            end
         end
     end
 else
     condition = false;
-    max_diff = 0;
+    max_diff = 0;       %% dimension mismatch
 end
 
 if isreal(got) && isreal(expected)
@@ -105,7 +127,7 @@
 t_ok(condition, msg);
 if ~condition && ~t_quiet
     if max_diff > 0
-        k = find(~(abs(got_minus_expected(:)) < 10^(-prec)));
+        k = find(~(abs(got_minus_expected(:)) < 10^(-prec)) & ~isnan(got_minus_expected(:)));
         [vv, kk] = max(abs(got_minus_expected(k)));
         fprintf('    index              got             expected      abs(got - exp)\n');
         fprintf('---------------  ----------------  ----------------  ----------------');
@@ -126,10 +148,10 @@
             if cplx
                 fprintf('\n%14s  %16s  %16s  %16g', ...
                     idxstr, format_complex(full(got(k(u))), '%g'), ...
-                            format_complex(full(ex), '%g'), full(abs(got_minus_expected(k(u)))));
+                            format_complex(full(ex), '%g'), full(abs(got(k(u)) - ex)));
             else
                 fprintf('\n%14s  %16g  %16g  %16g', ...
-                    idxstr, full(got(k(u))), full(ex), full(abs(got_minus_expected(k(u)))));
+                    idxstr, full(got(k(u))), full(ex), full(abs(got(k(u)) - ex)));
             end
             if u == kk
                 fprintf('  *');