remove CopyBadStatusCode key from PP

Author: mohawk2

Changes

@@ -23,6 +23,7 @@
 - add "update_data_from" method as streamlined get_dataref/upd_data
 - add Ops::csqrt{,_up} (#524) - thanks @wlmb
 - Core::upd_data now sets DATACHANGED so will work for flowing ops
+- remove CopyBadStatusCode key from PP (#517)
 
 2.098 2025-01-03
 - fix Windows build problems

lib/PDL/Bad.pd

@@ -820,10 +820,13 @@ EOF
       $GENERIC(b) a_val = $a();
       $b() = PDL_IF_BAD($ISBADVAR(a_val,a) ? replace : ,) a_val;
     %}
+    PDL->propagate_badflag( $PDL(b), 0 ); /* always make sure the output is "good" */
   },
-  CopyBadStatusCode => q{
-    PDL->propagate_badflag( b, 0 ); /* always make sure the output is "good" */
-  },
+  NewXSFindBadStatusNS => <<'EOF',
+PDL_RETERROR(PDL_err, PDL->trans_check_pdls(__privtrans));
+char $BADFLAGCACHE() = PDL->trans_badflag_from_inputs(__privtrans);
+$BADFLAGCACHE() = 0; /* override, but still need to call the above */
+EOF
   GenericTypes => $A,
 );
 

lib/PDL/BadValues.pod

@@ -100,8 +100,8 @@ but it will run slower since you are going to have to handle the presence of bad
 If you create an ndarray, it will have its bad-value flag set to 0. To change
 this, use C<< $pdl->badflag($new_bad_status) >>, where C<$new_bad_status> can be 0 or 1.
 When a routine creates an ndarray, its bad-value flag will depend on the input
-ndarrays: unless over-ridden (see the C<CopyBadStatusCode> option to C<pp_def>), the
-bad-value flag will be set true if any of the input ndarrays contain bad values.
+ndarrays: the
+bad-value flag will be set true if any of the input ndarrays have the bad-value flag.
 To check that an ndarray really contains bad data, use the C<check_badflag> method.
 
 I<NOTE>: propagation of the badflag

lib/PDL/PP.pm

