Intel xvec
Experimental C++ simd class library
Loading...
Searching...
No Matches
Implementation-specific interoperability

Convert between xvec objects and compiler-specific representations. More...

Typedefs

using xvec::simd::basic_mask< _Bytes, _Abi >::builtin_type = typename traits::builtin_type

Functions

constexpr xvec::simd::basic_mask< _Bytes, _Abi >::operator builtin_type ()
constexpr auto xvec::simd::basic_mask< _Bytes, _Abi >::to_builtin () const
 Return the builtin mask value directly.
static constexpr basic_mask xvec::simd::basic_mask< _Bytes, _Abi >::from_builtin (const builtin_type &m)
constexpr auto xvec::simd::basic_mask< _Bytes, _Abi >::to_register () const noexcept
 Convert the mask into a register which can be passed to an intrinsic.
constexpr xvec::simd::basic_vec< _Tp, _Abi >::basic_vec (const builtin_type &v) noexcept
constexpr xvec::simd::basic_vec< _Tp, _Abi >::basic_vec (register_type r) noexcept
constexpr xvec::simd::basic_vec< _Tp, _Abi >::operator typename traits::register_type () const
 Allow the vec to be turned into the closest matching target vec register type. This will return the smallest target register that can contain all the elements of the vec.
constexpr traits::register_type xvec::simd::basic_vec< _Tp, _Abi >::to_register () const
constexpr builtin_type xvec::simd::basic_vec< _Tp, _Abi >::to_builtin () const
 Return the builtin value.
static constexpr basic_vec xvec::simd::basic_vec< _Tp, _Abi >::from_builtin (const builtin_type &v) noexcept
 Construct a vector from its builtin representation.

Detailed Description

Convert between xvec objects and compiler-specific representations.

Typedef Documentation

◆ builtin_type

template<std::size_t _Bytes, typename _Abi>
using xvec::simd::basic_mask< _Bytes, _Abi >::builtin_type = typename traits::builtin_type

Compiler-specific storage representation of the mask.

Function Documentation

◆ basic_vec() [1/2]

template<typename _Tp, typename _Abi>
xvec::simd::basic_vec< _Tp, _Abi >::basic_vec ( const builtin_type & v)
inlineconstexprnoexcept

Allow a vec to be constructed from the compiler's own representation. The compiler may use multiple or partial target registers in its representation. This constructor allows a vec to be built from the output of an overloaded operator, a builtin, and so on.

◆ basic_vec() [2/2]

template<typename _Tp, typename _Abi>
xvec::simd::basic_vec< _Tp, _Abi >::basic_vec ( register_type r)
inlineexplicitconstexprnoexcept

Allow a vec to be constructed from a target register, such as the return value of an intrinsic. If the vec object is smaller than the register type then some values may be discarded, so the constructor is explicit to make the user be clear about this. Note that there is also a constructor which accepts a builtin type, so in the case where a register is directly convertible to a builtin, this would introduce ambiguity and so is disabled.

◆ from_builtin()

template<std::size_t _Bytes, typename _Abi>
constexpr basic_mask xvec::simd::basic_mask< _Bytes, _Abi >::from_builtin ( const builtin_type & m)
inlinestaticconstexpr

Construct a mask directly from its builtin representation. This named operation distinguishes representation conversion from construction using a public value type such as an unsigned integer.

Parameters
mThe builtin mask representation.

◆ operator builtin_type()

template<std::size_t _Bytes, typename _Abi>
xvec::simd::basic_mask< _Bytes, _Abi >::operator builtin_type ( )
inlineexplicitconstexpr

Return the underlying mask representation explicitly.

◆ to_register()

template<typename _Tp, typename _Abi>
traits::register_type xvec::simd::basic_vec< _Tp, _Abi >::to_register ( ) const
inlineconstexpr

Convert the mask into a register which can be passed to an intrinsic (e.g., on x86 vec<double, 3> would become __m256d). Vectors which don't fit into a native register must be broken into smaller pieces first.