# Experimental library header <experimental/simd>

From cppreference.com
< cpp‎ | header‎ | experimental

The header defines class templates, tag types, trait types, and function templates for element-wise operations on data-parallel objects.

### Synopsis

    namespace std::experimental {
    inline namespace parallelism_v2 {
    namespace simd_abi {
    using scalar = /* see below */;
    template <int N> using fixed_size = /* see below */;
    template <class T>
    inline constexpr int max_fixed_size = /* implementation-defined */;
    template <class T> using compatible = /* implementation-defined */;
    template <class T> using native = /* implementation-defined */;
    template <class T, size_t N, class... Abis> struct deduce {
      using type = /* see below */;
    };
    template <class T, size_t N, class... Abis>
    using deduce_t = typename deduce<T, N, Abis...>::type;
    } // namespace simd_abi
    struct element_aligned_tag {};
    struct vector_aligned_tag {};
    template <size_t> struct overaligned_tag {};
    inline constexpr element_aligned_tag element_aligned{};
    inline constexpr vector_aligned_tag vector_aligned{};
    template <size_t N> inline constexpr overaligned_tag<N> overaligned{};
    // 9.4, simd type traits
    template <class T> struct is_abi_tag;
    template <class T> inline constexpr bool is_abi_tag_v = is_abi_tag<T>::value;
    template <class T> struct is_simd;
    template <class T> inline constexpr bool is_simd_v = is_simd<T>::value;
    template <class T> struct is_simd_mask;
    template <class T>
    inline constexpr bool is_simd_mask_v = is_simd_mask<T>::value;
    template <class T> struct is_simd_flag_type;
    template <class T>
    inline constexpr bool is_simd_flag_type_v = is_simd_flag_type<T>::value;
    template <class T, class Abi = simd_abi::compatible<T>> struct simd_size;
    template <class T, class Abi = simd_abi::compatible<T>>
    inline constexpr size_t simd_size_v = simd_size<T, Abi>::value;
    template <class T, class U = typename T::value_type> struct memory_alignment;
    template <class T, class U = typename T::value_type>
    inline constexpr size_t memory_alignment_v = memory_alignment<T, U>::value;
    template <class T, class V> struct rebind_simd { using type = /* see below */; };
    template <class T, class V>
    using rebind_simd_t = typename rebind_simd<T, V>::type;
    template <int N, class V> struct resize_simd { using type = /* see below */; };
    template <int N, class V>
    using resize_simd_t = typename resize_simd<N, V>::type;
    // 9.6, Class template simd
    template <class T, class Abi = simd_abi::compatible<T>> class simd;
    template <class T> using native_simd = simd<T, simd_abi::native<T>>;
    template <class T, int N>
    using fixed_size_simd = simd<T, simd_abi::fixed_size<N>>;
    // 9.8, Class template simd_mask
    template <class T, class Abi = simd_abi::compatible<T>> class simd_mask;
    template <class T> using native_simd_mask = simd_mask<T, simd_abi::native<T>>;
    template <class T, int N>
    using fixed_size_simd_mask = simd_mask<T, simd_abi::fixed_size<N>>;
    // 9.7.5, Casts
    template <class T, class U, class Abi>
    /* see below */ simd_cast(const simd<U, Abi> &) noexcept;
    template <class T, class U, class Abi>
    /* see below */ static_simd_cast(const simd<U, Abi> &) noexcept;
    template <class T, class Abi>
    fixed_size_simd<T, simd_size_v<T, Abi>>
    to_fixed_size(const simd<T, Abi> &) noexcept;
    template <class T, class Abi>
    fixed_size_simd_mask<T, simd_size_v<T, Abi>>
    to_fixed_size(const simd_mask<T, Abi> &) noexcept;
    template <class T, int N>
    native_simd<T> to_native(const fixed_size_simd<T, N> &) noexcept;
    template <class T, int N>
    native_simd_mask<T> to_native(const fixed_size_simd_mask<T, N> &) noexcept;
    template <class T, int N>
    simd<T> to_compatible(const fixed_size_simd<T, N> &) noexcept;
    template <class T, int N>
    simd_mask<T> to_compatible(const fixed_size_simd_mask<T, N> &) noexcept;
    template <size_t... Sizes, class T, class Abi>
    tuple<simd<T, simd_abi::deduce_t<T, Sizes>>...>
    split(const simd<T, Abi> &) noexcept;
    template <size_t... Sizes, class T, class Abi>
    tuple<simd_mask<T, simd_mask_abi::deduce_t<T, Sizes>>...>
    split(const simd_mask<T, Abi> &) noexcept;
    template <class V, class Abi>
    array<V, simd_size_v<typename V::value_type, Abi> / V::size()>
    split(const simd<typename V::value_type, Abi> &) noexcept;
    template <class V, class Abi>
    array<V, simd_size_v<typename V::simd_type::value_type, Abi> / V::size()>
    split(const simd_mask<typename V::simd_type::value_type, Abi> &) noexcept;
    template <size_t N, class T, class A>
    array<resize_simd<simd_size_v<T, A> / N, simd<T, A>>, N>
    split_by(const simd<T, A> &x) noexcept;
    template <size_t N, class T, class A>
    array<resize_simd<simd_size_v<T, A> / N, simd_mask<T, A>>, N>
    split_by(const simd_mask<T, A> &x) noexcept;
    template <class T, class... Abis>
    simd<T, simd_abi::deduce_t<T, (simd_size_v<T, Abis> + ...)>>
    concat(const simd<T, Abis> &...) noexcept;
    template <class T, class... Abis>
    simd_mask<T, simd_abi::deduce_t<T, (simd_size_v<T, Abis> + ...)>>
    concat(const simd_mask<T, Abis> &...) noexcept;
    template <class T, class Abi, size_t N>
    resize_simd<simd_size_v<T, Abi> * N, simd<T, Abi>>
    concat(const array<simd<T, Abi>, N> &arr) noexcept;
    template <class T, class Abi, size_t N>
    resize_simd<simd_size_v<T, Abi> * N, simd_mask<T, Abi>>
    concat(const array<simd_mask<T, Abi>, N> &arr) noexcept;
    // 9.9.4, Reductions
    template <class T, class Abi> bool all_of(const simd_mask<T, Abi> &) noexcept;
    template <class T, class Abi> bool any_of(const simd_mask<T, Abi> &) noexcept;
    template <class T, class Abi> bool none_of(const simd_mask<T, Abi> &) noexcept;
    template <class T, class Abi> bool some_of(const simd_mask<T, Abi> &) noexcept;
    template <class T, class Abi> int popcount(const simd_mask<T, Abi> &) noexcept;
    template <class T, class Abi> int find_first_set(const simd_mask<T, Abi> &);
    template <class T, class Abi> int find_last_set(const simd_mask<T, Abi> &);
    bool all_of(T) noexcept;
    bool any_of(T) noexcept;
    bool none_of(T) noexcept;
    bool some_of(T) noexcept;
    int popcount(T) noexcept;
    int find_first_set(T);
    int find_last_set(T);
    // 9.5, Where expression class templates
    template <class M, class T> class const_where_expression;
    template <class M, class T> class where_expression;
    // 9.9.5, Where functions
    template <class T, class Abi>
    where_expression<simd_mask<T, Abi>, simd<T, Abi>>
    where(const typename simd<T, Abi>::mask_type &, simd<T, Abi> &) noexcept;
    template <class T, class Abi>
    const_where_expression<simd_mask<T, Abi>, simd<T, Abi>>
    where(const typename simd<T, Abi>::mask_type &, const simd<T, Abi> &) noexcept;
    template <class T, class Abi>
    where_expression<simd_mask<T, Abi>, simd_mask<T, Abi>>
    where(const type_identity_t<simd_mask<T, Abit>> &,
          simd_mask<T, Abi> &) noexcept;
    template <class T, class Abi>
    const_where_expression<simd_mask<T, Abi>, simd_mask<T, Abi>>
    where(const type_identity_t<simd_mask<T, Abit>> &,
          const simd_mask<T, Abi> &) noexcept;
    template <class T> where_expression<bool, T> where(/* see below */ k, T &d) noexcept;
    template <class T>
    const_where_expression<bool, T> where(/* see below */ k, const T &d) noexcept;
    // 9.7.4, Reductions
    template <class T, class Abi, class BinaryOperation = plus<>>
    T reduce(const simd<T, Abi> &, BinaryOperation = {});
    template <class M, class V, class BinaryOperation>
    typename V::value_type reduce(const const_where_expression<M, V> &x,
                                  typename V::value_type identity_element,
                                  BinaryOperation binary_op);
    template <class M, class V>
    typename V::value_type reduce(const const_where_expression<M, V> &x,
                                  plus<> binary_op = {}) noexcept;
    template <class M, class V>
    typename V::value_type reduce(const const_where_expression<M, V> &x,
                                  multiplies<> binary_op) noexcept;
    template <class M, class V>
    typename V::value_type reduce(const const_where_expression<M, V> &x,
                                  bit_and<> binary_op) noexcept;
    template <class M, class V>
    typename V::value_type reduce(const const_where_expression<M, V> &x,
                                  bit_or<> binary_op) noexcept;
    template <class M, class V>
    typename V::value_type reduce(const const_where_expression<M, V> &x,
                                  bit_xor<> binary_op) noexcept;
    template <class T, class Abi> T hmin(const simd<T, abi> &) noexcept;
    template <class M, class V>
    typename V::value_type hmin(const const_where_expression<M, V> &) noexcept;
    template <class T, class Abi> T hmax(const simd<T, abi> &) noexcept;
    template <class M, class V>
    typename V::value_type hmax(const const_where_expression<M, V> &) noexcept;
    // 9.7.6, Algorithms
    template <class T, class Abi>
    simd<T, Abi> min(const simd<T, Abi> &a, const simd<T, Abi> &b) noexcept;
    template <class T, class Abi>
    simd<T, Abi> max(const simd<T, Abi> &a, const simd<T, Abi> &b) noexcept;
    template <class T, class Abi>
    pair<simd<T, Abi>, simd<T, Abi>> minmax(const simd<T, Abi> &a,
                                            const simd<T, Abi> &b) noexcept;
    template <class T, class Abi>
    simd<T, Abi> clamp(const simd<T, Abi> &v, const simd<T, Abi> &lo,
                       const simd<T, Abi> &hi);
    } // namespace parallelism_v2
    } // namespace std::experimental

Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/header/experimental/simd&oldid=128493"