Skip to content

Commit b7bc4dc

Browse files
committed
Add more comments to the new constructors
Signed-off-by: Vyacheslav N Klochkov <vyacheslav.n.klochkov@intel.com>
1 parent 71b6db0 commit b7bc4dc

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

sycl/include/sycl/ext/intel/experimental/esimd/detail/simd_obj_impl.hpp

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,14 @@ template <typename Ty, int N, class Derived, class SFINAE> class simd_obj_impl {
137137
init_from_array(std::move(Arr));
138138
}
139139

140-
/// Construct from simd_view object.
140+
/// Construct from \ref simd_view object \p View.
141+
/// The constructed object has the same element type as the viewed simd.
142+
/// and the size that is specified by the RegionT parameter of \p View.
143+
///
144+
/// \tparam ViewedSimdLength is the size in elements of the \ref simd
145+
/// object being viewed by \p View.
146+
/// \tparam RegionT is the region defining \p View.
147+
/// \param View is the object from which the \ref simd is created.
141148
template <int ViewedSimdLength, typename RegionT,
142149
typename = std::enable_if_t<RegionT::length == N>>
143150
simd_obj_impl(simd_view<simd<Ty, ViewedSimdLength>, RegionT> &View)

sycl/include/sycl/ext/intel/experimental/esimd/simd.hpp

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,14 @@ class simd
6767
__esimd_dbg_print(simd(T1 Val));
6868
}
6969

70-
/// Construct from simd_view.
70+
/// Construct \ref simd from \ref simd_view object \p View.
71+
/// The constructed \ref simd object has the same element type as the viewed
72+
/// simd and the size that is specified by the RegionT parameter of \p View.
73+
///
74+
/// \tparam ViewedSimdLength is the size in elements of the \ref simd
75+
/// object being viewed by \p View.
76+
/// \tparam RegionT is the region defining the \p View.
77+
/// \param View is the object from which the \ref simd is created.
7178
template <int ViewedSimdLength, typename RegionT,
7279
typename = std::enable_if_t<RegionT::length == N>>
7380
simd(simd_view<simd<element_type, ViewedSimdLength>, RegionT> &View)

0 commit comments

Comments
 (0)