@@ -371,10 +371,6 @@ sub dosubst_private {
       CROAK => sub {"return PDL->make_error(PDL_EUSERERROR, \"Error in $name:\" @{[join ',', @_]})"},
       NAME => sub {return $name},
       MODULE => sub {return $::PDLMOD},
-      SETPDLSTATEBAD  => sub { "$_[0]\->state |= PDL_BADVAL" },
-      SETPDLSTATEGOOD => sub { "$_[0]\->state &= ~PDL_BADVAL" },
-      ISPDLSTATEBAD   => \&badflag_isset,
-      ISPDLSTATEGOOD  => sub {"!".badflag_isset($_[0])},
       BADFLAGCACHE    => sub { "badflag_cache" },
       PDLSTATESETBAD => sub { ($sig->objs->{$_[0]}//confess "Can't get PDLSTATESETBAD for unknown ndarray '$_[0]'")->do_pdlaccess."->state |= PDL_BADVAL" },
       PDLSTATESETGOOD => sub { ($sig->objs->{$_[0]}->do_pdlaccess//confess "Can't get PDLSTATESETGOOD for unknown ndarray '$_[0]'")."->state &= ~PDL_BADVAL" },
@@ -1180,10 +1176,10 @@ $PDL::PP::deftbl =
    PDL::PP::Rule::Returns->new("Doc", [], 'Sets the default doc string',
     "\n=for ref\n\ninfo not available\n"),
 
-   PDL::PP::Rule->new("BadDoc", [qw(BadFlag Name CopyBadStatusCode?)],
+   PDL::PP::Rule->new("BadDoc", [qw(BadFlag Name)],
               'Sets the default documentation for handling of bad values',
       sub {
-         my ($bf, $name, $code) = @_;
+         my ($bf, $name) = @_;
          my $str;
          if ( not defined($bf) ) {
             $str = "C<$name> does not process bad values.\n";
@@ -1192,14 +1188,8 @@ $PDL::PP::deftbl =
          } else {
             $str = "C<$name> ignores the bad-value flag of the input ndarrays.\n";
          }
-         if ( not defined($code) ) {
-            $str .= "It will set the bad-value flag of all output ndarrays if " .
-            "the flag is set for any of the input ndarrays.\n";
-         } elsif (  $code eq '' ) {
-            $str .= "The output ndarrays will NOT have their bad-value flag set.\n";
-         } else {
-            $str .= "The state of the bad-value flag of the output ndarrays is unknown.\n";
-         }
+         $str .= "It will set the bad-value flag of all output ndarrays if " .
+           "the flag is set for any of the input ndarrays.\n";
       }
    ),
 
@@ -1957,15 +1947,6 @@ char \$BADFLAGCACHE() = PDL->trans_badflag_from_inputs($_[0]); (void)\$BADFLAGCA
 EOF
       }),
 
-   PDL::PP::Rule->new("NewXSCopyBadStatusNS",
-      ["CopyBadStatusCode"],
-      "Use CopyBadStatusCode if given",
-      sub {
-        my ($badcode) = @_;
-        confess "PDL::PP ERROR: CopyBadStatusCode contains '\$PRIV(bvalflag)'; replace with \$BADFLAGCACHE()"
-          if $badcode =~ m/\$PRIV(bvalflag)/;
-        $badcode;
-      }),
    PDL::PP::Rule->new("NewXSCopyBadStatusNS",
       ["SignatureObj"],
       "Rule to copy the bad value status to the output ndarrays",
@@ -1977,7 +1958,7 @@ EOF
         return '' if @{$sig->names} == (my @outs = $sig->names_out); # no input pdls, no badflag copying needed
         !@outs ? '' : PDL::PP::indent(2, join '', # no outs, ditto
           "if (\$BADFLAGCACHE()) {\n",
-          (map "  \$SETPDLSTATEBAD($_);\n", @outs),
+          (map "  $_->state |= PDL_BADVAL;\n", @outs),
           "}\n");
       }),
 

lib/PDL/PP.pod

@@ -1175,22 +1175,7 @@ I<TODO:> mention C<$PISBAD()> etc macros.
 =head2 PDL STATE macros
 
 If you want access to the value of the badflag for a given
-ndarray, you can use the PDL STATE macros,
-for use in L</CopyBadStatusCode>.
-
-=over 4
-
-=item $ISPDLSTATEBAD(pdl)
-
-=item $ISPDLSTATEGOOD(pdl)
-
-=item $SETPDLSTATEBAD(pdl)
-
-=item $SETPDLSTATEGOOD(pdl)
-
-=back
-
-And for use in C<Code> sections:
+ndarray, you can use the PDL STATE macros.
 
 =over 4
 
@@ -1871,21 +1856,6 @@ completeness.
 
 =back
 
-If bad values are being used, care must be taken to ensure the
-propagation of the badflag when inplace is being used;
-consider this excerpt from F<lib/PDL/Bad.pd>:
-
-  pp_def('setbadtoval',
-    HandleBad => 1,
-    Pars => 'a(); [o]b();',
-    OtherPars => 'double newval',
-    Inplace => 1,
-    CopyBadStatusCode => 'PDL->propagate_badflag( b, 0 );',
-    ...
-
-Since this routine removes all bad values, the output ndarray had
-its bad flag cleared. This is then propagated to both parents and children.
-
 The documentation for the routine is now (as of 2.099)
 automatically flagged to indicate that it can be executed inplace,
 similar to how C<HandleBad> sets C<BadDoc> if it's not
@@ -2462,20 +2432,6 @@ section will be reused, on the assumption it will use
 C<#ifdef PDL_BAD_CODE> to handle bad values.
 As of 2.073, you can, and are recommended to, use C<PDL_IF_BAD(iftrue,iffalse)>.
 
-=head3 CopyBadStatusCode
-
-As of 2.079, this is deprecated due to being largely unnecessary;
-instead, just use C<$PDLSTATESETBAD(pdlname)> in your C<Code> section
-and the badflag setting will be propagated to all its parents and
-children.
-
-The default code here sets the bad flag of the output ndarrays if
-C<$BADFLAGCACHE()> is true after the code has been
-evaluated.  Sometimes C<CopyBadStatusCode> is set to an empty string,
-with the responsibility of setting the badflag of the output ndarray
-left to the C<BadCode> section (e.g. the C<xxxover> routines
-in F<lib/PDL/Ufunc.pd>).
-
 =head3 GenericTypes
 
 An array reference. The array may contain any subset of the one-character