Add batch_traits and some missing functions

- Add `batch_traits` that unifies traits for scalar, `batch`, and
  `batch_bool`.
- Treat `batch_bool` as its own mask type.
- `batch_cast` can now be used on `batch_bool` (because why not?)
- Add casts for scalar types
- Simplify `abs` implementation.

Author: kalenedrael

docs/source/api/type_traits.rst

@@ -32,9 +32,15 @@ Type Traits
 ===========
 
 `xsimd` provides a few type traits to interact with scalar and batch types in an
-uniformeous manner.
+uniform manner.
 
 
+Combined traits:
+
++---------------------------------------+----------------------------------------------------+
+| :cpp:class:`batch_traits`             | batch types and proprties                          |
++---------------------------------------+----------------------------------------------------+
+
 Type check:
 
 +---------------------------------------+----------------------------------------------------+

include/xsimd/arch/xsimd_scalar.hpp

@@ -83,53 +83,16 @@ namespace xsimd
     using std::tgamma;
     using std::trunc;
 
-    XSIMD_INLINE signed char abs(signed char v)
+    template <typename T>
+    XSIMD_INLINE constexpr typename std::enable_if<std::is_integral<T>::value && std::is_signed<T>::value, T>::type
+    abs(T v) noexcept
     {
         return v < 0 ? -v : v;
     }
 
-    namespace detail
-    {
-        // Use templated type here to prevent automatic instantiation that may
-        // ends up in a warning
-        template <typename char_type>
-        XSIMD_INLINE char abs(char_type v, std::true_type)
-        {
-            return v;
-        }
-        template <typename char_type>
-        XSIMD_INLINE char abs(char_type v, std::false_type)
-        {
-            return v < 0 ? -v : v;
-        }
-    }
-
-    XSIMD_INLINE char abs(char v)
-    {
-        return detail::abs(v, std::is_unsigned<char>::type {});
-    }
-
-    XSIMD_INLINE short abs(short v)
-    {
-        return v < 0 ? -v : v;
-    }
-    XSIMD_INLINE unsigned char abs(unsigned char v)
-    {
-        return v;
-    }
-    XSIMD_INLINE unsigned short abs(unsigned short v)
-    {
-        return v;
-    }
-    XSIMD_INLINE unsigned int abs(unsigned int v)
-    {
-        return v;
-    }
-    XSIMD_INLINE unsigned long abs(unsigned long v)
-    {
-        return v;
-    }
-    XSIMD_INLINE unsigned long long abs(unsigned long long v)
+    template <typename T>
+    XSIMD_INLINE constexpr typename std::enable_if<std::is_integral<T>::value && std::is_unsigned<T>::value, T>::type
+    abs(T v) noexcept
     {
         return v;
     }
@@ -251,7 +214,7 @@ namespace xsimd
     }
 
     template <class T>
-    XSIMD_INLINE typename std::enable_if<std::is_integral<T>::value, T>::type
+    XSIMD_INLINE constexpr typename std::enable_if<std::is_integral<T>::value, T>::type
     bitwise_and(T x, T y) noexcept
     {
         return x & y;
@@ -1235,6 +1198,19 @@ namespace xsimd
     {
         return cond ? true_br : false_br;
     }
+
+    template <class T>
+    XSIMD_INLINE constexpr bool batch_bool_cast(bool b) noexcept
+    {
+        return b;
+    }
+
+    template <class T_out, class T_in>
+    XSIMD_INLINE constexpr T_out batch_cast(T_in const& val) noexcept
+    {
+        static_assert(std::is_same<T_in, bool>::value ^ std::is_same<T_in, bool>::value, "cannot convert to/from bool; use !x or x != 0");
+        return static_cast<T_out>(val);
+    }
 }
 
 #endif

include/xsimd/types/xsimd_api.hpp

@@ -264,6 +264,19 @@ namespace xsimd
         return kernel::batch_cast<A>(x, batch<T_out, A> {}, A {});
     }
 
+    /**
+     * @ingroup batch_conversion
+     *
+     * Perform a static_cast from \c T_in to \c T_out on \c x.
+     * @param x batch of \c T_in
+     * @return \c x cast to \c T_out
+     */
+    template <class T_out, class T_in, class A>
+    XSIMD_INLINE batch_bool<T_out, A> batch_cast(batch_bool<T_in, A> const& x) noexcept
+    {
+        return batch_bool_cast<T_out>(x);
+    }
+
     /**
      * @ingroup batch_miscellaneous
      *

include/xsimd/types/xsimd_traits.hpp

@@ -233,59 +233,133 @@ namespace xsimd
     /**
      * @ingroup batch_traits
      *
-     * type traits that inherits from @c std::true_type for @c batch<...> types and from
-     * @c std::false_type otherwise.
+     * type traits that provide information about a batch or scalar type.
      *
      * @tparam T type to analyze.
      */
+
     template <class T>
-    struct is_batch;
+    struct batch_traits
+    {
+        using scalar_type = T; ///< T if scalar, or type of the scalar element for the batch T.
+        using mask_type = bool; ///< Mask type for T: bool for scalars, or batch_bool for batch types.
 
+        static constexpr bool is_batch = false; ///< True if T is @c batch<...>.
+        static constexpr bool is_batch_bool = false; ///< True if T is @c batch_bool<...>.
+        static constexpr bool is_any_batch = false; ///< True if T is @c batch<...> or @c batch_bool<...>.
+        static constexpr bool is_complex = detail::is_complex<T>::value; ///< True if T is complex or a batch of complex values.
+    };
+
+#if __cplusplus < 201703L
+    template <class T>
+    constexpr bool batch_traits<T>::is_batch;
     template <class T>
