ENH: Cover all deprecated vnl_math spellings in VNL_ModernizeNaming.py

Handle the namespace-style vnl_math:: spellings (constants, functions,
predicates, std re-exports, abs) alongside the legacy vnl_math_*
globals, targeting C++17-compatible itk::Math/std equivalents. Report
vnl_huge_val occurrences for manual, type-aware migration.

Author: hjmjohnson

Utilities/Maintenance/VNL_ModernizeNaming.py

@@ -1,105 +1,86 @@
-#!/bin/env python
+#!/usr/bin/env python3
 # \author Hans J. Johnson
 #
-# Prepare for the future by recommending
-# use of itk::Math:: functions over
-# vnl_math:: functions.
-# Rather than converting vnl_math_ to vnl_math::
-# this prefers to convert directly to itk::Math::
-# namespace.  In cases where vnl_math:: is simply
-# an alias to std:: functions, itk::Math directly
-# uses the std:: version of the function.
+# Migrate a source file away from deprecated vnl_math usage, preferring
+# replacements that compile under C++17:
+#   - vnl_math:: constants, functions, and predicates -> itk::Math:: equivalents
+#   - vnl_math:: re-exports of std functions (max/min/cbrt/hypot) -> std::
+#   - vnl_math::abs / vnl_math_abs -> itk::Math::Absolute
+#   - legacy vnl_math_* global-function spellings -> the same modern targets
+#   - "vnl/vnl_math.h" include -> "itkMath.h"
+# vnl_huge_val cannot be rewritten textually (the replacement type depends on
+# context); occurrences are reported for manual migration to
+# std::numeric_limits<T>::infinity() or itk::NumericTraits<T>::max().
 
-import os
 import sys
 from collections import OrderedDict
+from pathlib import Path
 
-## slight modification from grep command
-info_for_conversion = """
-XXXX,vnl_math_isnan,itk::Math::isnan
-XXXX,vnl_math_isinf,itk::Math::isinf
-XXXX,vnl_math_isfinite,itk::Math::isfinite
-XXXX,vnl_math_isnormal,itk::Math::isnormal
-XXXX,vnl_math_max,std::max
-XXXX,vnl_math_min,std::min
-XXXX,vnl_math_cuberoot,itk::Math::cbrt
-XXXX,vnl_math_hypot,itk::Math::hypot
-XXXX,vnl_math_angle_0_to_2pi,itk::Math::angle_0_to_2pi
-XXXX,vnl_math_angle_minuspi_to_pi,itk::Math::angle_minuspi_to_pi
-XXXX,vnl_math_rnd_halfinttoeven,itk::Math::halfinttoeven
-XXXX,vnl_math_rnd_halfintup,itk::Math::rnd_halfintup
-XXXX,vnl_math_rnd,itk::Math::rnd
-XXXX,vnl_math_floor,itk::Math::floor
-XXXX,vnl_math_ceil,itk::Math::ceil
-XXXX,vnl_math_abs,itk::Math::Absolute
-XXXX,vnl_math_sqr,itk::Math::sqr
-XXXX,vnl_math_cube,itk::Math::cube
-XXXX,vnl_math_sgn,itk::Math::sgn
-XXXX,vnl_math_sgn0,itk::Math::sgn0
-XXXX,vnl_math_squared_magnitude,itk::Math::squared_magnitude
-XXXX,vnl_math_remainder_truncated,itk::Math::remainder_truncated
-XXXX,vnl_math_remainder_floored,itk::Math::remainder_floored
-"""
+replacements = OrderedDict()
 
-ITK_replace_head_names = OrderedDict()
-ITK_replace_functionnames = OrderedDict()
-ITK_replace_manual = OrderedDict()
+# Includes.
+replacements['"vnl/vnl_math.h"'] = '"itkMath.h"'
+replacements["<vnl/vnl_math.h>"] = "<itkMath.h>"
 
-ITK_replace_manual['"vnl/vnl_math.h"'] = '"itkMath.h"'
-ITK_replace_manual["<vnl/vnl_math.h>"] = "<itkMath.h>"
+# Namespace spellings whose itk::Math name differs (must precede the catch-all).
+replacements["vnl_math::max"] = "std::max"
+replacements["vnl_math::min"] = "std::min"
+replacements["vnl_math::cbrt"] = "std::cbrt"
+replacements["vnl_math::hypot"] = "std::hypot"
+replacements["vnl_math::abs"] = "itk::Math::Absolute"
 
