STYLE: Use itk::Math::safe_abs name directly

The itk::Math::safe_abs is subtly different from
the std::abs and other typical absolute value functions,
so use the more explicit name to clearly indicate
that the behaviors are not the same as the
core c++ similarly named functions.

Use ITK_FUTURE_LEGACY_REMOVE of the itk::Math::abs
supported name.

Author: hjmjohnson

Documentation/docs/releases/4.13.md

@@ -215,7 +215,7 @@ Bradley Lowekamp (93) @blowekamp :
       BUG: Modify google test to define _VARIADIC_MAX=10
       COMP: Fix using system GoogleTest with a compiled system library
       ENH: Add SliceImageFilter
-      COMP: Use itk::Math::abs over vnl_math_abs
+      COMP: Use itk::Math::safe_abs over vnl_math_abs
       ENH: Add GetProbe method to collectors base.
       BUG: Add missing exports for GTest::* targets
       BUG: Fix computation of central moments for shape label map

Documentation/docs/releases/5.3.md

@@ -1331,7 +1331,7 @@ Remote Module Changes Since v5.3rc04
 
 #### Style Changes
 
-- use itk::Math::abs instead of fabs ([9f910c8a](https://github.com/RTKConsortium/RTK/commit/9f910c8a))
+- use itk::Math::safe_abs instead of fabs ([9f910c8a](https://github.com/RTKConsortium/RTK/commit/9f910c8a))
 
 
 ### Shengpeng YU (1):

Documentation/docs/releases/5.3rc03.md

@@ -294,7 +294,7 @@ ITK Changes Since v5.3rc02
 - Address clang-tidy warnings in itkNumericTraitsTest.cxxv ([89f1bca360](https://github.com/InsightSoftwareConsortium/ITK/commit/89f1bca360))
 - Remove IsInteger and replace with std::is_integer ([b3f80bb295](https://github.com/InsightSoftwareConsortium/ITK/commit/b3f80bb295))
 - Remove IsSigned and replace with std::is_signed ([da13473cb0](https://github.com/InsightSoftwareConsortium/ITK/commit/da13473cb0))
-- Prefer itk::Math::abs over abs or fabs ([d715b098ba](https://github.com/InsightSoftwareConsortium/ITK/commit/d715b098ba))
+- Prefer itk::Math::safe_abs over abs or fabs ([d715b098ba](https://github.com/InsightSoftwareConsortium/ITK/commit/d715b098ba))
 - Allow use of clang-tidy as part of cmake compilation ([55db25c240](https://github.com/InsightSoftwareConsortium/ITK/commit/55db25c240))
 - Do not use double underscore defines ([191e122087](https://github.com/InsightSoftwareConsortium/ITK/commit/191e122087))
 - Remove recursive inclusion of .h files ([f84720ee08](https://github.com/InsightSoftwareConsortium/ITK/commit/f84720ee08))
@@ -820,7 +820,7 @@ ITK Sphinx Examples Changes Since v5.3rc02
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([28820f48](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/commit/28820f48))
+- Prefer itk::Math::safe_abs for consistency. ([28820f48](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/commit/28820f48))
 - address unused variable warnings. ([89a73005](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/commit/89a73005))
 - Remove outdated pre ITKv4 code ([5b3015a7](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/commit/5b3015a7))
 - Remove python style warnings ([e4742994](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/commit/e4742994))

Documentation/docs/releases/5.3rc04.md

@@ -1329,7 +1329,7 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([c8db62a](https://github.com/InsightSoftwareConsortium/ITKGrowCut/commit/c8db62a))
+- Prefer itk::Math::safe_abs for consistency. ([c8db62a](https://github.com/InsightSoftwareConsortium/ITKGrowCut/commit/c8db62a))
 
 
 ### Kian Weimer (3):
@@ -1427,7 +1427,7 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([3ac09fa](https://github.com/KitwareMedical/ITKIOScanco/commit/3ac09fa))
+- Prefer itk::Math::safe_abs for consistency. ([3ac09fa](https://github.com/KitwareMedical/ITKIOScanco/commit/3ac09fa))
 
 
 
@@ -1469,7 +1469,7 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([c1a8417](https://github.com/InsightSoftwareConsortium/LesionSizingToolkit/commit/c1a8417))
+- Prefer itk::Math::safe_abs for consistency. ([c1a8417](https://github.com/InsightSoftwareConsortium/LesionSizingToolkit/commit/c1a8417))
 
 
 
@@ -1489,7 +1489,7 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([8decfcf](https://github.com/InsightSoftwareConsortium/itkMGHImageIO/commit/8decfcf))
+- Prefer itk::Math::safe_abs for consistency. ([8decfcf](https://github.com/InsightSoftwareConsortium/itkMGHImageIO/commit/8decfcf))
 
 
 ### Jean-Christophe Fillion-Robin (2):
@@ -1596,8 +1596,8 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([7ad5492](https://github.com/InsightSoftwareConsortium/ITKMontage/commit/7ad5492))
-- Prefer itk::Math::abs for consistency. ([d595149](https://github.com/InsightSoftwareConsortium/ITKMontage/commit/d595149))
+- Prefer itk::Math::safe_abs for consistency. ([7ad5492](https://github.com/InsightSoftwareConsortium/ITKMontage/commit/7ad5492))
+- Prefer itk::Math::safe_abs for consistency. ([d595149](https://github.com/InsightSoftwareConsortium/ITKMontage/commit/d595149))
 - Match clang-format style ([c11ec2a](https://github.com/InsightSoftwareConsortium/ITKMontage/commit/c11ec2a))
 
 
@@ -1630,7 +1630,7 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([aa4cf17](https://github.com/KitwareMedical/ITKMorphologicalContourInterpolation/commit/aa4cf17))
+- Prefer itk::Math::safe_abs for consistency. ([aa4cf17](https://github.com/KitwareMedical/ITKMorphologicalContourInterpolation/commit/aa4cf17))
 
 
 
@@ -1697,7 +1697,7 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([aa5f6a0](https://github.com/InsightSoftwareConsortium/ITKPolarTransform/commit/aa5f6a0))
+- Prefer itk::Math::safe_abs for consistency. ([aa5f6a0](https://github.com/InsightSoftwareConsortium/ITKPolarTransform/commit/aa5f6a0))
 
 
 
@@ -1773,7 +1773,7 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([05f3ad2c](https://github.com/SimonRit/RTK/commit/05f3ad2c))
+- Prefer itk::Math::safe_abs for consistency. ([05f3ad2c](https://github.com/SimonRit/RTK/commit/05f3ad2c))
 
 
 ### Lucas Gandel (2):
@@ -1824,7 +1824,7 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([c759c9a9](https://github.com/SimonRit/RTK/commit/c759c9a9))
+- Prefer itk::Math::safe_abs for consistency. ([c759c9a9](https://github.com/SimonRit/RTK/commit/c759c9a9))
 - fix clang-format style in a few RTK files ([a9bd58e7](https://github.com/SimonRit/RTK/commit/a9bd58e7))
 - remove useless member for the union of 3 objects ([5522ddd3](https://github.com/SimonRit/RTK/commit/5522ddd3))
 - Prefer error checked std::stod over atof ([e6c48ebc](https://github.com/SimonRit/RTK/commit/e6c48ebc))
@@ -2017,7 +2017,7 @@ Remote Module Changes Since v5.3rc03
 
 #### Style Changes
 
-- Prefer itk::Math::abs for consistency. ([8e77598](https://github.com/InsightSoftwareConsortium/ITKTwoProjectionRegistration/commit/8e77598))
+- Prefer itk::Math::safe_abs for consistency. ([8e77598](https://github.com/InsightSoftwareConsortium/ITKTwoProjectionRegistration/commit/8e77598))
 
 
 

Examples/RegistrationITKv4/ImageRegistration11.cxx

@@ -85,7 +85,7 @@ class CommandIterationUpdate : public itk::Command
     }
     const double currentValue = optimizer->GetValue();
     // Only print out when the Metric value changes
-    if (itk::Math::abs(m_LastMetricValue - currentValue) > 1e-7)
+    if (itk::Math::safe_abs(m_LastMetricValue - currentValue) > 1e-7)
     {
       std::cout << optimizer->GetCurrentIteration() << "   ";
       std::cout << currentValue << "   ";

Examples/RegistrationITKv4/ImageRegistration14.cxx

@@ -76,7 +76,7 @@ class CommandIterationUpdate : public itk::Command
     }
     const double currentValue = optimizer->GetValue();
     // Only print out when the Metric value changes
-    if (itk::Math::abs(m_LastMetricValue - currentValue) > 1e-7)
+    if (itk::Math::safe_abs(m_LastMetricValue - currentValue) > 1e-7)
     {
       std::cout << optimizer->GetCurrentIteration() << "   ";
       std::cout << currentValue << "   ";

Examples/RegistrationITKv4/ImageRegistration15.cxx

@@ -75,7 +75,7 @@ class CommandIterationUpdate : public itk::Command
     }
     const double currentValue = optimizer->GetValue();
     // Only print out when the Metric value changes
-    if (itk::Math::abs(m_LastMetricValue - currentValue) > 1e-7)
+    if (itk::Math::safe_abs(m_LastMetricValue - currentValue) > 1e-7)
     {
       std::cout << optimizer->GetCurrentIteration() << "   ";
       std::cout << currentValue << "   ";

Modules/Core/Common/include/itkBSplineKernelFunction.h

@@ -98,7 +98,7 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
   static inline TRealValueType
   Evaluate(const Dispatch<0> &, const TRealValueType & u)
   {
-    const TRealValueType absValue = itk::Math::abs(u);
+    const TRealValueType absValue = itk::Math::safe_abs(u);
     if (absValue < TRealValueType{ 0.5 })
     {
       return TRealValueType{ 1.0 };
@@ -117,7 +117,7 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
   static inline TRealValueType
   Evaluate(const Dispatch<1> &, const TRealValueType & u)
   {
-    const TRealValueType absValue = itk::Math::abs(u);
+    const TRealValueType absValue = itk::Math::safe_abs(u);
     if (absValue < TRealValueType{ 1.0 })
     {
       return TRealValueType{ 1.0 } - absValue;
@@ -130,7 +130,7 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
   static inline TRealValueType
   Evaluate(const Dispatch<2> &, const TRealValueType & u)
   {
-    const TRealValueType absValue = itk::Math::abs(u);
+    const TRealValueType absValue = itk::Math::safe_abs(u);
     if (absValue < TRealValueType{ 0.5 })
     {
       const TRealValueType sqrValue = itk::Math::sqr(absValue);
@@ -153,7 +153,7 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
   static inline TRealValueType
   Evaluate(const Dispatch<3> &, const TRealValueType & u)
   {
-    const TRealValueType absValue = itk::Math::abs(u);
+    const TRealValueType absValue = itk::Math::safe_abs(u);
     if (absValue < TRealValueType{ 1.0 })
     {
       const TRealValueType sqrValue = itk::Math::sqr(absValue);

Modules/Core/Common/include/itkBresenhamLine.hxx

@@ -49,7 +49,7 @@ BresenhamLine<VDimension>::BuildLine(LType Direction, IdentifierType length) ->
   IndexType overflowIncrement;
   for (unsigned int i = 0; i < VDimension; ++i)
   {
-    auto distance = static_cast<long>(itk::Math::abs(LastIndex[i]));
+    auto distance = static_cast<long>(itk::Math::safe_abs(LastIndex[i]));
     if (distance > maxDistance)
     {
       maxDistance = distance;
@@ -113,7 +113,7 @@ BresenhamLine<VDimension>::BuildLine(IndexType p0, IndexType p1) -> IndexArray
   {
     point0[i] = p0[i];
     point1[i] = p1[i];
-    const IdentifierType distance = itk::Math::abs(p0[i] - p1[i]) + 1;
+    const IdentifierType distance = itk::Math::safe_abs(p0[i] - p1[i]) + 1;
     if (distance > maxDistance)
     {
       maxDistance = distance;

Modules/Core/Common/include/itkFiniteCylinderSpatialFunction.hxx

@@ -102,7 +102,7 @@ FiniteCylinderSpatialFunction<VDimension, TInput>::Evaluate(const InputType & po
     FloatingPointExceptions::SetEnabled(saveFPEState);
   }
 
-  if (itk::Math::abs(distanceFromCenter) <= (halfAxisLength) &&
+  if (itk::Math::safe_abs(distanceFromCenter) <= (halfAxisLength) &&
       m_Radius >= std::sqrt(Math::sqr(pointVector.GetNorm()) - Math::sqr(distanceFromCenter)))
   {
     return 1;