Merge pull request InsightSoftwareConsortium#5752 from InsightSoftwareConsortium/remove-long-double-support

COMP: Remove undefined long double swig wrapping

Author: hjmjohnson

Documentation/docs/migration_guides/itk_6_migration_guide.md

@@ -171,3 +171,22 @@ reoriented_image = itk.orient_image_filter(
     ),
 )
 ```
+
+Remove support for Python wrapped `long double` types
+-----------------------------------------------------
+
+The swig wrapping of `long double` types into python
+resulted in implicit type conversions to `double`,
+which results in silent loss of precision.
+
+There has never been an option for "ITK_WRAP_long_double"
+configuration, and manually wrapped functions in vnl for
+for long double were never needed by ITK based functions.
+
+Given the undefined behavior of wrapping long double types
+with swig, and given that there is no use case for long double
+support directly from the wrapped ITK API, these manual vnl
+wrappings could not be reached from ITK interfaces.
+
+The handful of manually wrapped long double functions were
+removed from python wrapping.

Modules/Core/Common/wrapping/itkNumericTraits.wrap

@@ -30,7 +30,6 @@ foreach(
   SL
   F
   D
-  LD
   B)
   itk_wrap_template("${ITKM_${t}}" "${ITKT_${t}}")
 endforeach()
@@ -51,7 +50,6 @@ foreach(
   SL
   F
   D
-  LD
   B)
   itk_wrap_template("${ITKM_${t}}" "${ITKT_${t}}")
 endforeach()

Modules/Core/Common/wrapping/vnl_c_vector.wrap

@@ -10,7 +10,6 @@ itk_wrap_template("${ITKM_F}" "${ITKT_F}")
 itk_wrap_template("${ITKM_SI}" "${ITKT_SI}")
 itk_wrap_template("${ITKM_SL}" "${ITKT_SL}")
 itk_wrap_template("${ITKM_SLL}" "${ITKT_SLL}")
-itk_wrap_template("${ITKM_LD}" "${ITKT_LD}")
 itk_wrap_template("${ITKM_SC}" "${ITKT_SC}")
 itk_wrap_template("${ITKM_UC}" "un${ITKT_SC}")
 itk_wrap_template("${ITKM_UI}" "un${ITKT_SI}")

Modules/Core/Common/wrapping/vnl_diag_matrix.wrap

@@ -8,7 +8,6 @@ itk_wrap_class("vnl_diag_matrix" EXPLICIT_SPECIALIZATION)
 itk_wrap_template("${ITKM_D}" "${ITKT_D}")
 itk_wrap_template("${ITKM_F}" "${ITKT_F}")
 itk_wrap_template("${ITKM_SI}" "${ITKT_SI}")
-itk_wrap_template("${ITKM_LD}" "${ITKT_LD}")
 foreach(t ${WRAP_ITK_COMPLEX_REAL})
   itk_wrap_template("${ITKM_${t}}" "${ITKT_${t}}")
 endforeach()

Modules/Core/Common/wrapping/vnl_matrix.wrap

@@ -11,7 +11,6 @@ itk_wrap_template("${ITKM_F}" "${ITKT_F}")
 itk_wrap_template("${ITKM_SI}" "${ITKT_SI}")
 itk_wrap_template("${ITKM_SL}" "${ITKT_SL}")
 itk_wrap_template("${ITKM_SLL}" "${ITKT_SLL}")
-itk_wrap_template("${ITKM_LD}" "${ITKT_LD}")
 itk_wrap_template("${ITKM_SC}" "${ITKT_SC}")
 itk_wrap_template("${ITKM_UC}" "un${ITKT_SC}")
 itk_wrap_template("${ITKM_UI}" "un${ITKT_SI}")

Modules/Core/Common/wrapping/vnl_vector.wrap

@@ -6,7 +6,7 @@ itk_wrap_include("vnl/vnl_matrix.h")
 itk_wrap_include("vnl/vnl_vector.h")
 
 itk_wrap_class("vnl_vector" EXPLICIT_SPECIALIZATION)
-unique(vector_types "D;F;SI;SL;SLL;LD;SC;UC;US;UI;UL;ULL;${ITKM_IT};${ITKM_OT};${WRAP_ITK_SCALAR}")
+unique(vector_types "D;F;SI;SL;SLL;SC;UC;US;UI;UL;ULL;${ITKM_IT};${ITKM_OT};${WRAP_ITK_SCALAR}")
 foreach(t ${vector_types})
   itk_wrap_template("${ITKM_${t}}" "${ITKT_${t}}")
 endforeach()

Modules/Core/Common/wrapping/vnl_vector_ref.wrap

@@ -4,7 +4,7 @@ set(WRAPPER_AUTO_INCLUDE_HEADERS OFF)
 itk_wrap_include("vnl/vnl_vector_ref.h")
 
 itk_wrap_class("vnl_vector_ref" EXPLICIT_SPECIALIZATION)
-unique(vector_types "D;F;SI;SL;SLL;LD;SC;UC;US;UI;UL;ULL;${WRAP_ITK_SCALAR}")
+unique(vector_types "D;F;SI;SL;SLL;SC;UC;US;UI;UL;ULL;${WRAP_ITK_SCALAR}")
 foreach(t ${vector_types})
   itk_wrap_template("${ITKM_${t}}" "${ITKT_${t}}")
 endforeach()

Wrapping/Generators/Python/itk/__init__.py

@@ -36,7 +36,6 @@
     UI,
     UL,
     SL,
-    LD,
     ULL,
     SC,
     SS,

Wrapping/Generators/Python/itk/support/types.py

@@ -127,21 +127,16 @@ def initialize_c_types_once() -> (
         if os.name == "nt":
             _UL: "itkCType" = itkCType("unsigned long", "UL", np.dtype(np.uint32))
             _SL: "itkCType" = itkCType("signed long", "SL", np.dtype(np.int32))
-            _LD: "itkCType" = itkCType("long double", "LD")
         else:
             _UL: "itkCType" = itkCType("unsigned long", "UL", np.dtype(np.uint64))
             _SL: "itkCType" = itkCType("signed long", "SL", np.dtype(np.int64))
-            if hasattr(np, "float128"):
-                _LD: "itkCType" = itkCType("long double", "LD", np.dtype(np.float128))
-            else:
-                _LD: "itkCType" = itkCType("long double", "LD")
         _ULL: "itkCType" = itkCType("unsigned long long", "ULL", np.dtype(np.uint64))
         _SC: "itkCType" = itkCType("signed char", "SC", np.dtype(np.int8))
         _SS: "itkCType" = itkCType("signed short", "SS", np.dtype(np.int16))
         _SI: "itkCType" = itkCType("signed int", "SI", np.dtype(np.int32))
         _SLL: "itkCType" = itkCType("signed long long", "SLL", np.dtype(np.int64))
         _B: "itkCType" = itkCType("bool", "B", np.dtype(np.bool_))
-        return _F, _D, _UC, _US, _UI, _UL, _SL, _LD, _ULL, _SC, _SS, _SI, _SLL, _B
+        return _F, _D, _UC, _US, _UI, _UL, _SL, _ULL, _SC, _SS, _SI, _SLL, _B
 
 
 # Define typing hints
@@ -152,7 +147,6 @@ def initialize_c_types_once() -> (
 UI: itkCType
 UL: itkCType
 SL: itkCType
-LD: itkCType
 ULL: itkCType
 SC: itkCType
 SS: itkCType
@@ -168,7 +162,6 @@ def initialize_c_types_once() -> (
     UI,
     UL,
     SL,
-    LD,
     ULL,
     SC,
     SS,

Wrapping/WrapBasicTypes.cmake

@@ -39,9 +39,6 @@ set(ITKM_F "F") # Mangle
 set(ITKT_D "double") # Type
 set(ITKM_D "D") # Mangle
 
-set(ITKT_LD "long double") # Type
-set(ITKM_LD "LD") # Mangle
-
 set(ITKT_B "bool") # Type
 set(ITKM_B "B") # Mangle