-for line in info_for_conversion.splitlines():
-    linevalues = line.split(",")
-    if len(linevalues) != 3:
-        # print("SKIPPING: " + str(linevalues))
-        continue
-    fname = linevalues[0]
-    new_name = fname.replace("ITK_", "").replace(".h", "")
-    ITK_replace_head_names[
-        f'#include "{fname}"'
-    ] = f"""#if !defined( ITK_LEGACY_FUTURE_REMOVE )
-# include "{fname}"
-#endif
-#include <{new_name}>"""
-    ITK_replace_head_names[
-        f"#include <{fname}>"
-    ] = f"""#if !defined( ITK_LEGACY_FUTURE_REMOVE )
-# include <{fname}>
-#endif
-#include <{new_name}>"""
-    ITK_pat = linevalues[1]
-    new_pat = linevalues[2]
-    ITK_replace_functionnames[ITK_pat] = new_pat
-    # Need to fix the fact that both std::ios is a base and a prefix
-    if "std::ios::" in new_pat:
-        ITK_replace_manual[new_pat.replace("std::ios::", "std::ios_")] = new_pat
+# Catch-all: every other deprecated vnl_math:: member (constants, the 14
+# functions, isnan/isinf/isfinite/isnormal) maps name-identically.
+replacements["vnl_math::"] = "itk::Math::"
 
-# print(ITK_replace_head_names)
-# print(ITK_replace_functionnames)
+# Legacy global-function spellings. Longer names precede their prefixes so
+# sequential str.replace cannot corrupt them.
+replacements["vnl_math_isnan"] = "itk::Math::isnan"
+replacements["vnl_math_isinf"] = "itk::Math::isinf"
+replacements["vnl_math_isfinite"] = "itk::Math::isfinite"
+replacements["vnl_math_isnormal"] = "itk::Math::isnormal"
+replacements["vnl_math_max"] = "std::max"
+replacements["vnl_math_min"] = "std::min"
+replacements["vnl_math_cuberoot"] = "std::cbrt"
+replacements["vnl_math_hypot"] = "std::hypot"
+replacements["vnl_math_abs"] = "itk::Math::Absolute"
+replacements["vnl_math_angle_0_to_2pi"] = "itk::Math::angle_0_to_2pi"
+replacements["vnl_math_angle_minuspi_to_pi"] = "itk::Math::angle_minuspi_to_pi"
+replacements["vnl_math_rnd_halfinttoeven"] = "itk::Math::rnd_halfinttoeven"
+replacements["vnl_math_rnd_halfintup"] = "itk::Math::rnd_halfintup"
+replacements["vnl_math_rnd"] = "itk::Math::rnd"
+replacements["vnl_math_floor"] = "itk::Math::floor"
+replacements["vnl_math_ceil"] = "itk::Math::ceil"
+replacements["vnl_math_sqr"] = "itk::Math::sqr"
+replacements["vnl_math_cube"] = "itk::Math::cube"
+replacements["vnl_math_sgn0"] = "itk::Math::sgn0"
+replacements["vnl_math_sgn"] = "itk::Math::sgn"
+replacements["vnl_math_squared_magnitude"] = "itk::Math::squared_magnitude"
+replacements["vnl_math_remainder_truncated"] = "itk::Math::remainder_truncated"
+replacements["vnl_math_remainder_floored"] = "itk::Math::remainder_floored"
 
-cfile = sys.argv[1]
 
-file_as_string = ""
-with open(cfile) as rfp:
-    original_string = rfp.read()
-file_as_string = original_string
+def main() -> int:
+    cfile = Path(sys.argv[1])
+    original_string = cfile.read_text()
+    file_as_string = original_string
 
-required_header = ""  ## For ITK, this is always empty
+    for searchval, replaceval in replacements.items():
+        file_as_string = file_as_string.replace(searchval, replaceval)
 
-for searchval, replaceval in ITK_replace_head_names.items():
-    file_as_string_new = file_as_string.replace(searchval, required_header + replaceval)
-    if file_as_string_new != file_as_string:
-        required_header = ""
-    file_as_string = file_as_string_new
+    if "vnl_huge_val" in file_as_string:
+        print(
+            f"MANUAL FIX NEEDED: {cfile}: vnl_huge_val -> "
+            "std::numeric_limits<T>::infinity() or itk::NumericTraits<T>::max()"
+        )
 
+    if file_as_string != original_string:
+        print(f"Processing: {cfile}")
+        cfile.write_text(file_as_string)
+    else:
+        print(f"SKIPPING: {cfile}")
+    return 0
 
-for searchval, replaceval in ITK_replace_functionnames.items():
-    file_as_string = file_as_string.replace(searchval, replaceval)
-for searchval, replaceval in ITK_replace_manual.items():
-    file_as_string = file_as_string.replace(searchval, replaceval)
-if file_as_string != original_string:
-    print(f"Processing: {cfile}")
-    with open(cfile, "w") as wfp:
-        wfp.write(file_as_string)
-else:
-    print(f"SKIPPING: {cfile}")
+
+if __name__ == "__main__":
+    sys.exit(main())