VecCore 0.8.1
C++ Library for Portable SIMD Vectorization
Loading...
Searching...
No Matches
Interface.h
Go to the documentation of this file.
1#ifndef VECCORE_BACKEND_INTERFACE_H
2#define VECCORE_BACKEND_INTERFACE_H
3
4namespace vecCore {
5
6template <typename T>
7struct TypeTraits;
8
9template <typename T>
10using Mask = typename TypeTraits<T>::MaskType;
11
12template <typename T>
13using Index = typename TypeTraits<T>::IndexType;
14
15template <typename T>
16using Scalar = typename TypeTraits<T>::ScalarType;
17
18// Iterators
19
20template <typename T>
21VECCORE_FORCE_INLINE
22VECCORE_ATT_HOST_DEVICE
23Scalar<T> *Begin(T &v);
24
25template <typename T>
26VECCORE_FORCE_INLINE
27VECCORE_ATT_HOST_DEVICE
28Scalar<T> *End(T &v);
29
30template <typename T>
31VECCORE_FORCE_INLINE
32VECCORE_ATT_HOST_DEVICE
33Scalar<T> const *Begin(T const &v);
34
35template <typename T>
36VECCORE_FORCE_INLINE
37VECCORE_ATT_HOST_DEVICE
38Scalar<T> const *End(T const &v);
39
40// Vector Size
41
42template <typename T>
43VECCORE_FORCE_INLINE
44VECCORE_ATT_HOST_DEVICE
45constexpr size_t VectorSize();
46
47// Get/Set
48
49template <typename T>
50VECCORE_FORCE_INLINE
51VECCORE_ATT_HOST_DEVICE
52Scalar<T> Get(const T &v, size_t i);
53
54template <typename T>
55VECCORE_FORCE_INLINE
56VECCORE_ATT_HOST_DEVICE
57void Set(T &v, size_t i, Scalar<T> const val);
58
59// Load/Store
60
61template <typename T>
62VECCORE_FORCE_INLINE
63VECCORE_ATT_HOST_DEVICE
64void Load(T &v, Scalar<T> const *ptr);
65
66template <typename T>
67VECCORE_FORCE_INLINE
68VECCORE_ATT_HOST_DEVICE
69void Store(T const &v, Scalar<T> *ptr);
70
71// Gather/Scatter
72
73template <typename T, typename S = Scalar<T>>
74VECCORE_FORCE_INLINE
75VECCORE_ATT_HOST_DEVICE
76T Gather(S const *ptr, Index<T> const &idx);
77
78template <typename T, typename S = Scalar<T>>
79VECCORE_FORCE_INLINE
80VECCORE_ATT_HOST_DEVICE
81void Scatter(T const &v, S *ptr, Index<T> const &idx);
82
83// Masking/Blending
84
85template <typename M>
86VECCORE_FORCE_INLINE
87VECCORE_ATT_HOST_DEVICE
88bool MaskFull(M const &mask);
89
90template <typename M>
91VECCORE_FORCE_INLINE
92VECCORE_ATT_HOST_DEVICE
93bool MaskEmpty(M const &mask);
94
95template <typename T>
96VECCORE_FORCE_INLINE
97VECCORE_ATT_HOST_DEVICE
98void MaskedAssign(T &dst, const Mask<T> &mask, const T &src);
99
100template <typename T>
101VECCORE_FORCE_INLINE
102VECCORE_ATT_HOST_DEVICE
103T Blend(const Mask<T> &mask, const T &src1, const T &src2);
104
105VECCORE_FORCE_INLINE
106VECCORE_ATT_HOST_DEVICE
107constexpr bool EarlyReturnAllowed();
108
109template <typename T>
110VECCORE_FORCE_INLINE
111VECCORE_ATT_HOST_DEVICE
112constexpr bool EarlyReturnMaxLength(T &, size_t);
113
114// Reduction
115
116template <typename T>
117VECCORE_FORCE_INLINE
118VECCORE_ATT_HOST_DEVICE
119Scalar<T> ReduceAdd(const T& v);
120
121template <typename T>
122VECCORE_FORCE_INLINE
123VECCORE_ATT_HOST_DEVICE
124Scalar<T> ReduceMin(const T& v);
125
126template <typename T>
127VECCORE_FORCE_INLINE
128VECCORE_ATT_HOST_DEVICE
129Scalar<T> ReduceMax(const T& v);
130
131} // namespace vecCore
132
133#endif
VECCORE_ATT_HOST_DEVICE
#define VECCORE_ATT_HOST_DEVICE
Definition: CUDA.h:10
VECCORE_FORCE_INLINE
#define VECCORE_FORCE_INLINE
Definition: Common.h:32
vecCore::MaskEmpty
VECCORE_ATT_HOST_DEVICE bool MaskEmpty(const M &mask)
Definition: Implementation.h:222
vecCore::MaskedAssign
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE void MaskedAssign(T &dst, const Mask< T > &mask, const T &src)
Definition: Implementation.h:284
vecCore::Get
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE Scalar< T > Get(const T &v, size_t i)
Definition: Implementation.h:106
vecCore::Scalar
typename TypeTraits< T >::ScalarType Scalar
Definition: Interface.h:16
vecCore::Mask
typename TypeTraits< T >::MaskType Mask
Definition: Interface.h:10
vecCore::Blend
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE T Blend(const Mask< T > &mask, const T &src1, const T &src2)
Definition: Implementation.h:292
vecCore::Set
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE void Set(T &v, size_t i, Scalar< T > const val)
Definition: Implementation.h:114
vecCore::ReduceMax
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE Scalar< T > ReduceMax(const T &v)
Definition: Implementation.h:345
vecCore::Scatter
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE void Scatter(T const &v, S *ptr, Index< T > const &idx)
Definition: Implementation.h:204
vecCore::MaskFull
VECCORE_ATT_HOST_DEVICE bool MaskFull(const M &mask)
Definition: Implementation.h:213
vecCore::VectorSize
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE constexpr size_t VectorSize()
Definition: Implementation.h:15
vecCore::End
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE Scalar< T > * End(T &v)
Definition: Implementation.h:70
vecCore::Load
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE void Load(T &v, Scalar< T > const *ptr)
Definition: Implementation.h:145
vecCore::EarlyReturnAllowed
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE constexpr bool EarlyReturnAllowed()
Definition: Implementation.h:301
vecCore::Begin
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE Scalar< T > * Begin(T &v)
Definition: Implementation.h:62
vecCore::Index
typename TypeTraits< T >::IndexType Index
Definition: Interface.h:13
vecCore::Gather
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE T Gather(S const *ptr, Index< T > const &idx)
Definition: Implementation.h:194
vecCore::EarlyReturnMaxLength
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE constexpr bool EarlyReturnMaxLength(T &, size_t n)
Definition: Implementation.h:312
vecCore::ReduceMin
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE Scalar< T > ReduceMin(const T &v)
Definition: Implementation.h:333
vecCore::Store
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE void Store(T const &v, Scalar< T > *ptr)
Definition: Implementation.h:163
vecCore::ReduceAdd
VECCORE_FORCE_INLINE VECCORE_ATT_HOST_DEVICE Scalar< T > ReduceAdd(const T &v)
Definition: Implementation.h:322
vecCore::TypeTraits::IndexType
size_t IndexType
Definition: Scalar.h:13