[SYCL] fast_{length|distance|normalize} should only accept float element type (#12183)

Author: aelovikov-intel

sycl/include/sycl/builtins_legacy_marray_vec.hpp

@@ -964,6 +964,8 @@ float fast_distance(T p0, T p1) {
 // double fast_distance (gengeodouble p0, gengeodouble p1)
 template <typename T,
           typename = std::enable_if_t<detail::is_gengeodouble_v<T>, T>>
+__SYCL_DEPRECATED("fast_distance for double precision types is non-standard "
+                  "and has been deprecated")
 double fast_distance(T p0, T p1) {
   return __sycl_std::__invoke_fast_distance<double>(p0, p1);
 }
@@ -978,6 +980,8 @@ float fast_length(T p) {
 // double fast_length (gengeodouble p)
 template <typename T,
           typename = std::enable_if_t<detail::is_gengeodouble_v<T>, T>>
+__SYCL_DEPRECATED("fast_length for double precision types is non-standard "
+                  "and has been deprecated")
 double fast_length(T p) {
   return __sycl_std::__invoke_fast_length<double>(p);
 }
@@ -990,6 +994,8 @@ std::enable_if_t<detail::is_gengeofloat_v<T>, T> fast_normalize(T p) {
 
 // gengeodouble fast_normalize (gengeodouble p)
 template <typename T>
+__SYCL_DEPRECATED("fast_normalize for double precision types is non-standard "
+                  "and has been deprecated")
 std::enable_if_t<detail::is_gengeodouble_v<T>, T> fast_normalize(T p) {
   return __sycl_std::__invoke_fast_normalize<T>(p);
 }

sycl/source/builtins_generator.py

@@ -999,15 +999,9 @@ def custom_nan_invoke(return_type, arg_types, arg_names):
                  "normalize": [Def("gengeofloat", ["gengeofloat"], template_scalar_args=True),
                                Def("gengeodouble", ["gengeodouble"], template_scalar_args=True),
                                Def("gengeohalf", ["gengeohalf"], template_scalar_args=True)],
-                 "fast_distance": [Def("float", ["gengeofloat", "gengeofloat"], template_scalar_args=True),
-                                   Def("double", ["gengeodouble", "gengeodouble"], template_scalar_args=True),
-                                   Def("half", ["gengeohalf", "gengeohalf"], template_scalar_args=True)],
-                 "fast_length": [Def("float", ["gengeofloat"], template_scalar_args=True),
-                                 Def("double", ["gengeodouble"], template_scalar_args=True),
-                                 Def("half", ["gengeohalf"], template_scalar_args=True)],
-                 "fast_normalize": [Def("gengeofloat", ["gengeofloat"], template_scalar_args=True),
-                                    Def("gengeodouble", ["gengeodouble"], template_scalar_args=True),
-                                    Def("gengeohalf", ["gengeohalf"], template_scalar_args=True)],
+                 "fast_distance": [Def("float", ["gengeofloat", "gengeofloat"], template_scalar_args=True)],
+                 "fast_length": [Def("float", ["gengeofloat"], template_scalar_args=True)],
+                 "fast_normalize": [Def("gengeofloat", ["gengeofloat"], template_scalar_args=True)],
                  # Relational functions
                  "isequal": [RelDef("samesizesignedint0", ["vgenfloat", "vgenfloat"], invoke_name="FOrdEqual"),
                              RelDef("bool", ["sgenfloat", "sgenfloat"], invoke_name="FOrdEqual"),

sycl/test/basic_tests/builtins_templates.cpp

@@ -24,6 +24,10 @@
   CHECK_INNER(NUM_ARGS, FUNC_NAME, sycl::vec<float, 4>)                        \
   CHECK_INNER(NUM_ARGS, FUNC_NAME, sycl::marray<float, 4>)
 
+#define FLOAT_CHECK(NUM_ARGS, FUNC_NAME)                                       \
+  CHECK_INNER(NUM_ARGS, FUNC_NAME, float)                                      \
+  NONSCALAR_FLOAT_CHECK(NUM_ARGS, FUNC_NAME)
+
 #define NONSCALAR_GENFLOAT_CHECK(NUM_ARGS, FUNC_NAME)                          \
   NONSCALAR_FLOAT_CHECK(NUM_ARGS, FUNC_NAME)                                   \
   CHECK_INNER(NUM_ARGS, FUNC_NAME, sycl::vec<sycl::half, 4>)                   \
@@ -224,9 +228,9 @@ void check() {
   GENFLOAT_CHECK(TWO_ARGS, distance)
   GENFLOAT_CHECK(ONE_ARG, length)
   GENFLOAT_CHECK(ONE_ARG, normalize)
-  GENFLOAT_CHECK(TWO_ARGS, fast_distance)
-  GENFLOAT_CHECK(ONE_ARG, fast_length)
-  GENFLOAT_CHECK(ONE_ARG, fast_normalize)
+  FLOAT_CHECK(TWO_ARGS, fast_distance)
+  FLOAT_CHECK(ONE_ARG, fast_length)
+  FLOAT_CHECK(ONE_ARG, fast_normalize)
 
   NONSCALAR_GENFLOAT_CHECK(TWO_ARGS, isequal)
   NONSCALAR_GENFLOAT_CHECK(TWO_ARGS, isnotequal)

sycl/test/warnings/sycl_2020_deprecations.cpp

@@ -448,5 +448,11 @@ int main() {
     size_t StreamMaxStatementSize = Stream.get_max_statement_size();
   });
 
+  // expected-warning@+1 {{'fast_distance<double, double>' is deprecated: fast_distance for double precision types is non-standard and has been deprecated}}
+  std::ignore = sycl::fast_distance(double{1.0}, double{2.0});
+  // expected-warning@+2 {{'fast_distance<sycl::vec<double, 2>, sycl::vec<double, 2>>' is deprecated: fast_distance for double precision types is non-standard and has been deprecated}}
+  std::ignore =
+      sycl::fast_distance(sycl::vec<double, 2>{0.0}, sycl::vec<double, 2>{1.0});
+
   return 0;
 }