Mercurial > octave

changeset 30719:a885bdb22374

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: tweaks to cset a7c4fb821d64 (pow2). * pow2.cc: Add #include for "lo-array-errwarn.h" to get access to octave::err_nonconformant error function. Replace calls to error() with calls to octave::err_nonconformant() for mismatched input dimensions. Rename warning to "Octave:pow2:imaginary-ignored". Add BIST tests for input validation. * warning_ids.m: Add new ID "Octave:pow2:imaginary-only"
author Rik <rik@octave.org>
date Sun, 06 Feb 2022 15:47:43 -0800
parents 95ee9b9605cc
children 25de51cb4123
files libinterp/corefcn/pow2.cc scripts/help/warning_ids.m
diffstat 2 files changed, 21 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/pow2.cc	Sun Feb 06 15:11:01 2022 -0800
+++ b/libinterp/corefcn/pow2.cc	Sun Feb 06 15:47:43 2022 -0800
@@ -29,6 +29,8 @@
 
 #include <cmath>
 
+#include "lo-array-errwarn.h"
+
 #include "defun.h"
 #include "error.h"
 #include "errwarn.h"
@@ -46,7 +48,7 @@
   else if (f.numel () == 1)
     y = Array<T> (e.dims ());
   else
-    error ("pow2: Input dimensions must agree.");
+    octave::err_nonconformant ("pow2", f.dims (), e.dims ());
 
   octave_idx_type f_inc = (f.numel () == 1) ? 0 : 1;
   octave_idx_type e_inc = (e.numel () == 1) ? 0 : 1;
@@ -79,7 +81,7 @@
         }
     }
   else
-    error ("pow2: Input dimensions must agree.");
+    octave::err_nonconformant ("pow2", f.dims (), e.dims ());
 }
 
 OCTAVE_NAMESPACE_BEGIN
@@ -166,8 +168,8 @@
     err_wrong_type_arg ("pow2", args(1));
 
   if (args(0).iscomplex () || args(1).iscomplex ())
-    warning_with_id ("Octave:pow2:only-real",
-                     "pow2: Imaginary part is ignored.");
+    warning_with_id ("Octave:pow2:imaginary-ignored",
+                     "pow2: imaginary part is ignored");
 
   // Note: Matlab R2021a errors on `pow2 (sparse (f), single (e))`,
   //       but sparsity in f determines output and can significantly
@@ -252,7 +254,7 @@
 %! f = [2 2];
 %! e = [2 2];
 %! z = [8 8];
-%! warning ("off", "Octave:pow2:only-real", "local");
+%! warning ("off", "Octave:pow2:imaginary-ignored", "local");
 %! for i = 1:numel (fcns)
 %!   fcn = fcns{i};
 %!   assert (pow2 (fcn (f), fcn (e)), real (fcn (z)));
@@ -270,14 +272,14 @@
 %! f = [1+1i, 1];
 %! e = 2;
 %! z = [4, 4];
-%! warning ("off", "Octave:pow2:only-real", "local");
+%! warning ("off", "Octave:pow2:imaginary-ignored", "local");
 %! assert (pow2 (f, e), z);
 
 %!test
 %! f = 1;
 %! e = [1+1i, 1];
 %! z = [2, 2];
-%! warning ("off", "Octave:pow2:only-real", "local");
+%! warning ("off", "Octave:pow2:imaginary-ignored", "local");
 %! assert (pow2 (f, e), z);
 
 %!test
@@ -311,6 +313,13 @@
 %! assert (pow2 (sparse (0), speye  (N)),   sparse(N,N));
 
 %!error <Invalid call> pow2 ()
+%!error <Invalid call> pow2 (1,2,3)
+%!error <wrong type argument> pow2 (int8 (1))
+%!error <wrong type argument> pow2 (2, int8 (1))
+%!warning <imaginary part is ignored> pow2 (i, 2);
+%!warning <imaginary part is ignored> pow2 (2, i);
+%!error <pow2: nonconformant arguments> pow2 ([1,2], [3,4,5])
+%!error <pow2: nonconformant arguments> pow2 (sparse ([1,2]), sparse ([3,4,5]))
 */
 
 OCTAVE_NAMESPACE_END
--- a/scripts/help/warning_ids.m	Sun Feb 06 15:11:01 2022 -0800
+++ b/scripts/help/warning_ids.m	Sun Feb 06 15:47:43 2022 -0800
@@ -361,6 +361,11 @@
 ## By default, the @code{Octave:possible-matlab-short-circuit-operator} warning
 ## is enabled.
 ##
+## @item Octave:pow2:imaginary-ignored
+## If the @code{Octave:pow2:imaginary-ignored} warning is enabled, a warning is
+## printed if either input to @code{pow2} is complex.
+## By default, the @code{Octave:pow2:imaginary-ignored} warning is enabled.
+##
 ## @item Octave:recursive-path-search
 ## If the @code{Octave:recursive-path-search} warning is enabled, Octave
 ## will issue a warning if @code{addpath} is used with double trailing