-    struct is_batch : std::false_type
+    constexpr bool batch_traits<T>::is_batch_bool;
+    template <class T>
+    constexpr bool batch_traits<T>::is_any_batch;
+    template <class T>
+    constexpr bool batch_traits<T>::is_complex;
+#endif
+
+    template <class T, class A>
+    struct batch_traits<batch<T, A>>
     {
+        using scalar_type = T;
+        using mask_type = typename batch<T, A>::batch_bool_type;
+
+        static constexpr bool is_batch = true;
+        static constexpr bool is_batch_bool = false;
+        static constexpr bool is_any_batch = true;
+        static constexpr bool is_complex = detail::is_complex<T>::value;
     };
 
+#if __cplusplus < 201703L
+    template <class T, class A>
+    constexpr bool batch_traits<batch<T, A>>::is_batch;
+    template <class T, class A>
+    constexpr bool batch_traits<batch<T, A>>::is_batch_bool;
+    template <class T, class A>
+    constexpr bool batch_traits<batch<T, A>>::is_any_batch;
+    template <class T, class A>
+    constexpr bool batch_traits<batch<T, A>>::is_complex;
+#endif
+
     template <class T, class A>
-    struct is_batch<batch<T, A>> : std::true_type
+    struct batch_traits<batch_bool<T, A>>
     {
+        using scalar_type = bool;
+        using mask_type = batch_bool<T, A>;
+
+        static constexpr bool is_batch = false;
+        static constexpr bool is_batch_bool = true;
+        static constexpr bool is_any_batch = true;
+        static constexpr bool is_complex = false;
     };
 
+#if __cplusplus < 201703L
+    template <class T, class A>
+    constexpr bool batch_traits<batch_bool<T, A>>::is_batch;
+    template <class T, class A>
+    constexpr bool batch_traits<batch_bool<T, A>>::is_batch_bool;
+    template <class T, class A>
+    constexpr bool batch_traits<batch_bool<T, A>>::is_any_batch;
+    template <class T, class A>
+    constexpr bool batch_traits<batch_bool<T, A>>::is_complex;
+#endif
+
     /**
      * @ingroup batch_traits
      *
-     * type traits that inherits from @c std::true_type for @c batch_bool<...> types and from
+     * type traits that inherits from @c std::true_type for @c batch<...> types and from
      * @c std::false_type otherwise.
      *
      * @tparam T type to analyze.
      */
 
     template <class T>
-    struct is_batch_bool : std::false_type
+    struct is_batch : std::integral_constant<bool, batch_traits<T>::is_batch>
     {
     };
 
-    template <class T, class A>
-    struct is_batch_bool<batch_bool<T, A>> : std::true_type
+    /**
+     * @ingroup batch_traits
+     *
+     * type traits that inherits from @c std::true_type for @c batch_bool<...> types and from
+     * @c std::false_type otherwise.
+     *
+     * @tparam T type to analyze.
+     */
+
+    template <class T>
+    struct is_batch_bool : std::integral_constant<bool, batch_traits<T>::is_batch_bool>
     {
     };
 
     /**
      * @ingroup batch_traits
      *
-     * type traits that inherits from @c std::true_type for @c batch<std::complex<...>>
+     * type traits that inherits from @c std::true_type for @c batch<...> or batch_bool<...>
      * types and from @c std::false_type otherwise.
      *
      * @tparam T type to analyze.
      */
 
     template <class T>
-    struct is_batch_complex : std::false_type
+    struct is_any_batch : std::integral_constant<bool, batch_traits<T>::is_any_batch>
     {
     };
 
-    template <class T, class A>
-    struct is_batch_complex<batch<std::complex<T>, A>> : std::true_type
+    /**
+     * @ingroup batch_traits
+     *
+     * type traits that inherits from @c std::true_type for @c batch<std::complex<...>>
+     * types and from @c std::false_type otherwise.
+     *
+     * @tparam T type to analyze.
+     */
+
+    template <class T>
+    struct is_batch_complex : std::integral_constant<bool, batch_traits<T>::is_batch && batch_traits<T>::is_complex>
     {
     };
 
@@ -300,12 +374,7 @@ namespace xsimd
     template <class T>
     struct scalar_type
     {
-        using type = T;
-    };
-    template <class T, class A>
-    struct scalar_type<batch<T, A>>
-    {
-        using type = T;
+        using type = typename batch_traits<T>::scalar_type;
     };
 
     template <class T>
@@ -322,12 +391,7 @@ namespace xsimd
     template <class T>
     struct mask_type
     {
-        using type = bool;
-    };
-    template <class T, class A>
-    struct mask_type<batch<T, A>>
-    {
-        using type = typename batch<T, A>::batch_bool_type;
+        using type = typename batch_traits<T>::mask_type;
     };
 
     template <class T>
@@ -364,7 +428,6 @@ namespace xsimd
     }
     template <typename T>
     using widen_t = typename detail::widen<T>::type;
-
 }
 
 #endif