Vc  1.3.0
SIMD Vector Classes for C++
vector.h
1 /* This file is part of the Vc library. {{{
2 Copyright © 2009-2015 Matthias Kretz <kretz@kde.org>
3 
4 Redistribution and use in source and binary forms, with or without
5 modification, are permitted provided that the following conditions are met:
6  * Redistributions of source code must retain the above copyright
7  notice, this list of conditions and the following disclaimer.
8  * Redistributions in binary form must reproduce the above copyright
9  notice, this list of conditions and the following disclaimer in the
10  documentation and/or other materials provided with the distribution.
11  * Neither the names of contributing organizations nor the
12  names of its contributors may be used to endorse or promote products
13  derived from this software without specific prior written permission.
14 
15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
19 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 }}}*/
27 
28 #ifndef VC_VECTOR_H_
29 #define VC_VECTOR_H_
30 
31 // 1. define all of Vc::Scalar - this one is always present, so it makes sense to put it first
32 #include "scalar/vector.h"
33 
34 #ifdef Vc_IMPL_AVX
35 # include "avx/vector.h"
36 #elif defined(Vc_IMPL_SSE)
37 # include "sse/vector.h"
38 #endif
39 
40 #if defined(Vc_IMPL_MIC)
41 # include "mic/vector.h"
42 #endif
43 
44 namespace Vc_VERSIONED_NAMESPACE
45 {
50 
54 using double_v = Vector<double>;
67 using llong_v = Vector<llong>;
69 using ullong_v = Vector<ullong>;
71 using long_v = Vector<long>;
73 using ulong_v = Vector<ulong>;
75 using schar_v = Vector<schar>;
77 using uchar_v = Vector<uchar>;
80 
85 
89 using double_m = Mask<double>;
94 using llong_m = Mask< llong>;
96 using ullong_m = Mask<ullong>;
98 using long_m = Mask< long>;
100 using ulong_m = Mask< ulong>;
110 using schar_m = Mask< schar>;
112 using uchar_m = Mask< uchar>;
115 
124 
133 
142 
151 
152 #if defined INT64_MAX && defined UINT64_MAX
153  typedef Vector<std:: int64_t> int64_v;
154  typedef Vector<std::uint64_t> uint64_v;
155  typedef Mask<std:: int64_t> int64_m;
156  typedef Mask<std::uint64_t> uint64_m;
157 #endif
158 #if defined INT32_MAX && defined UINT32_MAX
159  typedef Vector<std:: int32_t> int32_v;
160  typedef Vector<std::uint32_t> uint32_v;
161  typedef Mask<std:: int32_t> int32_m;
162  typedef Mask<std::uint32_t> uint32_m;
163 #endif
164 #if defined INT16_MAX && defined UINT16_MAX
165  typedef Vector<std:: int16_t> int16_v;
166  typedef Vector<std::uint16_t> uint16_v;
167  typedef Mask<std:: int16_t> int16_m;
168  typedef Mask<std::uint16_t> uint16_m;
169 #endif
170 #if defined INT8_MAX && defined UINT8_MAX
171  typedef Vector<std:: int8_t> int8_v;
172  typedef Vector<std::uint8_t> uint8_v;
173  typedef Mask<std:: int8_t> int8_m;
174  typedef Mask<std::uint8_t> uint8_m;
175 #endif
176 
177  namespace {
178  static_assert(double_v::Size == Vc_DOUBLE_V_SIZE, "Vc_DOUBLE_V_SIZE macro defined to an incorrect value");
179  static_assert(float_v::Size == Vc_FLOAT_V_SIZE , "Vc_FLOAT_V_SIZE macro defined to an incorrect value ");
180  static_assert(int_v::Size == Vc_INT_V_SIZE , "Vc_INT_V_SIZE macro defined to an incorrect value ");
181  static_assert(uint_v::Size == Vc_UINT_V_SIZE , "Vc_UINT_V_SIZE macro defined to an incorrect value ");
182  static_assert(short_v::Size == Vc_SHORT_V_SIZE , "Vc_SHORT_V_SIZE macro defined to an incorrect value ");
183  static_assert(ushort_v::Size == Vc_USHORT_V_SIZE, "Vc_USHORT_V_SIZE macro defined to an incorrect value");
184  }
185 }
186 
187 
188 // finally define the non-member operators
189 #include "common/operators.h"
190 
191 #include "common/simdarray.h"
192 // XXX See bottom of common/simdmaskarray.h:
193 //#include "common/simd_cast_caller.tcc"
194 
195 #include "common/alignedbase.h"
196 namespace Vc_VERSIONED_NAMESPACE {
207 constexpr std::size_t VectorAlignment = alignof(VectorAlignedBase);
218 constexpr std::size_t MemoryAlignment = alignof(MemoryAlignedBase);
219 } // namespace Vc_VERSIONED_NAMESPACE
220 
221 #define Vc_VECTOR_DECLARED_ 1
222 
223 #include "scalar/helperimpl.h"
224 #include "scalar/math.h"
225 #include "scalar/simd_cast_caller.tcc"
226 #if defined(Vc_IMPL_SSE)
227 # include "sse/helperimpl.h"
228 # include "sse/math.h"
229 # include "sse/simd_cast_caller.tcc"
230 #endif
231 #if defined(Vc_IMPL_AVX)
232 # include "avx/helperimpl.h"
233 # include "avx/math.h"
234 # include "avx/simd_cast_caller.tcc"
235 #endif
236 #if defined(Vc_IMPL_MIC)
237 # include "mic/helperimpl.h"
238 # include "mic/math.h"
239 # include "mic/simd_cast_caller.tcc"
240 #endif
241 
242 #include "common/math.h"
243 
244 #ifdef isfinite
245 #undef isfinite
246 #endif
247 #ifdef isnan
248 #undef isnan
249 #endif
250 
251 #include "common/vectortuple.h"
252 #include "common/algorithms.h"
253 #include "common/where.h"
254 #include "common/iif.h"
255 
256 #ifndef Vc_NO_STD_FUNCTIONS
257 namespace std
258 {
259  using Vc::min;
260  using Vc::max;
261 
262  using Vc::abs;
263  using Vc::asin;
264  using Vc::atan;
265  using Vc::atan2;
266  using Vc::ceil;
267  using Vc::cos;
268  using Vc::exp;
269  using Vc::fma;
270  using Vc::trunc;
271  using Vc::floor;
272  using Vc::frexp;
273  using Vc::ldexp;
274  using Vc::log;
275  using Vc::log10;
276  using Vc::log2;
277  using Vc::round;
278  using Vc::sin;
279  using Vc::sqrt;
280 
281  using Vc::isfinite;
282  using Vc::isnan;
283 } // namespace std
284 #endif
285 
286 #endif // VC_VECTOR_H_
SimdArray< T, N, V, M > ceil(const SimdArray< T, N, V, M > &x)
Applies the std:: ceil function component-wise and concurrently.
Definition: simdarray.h:1679
Vc::Vector< T > frexp(const Vc::Vector< T > &x, Vc::SimdArray< int, size()> *e)
Convert floating-point number to fractional and integral components.
Vc::Vector< T > log2(const Vc::Vector< T > &v)
Vc::Vector< T > exp(const Vc::Vector< T > &v)
SimdArray< T, N, V, M > floor(const SimdArray< T, N, V, M > &x)
Applies the std:: floor function component-wise and concurrently.
Definition: simdarray.h:1684
The main vector class for expressing data parallelism.
Definition: types.h:44
Vc::Vector< T > sin(const Vc::Vector< T > &v)
Vc::Vector< T > cos(const Vc::Vector< T > &v)
#define Vc_UINT_V_SIZE
An integer (for use with the preprocessor) that gives the number of entries in a uint_v.
Definition: dox.h:676
Vc::Vector< T > min(const Vc::Vector< T > &x, const Vc::Vector< T > &y)
Vc::Vector< T > ldexp(Vc::Vector< T > x, Vc::SimdArray< int, size()> e)
Multiply floating-point number by integral power of 2.
constexpr std::size_t VectorAlignment
Specifies the most conservative memory alignment necessary for Vector<T> objects with default VectorA...
Definition: vector.h:207
#define Vc_SHORT_V_SIZE
An integer (for use with the preprocessor) that gives the number of entries in a short_v.
Definition: dox.h:681
Vc::Vector< T > abs(const Vc::Vector< T > &v)
Returns the absolute value of v.
Vc::Vector< T > max(const Vc::Vector< T > &x, const Vc::Vector< T > &y)
Definition: vector.h:257
Vc::Vector< T > log(const Vc::Vector< T > &v)
AlignedBase< Detail::max(alignof(Vector< float >), alignof(Vector< double >), alignof(Vector< ullong >), alignof(Vector< llong >), alignof(Vector< ulong >), alignof(Vector< long >), alignof(Vector< uint >), alignof(Vector< int >), alignof(Vector< ushort >), alignof(Vector< short >), alignof(Vector< uchar >), alignof(Vector< schar >))> VectorAlignedBase
Helper type to ensure suitable alignment for any Vc::Vector<T> type (using the default VectorAbi)...
Definition: alignedbase.h:90
Vc::Vector< T > fma(Vc::Vector< T > a, Vc::Vector< T > b, Vc::Vector< T > c)
Multiplies a with b and then adds c, without rounding between the multiplication and the addition...
Vc::Vector< T > round(const Vc::Vector< T > &v)
Returns the closest integer to v; 0.5 is rounded to even.
#define Vc_USHORT_V_SIZE
An integer (for use with the preprocessor) that gives the number of entries in a ushort_v.
Definition: dox.h:686
Vc::Vector< T > log10(const Vc::Vector< T > &v)
Vector< double > double_v
vector of double precision
Definition: vector.h:55
#define Vc_DOUBLE_V_SIZE
An integer (for use with the preprocessor) that gives the number of entries in a double_v.
Definition: dox.h:661
SimdArray< T, N, V, M > trunc(const SimdArray< T, N, V, M > &x)
Applies the std:: trunc function component-wise and concurrently.
Definition: simdarray.h:1738
#define Vc_FLOAT_V_SIZE
An integer (for use with the preprocessor) that gives the number of entries in a float_v.
Definition: dox.h:666
Vc::Vector< T > atan2(const Vc::Vector< T > &y, const Vc::Vector< T > &x)
Calculates the angle given the lengths of the opposite and adjacent legs in a right triangle...
Vc::Vector< T > atan(const Vc::Vector< T > &v)
Vc::Vector< T > asin(const Vc::Vector< T > &v)
Vc::Mask< T > isfinite(const Vc::Vector< T > &x)
The main SIMD mask class.
Definition: mask.h:41
Vc::Mask< T > isnan(const Vc::Vector< T > &x)
#define Vc_INT_V_SIZE
An integer (for use with the preprocessor) that gives the number of entries in a int_v.
Definition: dox.h:671
constexpr std::size_t MemoryAlignment
Specifies the most conservative memory alignment necessary for aligned loads and stores of Vector typ...
Definition: vector.h:218
Vc::Vector< T > sqrt(const Vc::Vector< T > &v)
Returns the square root of v.
AlignedBase< Detail::max(Vector< float >::MemoryAlignment, Vector< double >::MemoryAlignment, Vector< ullong >::MemoryAlignment, Vector< llong >::MemoryAlignment, Vector< ulong >::MemoryAlignment, Vector< long >::MemoryAlignment, Vector< uint >::MemoryAlignment, Vector< int >::MemoryAlignment, Vector< ushort >::MemoryAlignment, Vector< short >::MemoryAlignment, Vector< uchar >::MemoryAlignment, Vector< schar >::MemoryAlignment)> MemoryAlignedBase
Helper class to ensure suitable alignment for arrays of scalar objects for any Vc::Vector<T> type (us...
Definition: alignedbase.h:122