Data-parallel arithmetic type with user-defined number of elements.
T | The type of the vector's elements. The supported types currently are limited to the types supported by Vc::Vector<T>. |
N | The number of elements to store and process concurrently. You can choose an arbitrary number, though not every number is a good idea. Generally, a power of two value or the sum of two power of two values might work efficiently, though this depends a lot on the target system. |
V | Don't change the default value unless you really know what you are doing. This type is set to the underlying native Vc::Vector type used in the implementation of the type. Having it as part of the type name guards against some cases of ODR violations (i.e. linking incompatible translation units / libraries). |
Wt | Don't ever change the default value. This parameter is an unfortunate implementation detail shining through. |
N
too large (what “too large” means depends on the target) will result in excessive compilation times and high (or too high) register pressure, thus potentially negating the improvement from concurrent execution. As a rule of thumb, keep N
less or equal to 2 * float_v::size()
.T
=
(u)short require an N
either less than short_v::size() or a multiple of short_v::size(). Definition at line 616 of file simdarray.h.
#include <Vc/SimdArray>
Public Types | |
using | value_type = T |
The type of the elements (i.e. T ) | |
using | mask_type = fixed_size_simd_mask<T, N> |
The type of the mask used for masked operations and returned from comparisons. | |
using | index_type = fixed_size_simd<int, N> |
The type of the vector used for indexes in gather and scatter operations. | |
using | Mask = mask_type |
The type of the mask used for masked operations and returned from comparisons. | |
using | MaskType = Mask |
The type of the mask used for masked operations and returned from comparisons. | |
using | EntryType = value_type |
The type of the elements (i.e. T ) | |
using | IndexType = index_type |
The type of the vector used for indexes in gather and scatter operations. | |
Public Member Functions | |||||||
fixed_size_simd< T, N > | operator+ () const | ||||||
Returns a copy of itself. | |||||||
Common::WriteMaskedVector< SimdArray, mask_type > | operator() (const mask_type &mask) | ||||||
value_type | min () const | ||||||
Returns the smallest entry in the vector. | |||||||
value_type | min (const mask_type &mask) const | ||||||
Returns the smallest entry in the vector. | |||||||
value_type | max () const | ||||||
Returns the largest entry in the vector. | |||||||
value_type | max (const mask_type &mask) const | ||||||
Returns the largest entry in the vector. | |||||||
value_type | product () const | ||||||
Returns the product of all entries in the vector. | |||||||
value_type | product (const mask_type &mask) const | ||||||
Returns the product of all entries in the vector. | |||||||
value_type | sum () const | ||||||
Returns the sum of all entries in the vector. | |||||||
value_type | sum (const mask_type &mask) const | ||||||
Returns the sum of all entries in the vector. | |||||||
fixed_size_simd< T, N > | partialSum () const | ||||||
Returns a vector containing the sum of all entries with smaller index. | |||||||
template<typename F> | |||||||
fixed_size_simd< T, N > | apply (F &&f) const | ||||||
Call f on every entry of the vector and return the results as a new vector. | |||||||
template<typename F> | |||||||
fixed_size_simd< T, N > | apply (F &&f, const mask_type &k) const | ||||||
fixed_size_simd< T, N > | shifted (int amount) const | ||||||
Shift vector entries to the left by amount ; shifting in zeros. | |||||||
fixed_size_simd< T, N > | rotated (int amount) const | ||||||
Rotate vector entries to the left by amount . | |||||||
fixed_size_simd< T, N > | reversed () const | ||||||
Returns a vector with all components reversed. | |||||||
fixed_size_simd< T, N > | sorted () const | ||||||
Return a sorted copy of the vector. | |||||||
Compile-Time Constant Initialization | |||||||
SimdArray ()=default | |||||||
Construct a zero-initialized vector object. | |||||||
Conversion/Broadcast Constructors | |||||||
SimdArray (value_type a) | |||||||
Gather constructors and member functions | |||||||
Constructs or loads a vector from the objects at All gather functions optionally take a mask as last argument. In that case only the entries that are selected in the mask are accessed in memory and copied to the vector. This enables invalid indexes in the Gathers from structured data (AoS: arrays of struct) are possible via a special subscript operator of the container (array). You can use array and vector as drop-in replacements for Vc::vector<float> data(100);
std::iota(data.begin(), data.end(), 0.f); // fill with values 0, 1, 2, ...
auto indexes = float_v::IndexType::IndexesFromZero();
float_v gathered = data[indexes]; // gathered == [0, 1, 2, ...]
static Vector IndexesFromZero() Common::AdaptSubscriptOperator< std::vector< T, Allocator > > vector An adapted std::vector container with an additional subscript operator which implements gather and sc... Definition vector:55 This also works for gathers into arrays of structures: struct Point { float x, y, z; };
Vc::array<Point, 100> points;
// fill points ...
auto indexes = float_v::IndexType::IndexesFromZero();
float_v xs = data[indexes][&Point::x]; // [points[0].x, points[1].x, points[2].x, ...]
float_v ys = data[indexes][&Point::y]; // [points[0].y, points[1].y, points[2].y, ...]
float_v zs = data[indexes][&Point::z]; // [points[0].z, points[1].z, points[2].z, ...]
This is std::array with additional subscript operators supporting gather and scatter operations. Definition types.h:188 Alternatively, you can use Vc::Common::AdaptSubscriptOperator to extend a given container class with the necessary subscript operator. Example: template <typename T, typename Allocator = std::allocator<T>>
using my_vector = Vc::Common::AdaptSubscriptOperator<std::vector<T, Allocator>>;
| |||||||
template<typename MT, typename IT, typename = enable_if<Traits::has_subscript_operator<IT>::value>> | |||||||
SimdArray (const MT *mem, const IT &indexes) | |||||||
Gather constructor. | |||||||
template<typename MT, typename IT, typename = enable_if<Vc::Traits::has_subscript_operator<IT>::value>> | |||||||
SimdArray (const MT *mem, const IT &indexes, MaskArgument mask) | |||||||
Masked gather constructor. | |||||||
template<typename MT, typename IT, typename = enable_if<Vc::Traits::has_subscript_operator<IT>::value>> | |||||||
void | gather (const MT *mem, const IT &indexes) | ||||||
Gather function. | |||||||
template<typename MT, typename IT, typename = enable_if<Vc::Traits::has_subscript_operator<IT>::value>> | |||||||
void | gather (const MT *mem, const IT &indexes, MaskArgument mask) | ||||||
Masked gather function. | |||||||
Scatter functions | |||||||
Stores a vector to the objects at
| |||||||
template<typename MT, typename IT, typename = enable_if<Vc::Traits::has_subscript_operator<IT>::value>> | |||||||
void | scatter (MT *mem, IT &&indexes) const | ||||||
Scatter function. | |||||||
template<typename MT, typename IT, typename = enable_if<Vc::Traits::has_subscript_operator<IT>::value>> | |||||||
void | scatter (MT *mem, IT &&indexes, MaskArgument mask) const | ||||||
Masked scatter function. | |||||||
new/delete overloads for correct alignment | |||||||
void * | operator new (size_t size) | ||||||
Allocates correctly aligned memory. | |||||||
void * | operator new (size_t, void *p) | ||||||
Returns p . | |||||||
void * | operator new[] (size_t size) | ||||||
Allocates correctly aligned memory. | |||||||
void * | operator new[] (size_t, void *p) | ||||||
Returns p . | |||||||
void | operator delete (void *ptr, size_t) | ||||||
Frees aligned memory. | |||||||
void | operator delete (void *, void *) | ||||||
Does nothing. | |||||||
void | operator delete[] (void *ptr, size_t) | ||||||
Frees aligned memory. | |||||||
void | operator delete[] (void *, void *) | ||||||
Does nothing. | |||||||
Static Public Member Functions | |
static constexpr std::size_t | size () |
Returns N , the number of scalar components in an object of this type. | |
Static Public Attributes | |
static constexpr std::size_t | MemoryAlignment |
Specifies the alignment requirement for aligned load and store calls for objects of this vector type. | |
Deprecated Members | |
static constexpr std::size_t | Size = size() |
Returns N , the number of scalar components in an object of this type. | |
template<typename S1, typename IT> | |
SimdArray (const S1 *array, const EntryType S1::*member1, IT indexes) | |
template<typename S1, typename IT> | |
SimdArray (const S1 *array, const EntryType S1::*member1, IT indexes, MaskArgument mask) | |
template<typename S1, typename S2, typename IT> | |
SimdArray (const S1 *array, const S2 S1::*member1, const EntryType S2::*member2, IT indexes) | |
template<typename S1, typename S2, typename IT> | |
SimdArray (const S1 *array, const S2 S1::*member1, const EntryType S2::*member2, IT indexes, MaskArgument mask) | |
template<typename S1, typename IT1, typename IT2> | |
SimdArray (const S1 *array, const EntryType *const S1::*ptrMember1, IT1 outerIndexes, IT2 innerIndexes) | |
template<typename S1, typename IT1, typename IT2> | |
SimdArray (const S1 *array, const EntryType *const S1::*ptrMember1, IT1 outerIndexes, IT2 innerIndexes, MaskArgument mask) | |
template<typename S1, typename IT> | |
void | gather (const S1 *array, const EntryType S1::*member1, IT indexes) |
template<typename S1, typename IT> | |
void | gather (const S1 *array, const EntryType S1::*member1, IT indexes, MaskArgument mask) |
template<typename S1, typename S2, typename IT> | |
void | gather (const S1 *array, const S2 S1::*member1, const EntryType S2::*member2, IT indexes) |
template<typename S1, typename S2, typename IT> | |
void | gather (const S1 *array, const S2 S1::*member1, const EntryType S2::*member2, IT indexes, MaskArgument mask) |
template<typename S1, typename IT1, typename IT2> | |
void | gather (const S1 *array, const EntryType *const S1::*ptrMember1, IT1 outerIndexes, IT2 innerIndexes) |
template<typename S1, typename IT1, typename IT2> | |
void | gather (const S1 *array, const EntryType *const S1::*ptrMember1, IT1 outerIndexes, IT2 innerIndexes, MaskArgument mask) |
template<typename S1, typename IT> | |
void | scatter (S1 *array, EntryType S1::*member1, IT indexes) const |
template<typename S1, typename IT> | |
void | scatter (S1 *array, EntryType S1::*member1, IT indexes, MaskArgument mask) const |
template<typename S1, typename S2, typename IT> | |
void | scatter (S1 *array, S2 S1::*member1, EntryType S2::*member2, IT indexes) const |
template<typename S1, typename S2, typename IT> | |
void | scatter (S1 *array, S2 S1::*member1, EntryType S2::*member2, IT indexes, MaskArgument mask) const |
template<typename S1, typename IT1, typename IT2> | |
void | scatter (S1 *array, EntryType *S1::*ptrMember1, IT1 outerIndexes, IT2 innerIndexes) const |
template<typename S1, typename IT1, typename IT2> | |
void | scatter (S1 *array, EntryType *S1::*ptrMember1, IT1 outerIndexes, IT2 innerIndexes, MaskArgument mask) const |
fixed_size_simd< T, N > | exponent () const |
Returns the exponents of the floating-point values in the vector. | |
MaskType | isNegative () const |
Returns whether a value is negative. | |
fixed_size_simd< T, N > | copySign (const SimdArray &x) const |
Copies the signs of the components of reference to the components of the current vector, returning the result. | |
Scalar Subscript Operators | |
reference | operator[] (size_t i) noexcept |
This operator can be used to modify scalar entries of the vector. | |
value_type | operator[] (size_t index) const noexcept |
This operator can be used to read scalar entries of the vector. | |
Generators | |
static fixed_size_simd< T, N > | Zero () |
Returns a vector with the entries initialized to zero. | |
static fixed_size_simd< T, N > | One () |
Returns a vector with the entries initialized to one. | |
static fixed_size_simd< T, N > | IndexesFromZero () |
Returns a vector with the entries initialized to 0, 1, 2, 3, 4, 5, ... | |
static fixed_size_simd< T, N > | Random () |
Returns a vector with pseudo-random entries. | |
template<typename G> | |
static fixed_size_simd< T, N > | generate (const G &gen) |
Generate a vector object from return values of gen (static variant of fill). | |
The type of the mask used for masked operations and returned from comparisons.
Definition at line 678 of file simdarray.h.
The type of the mask used for masked operations and returned from comparisons.
Definition at line 680 of file simdarray.h.
using EntryType = value_type |
The type of the elements (i.e. T
)
Definition at line 684 of file simdarray.h.
using IndexType = index_type |
The type of the vector used for indexes in gather and scatter operations.
Definition at line 686 of file simdarray.h.
|
default |
Construct a zero-initialized vector object.
This constructor follows the behavior of the underlying arithmetic type T
in that the expression T()
zero-initializes the object. On the other hand the variable x
in T x;
is uninitialized. Since, for class types, both expressions call the default constructor Vector<T> x
must zero-initialize x
as well.
|
inline |
Definition at line 755 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
Definition at line 19 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
mask | If a mask is given only the active entries will be gathered/scattered. |
Definition at line 43 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
member2 | If member1 is a struct then member2 selects the member to be read from that struct (i.e. array[i].*member1.*member2 is read). |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
Definition at line 69 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
member2 | If member1 is a struct then member2 selects the member to be read from that struct (i.e. array[i].*member1.*member2 is read). |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
mask | If a mask is given only the active entries will be gathered/scattered. |
Definition at line 96 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
ptrMember1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
outerIndexes | |
innerIndexes |
Definition at line 121 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
ptrMember1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
outerIndexes | |
innerIndexes | |
mask | If a mask is given only the active entries will be gathered/scattered. |
Definition at line 145 of file simdarray.h.
|
inlinestaticconstexpr |
Returns N
, the number of scalar components in an object of this type.
The size of the SimdArray, i.e. the number of scalar elements in the vector. In contrast to Vector::size() you have control over this value via the N
template parameter of the SimdArray class template.
Definition at line 675 of file simdarray.h.
|
inlinestatic |
Returns a vector with pseudo-random entries.
Currently the state of the random number generator cannot be modified and starts off with the same state. Thus you will get the same sequence of numbers for the same sequence of calls.
Definition at line 719 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
Definition at line 170 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
mask | If a mask is given only the active entries will be gathered/scattered. |
Definition at line 193 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
member2 | If member1 is a struct then member2 selects the member to be read from that struct (i.e. array[i].*member1.*member2 is read). |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
Definition at line 220 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
member2 | If member1 is a struct then member2 selects the member to be read from that struct (i.e. array[i].*member1.*member2 is read). |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
mask | If a mask is given only the active entries will be gathered/scattered. |
Definition at line 245 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
ptrMember1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
outerIndexes | |
innerIndexes |
Definition at line 268 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
ptrMember1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
outerIndexes | |
innerIndexes | |
mask | If a mask is given only the active entries will be gathered/scattered. |
Definition at line 291 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
Definition at line 19 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
mask | If a mask is given only the active entries will be gathered/scattered. |
Definition at line 42 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
member2 | If member1 is a struct then member2 selects the member to be read from that struct (i.e. array[i].*member1.*member2 is read). |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
Definition at line 67 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
member1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
member2 | If member1 is a struct then member2 selects the member to be read from that struct (i.e. array[i].*member1.*member2 is read). |
indexes | Determines the offsets into array where the values are gathered from/scattered to. The type of indexes can either be an integer vector or a type that supports operator[] access. |
mask | If a mask is given only the active entries will be gathered/scattered. |
Definition at line 93 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
ptrMember1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
outerIndexes | |
innerIndexes |
Definition at line 116 of file simdarray.h.
|
inline |
array | A pointer into memory (without alignment restrictions). |
ptrMember1 | If array points to a struct, member1 determines the member in the struct to be read. Thus the offsets in indexes are relative to the array and not to the size of the gathered type (i.e. array[i].*member1 is accessed instead of (&(array->*member1))[i]) |
outerIndexes | |
innerIndexes | |
mask | If a mask is given only the active entries will be gathered/scattered. |
Definition at line 139 of file simdarray.h.
|
inlinenoexcept |
This operator can be used to modify scalar entries of the vector.
index | A value between 0 and Size. This value is not checked internally so you must make/be sure it is in range. |
index
.Definition at line 1035 of file simdarray.h.
|
inlinenoexcept |
This operator can be used to read scalar entries of the vector.
index | A value between 0 and Size. This value is not checked internally so you must make/be sure it is in range. |
index
. Definition at line 1042 of file simdarray.h.
|
inline |
Definition at line 1050 of file simdarray.h.
|
inline |
Return a sorted copy of the vector.
v[0] <= v[1] <= v[2] <= v[3] ...
Example:
With SSE the output would be:
[1513634383, -963914658, 1763536262, -1285037745] [-1285037745, -963914658, 1513634383, 1763536262]
With the Scalar implementation:
[1513634383] [1513634383]
Definition at line 1361 of file simdarray.h.
|
inline |
Returns the exponents of the floating-point values in the vector.
Definition at line 1432 of file simdarray.h.
|
inline |
Returns whether a value is negative.
Definition at line 1438 of file simdarray.h.
|
inline |
Copies the signs of the components of reference
to the components of the current vector, returning the result.
reference | A vector object that determines the sign of the the result. |
reference
and absolute value taken from the current vector object.Definition at line 1445 of file simdarray.h.
|
staticconstexpr |
Specifies the alignment requirement for aligned load and store calls for objects of this vector type.
Definition at line 692 of file simdarray.h.
|
staticconstexpr |
Returns N
, the number of scalar components in an object of this type.
The size of the SimdArray, i.e. the number of scalar elements in the vector. In contrast to Vector::size() you have control over this value via the N
template parameter of the SimdArray class template.
Definition at line 1428 of file simdarray.h.