Update documentation

pull/703/head
Jeffrey Walton 2018-08-09 08:16:46 -04:00
parent 3ed38e42f6
commit 1b5422eb49
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 16 additions and 0 deletions

View File

@ -325,6 +325,14 @@ inline T VectorRotateRight(const T& vec)
#endif
}
/// \brief Extract a dword from a vector
/// \tparam T vector type
/// \param val the vector
/// \returns vector created from low dword
/// \details VectorGetLow() extracts the low dword from a vector. The low dword
/// is composed of the least significant bits and occupies bytes 8 through 15
/// when viewed as a big endian array. The returned array is the same type as
/// the original vector and padded with 0's in the most significant bit positions.
template <class T>
inline T VectorGetLow(const T& val)
{
@ -333,6 +341,14 @@ inline T VectorGetLow(const T& val)
return (T)vec_perm(val, zero, mask);
}
/// \brief Extract a dword from a vector
/// \tparam T vector type
/// \param val the vector
/// \returns vector created from low dword
/// \details VectorGetHigh() extracts the high dword from a vector. The high dword
/// is composed of the most significant bits and occupies bytes 0 through 7
/// when viewed as a big endian array. The returned array is the same type as
/// the original vector and padded with 0's in the most significant bit positions.
template <class T>
inline T VectorGetHigh(const T& val)
{