A wrapper around the platform's native SIMD register type. More...
#include <juce_SIMDRegister.h>
Classes | |
struct | ElementAccess |
Public Types | |
using | ElementType = Type |
The type that represents the individual constituents of the SIMD Register. | |
using | value_type = ElementType |
STL compatible value_type definition (same as ElementType). | |
using | MaskType = SIMDInternal::MaskType<ElementType> |
The corresponding primitive integer type, for example, this will be int32_t if type is a float. | |
using | PrimitiveType = typename SIMDInternal::PrimitiveType<ElementType>::type |
The native primitive type (used internally). | |
using | NativeOps = SIMDNativeOps<PrimitiveType> |
The native operations for this platform and type combination (used internally) | |
using | vSIMDType = typename NativeOps::vSIMDType |
The native type (used internally). | |
using | vMaskType = SIMDRegister<MaskType> |
The corresponding integer SIMDRegister type (used internally). | |
using | vMaskSIMDType = typename vMaskType::vSIMDType |
The internal native type for the corresponding mask type (used internally). | |
using | CmplxOps = CmplxSIMDOps<ElementType> |
Wrapper for operations which need to be handled differently for complex and scalar types (used internally). | |
Public Member Functions | |
SIMDRegister () noexcept=default | |
Default constructor. | |
SIMDRegister (vSIMDType a) noexcept | |
Constructs an object from the native SIMD type. | |
SIMDRegister (Type s) noexcept | |
Constructs an object from a scalar type by broadcasting it to all elements. | |
void JUCE_VECTOR_CALLTYPE | copyToRawArray (ElementType *a) const noexcept |
Copies the elements of the SIMDRegister to a scalar array in memory. | |
ElementType JUCE_VECTOR_CALLTYPE | get (size_t idx) const noexcept |
Returns the idx-th element of the receiver. | |
void JUCE_VECTOR_CALLTYPE | set (size_t idx, ElementType v) noexcept |
Sets the idx-th element of the receiver. | |
ElementType JUCE_VECTOR_CALLTYPE | operator[] (size_t idx) const noexcept |
Returns the idx-th element of the receiver. | |
ElementAccess JUCE_VECTOR_CALLTYPE | operator[] (size_t idx) noexcept |
Returns the idx-th element of the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator+= (SIMDRegister v) noexcept |
Adds another SIMDRegister to the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator-= (SIMDRegister v) noexcept |
Subtracts another SIMDRegister to the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator*= (SIMDRegister v) noexcept |
Multiplies another SIMDRegister to the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator= (ElementType s) noexcept |
Broadcasts the scalar to all elements of the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator+= (ElementType s) noexcept |
Adds a scalar to the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator-= (ElementType s) noexcept |
Subtracts a scalar to the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator*= (ElementType s) noexcept |
Multiplies a scalar to the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator&= (vMaskType v) noexcept |
Bit-and the receiver with SIMDRegister v and store the result in the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator|= (vMaskType v) noexcept |
Bit-or the receiver with SIMDRegister v and store the result in the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator^= (vMaskType v) noexcept |
Bit-xor the receiver with SIMDRegister v and store the result in the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator&= (MaskType s) noexcept |
Bit-and each element of the receiver with the scalar s and store the result in the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator|= (MaskType s) noexcept |
Bit-or each element of the receiver with the scalar s and store the result in the receiver. | |
SIMDRegister &JUCE_VECTOR_CALLTYPE | operator^= (MaskType s) noexcept |
Bit-xor each element of the receiver with the scalar s and store the result in the receiver. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator+ (SIMDRegister v) const noexcept |
Returns the sum of the receiver and v. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator- (SIMDRegister v) const noexcept |
Returns the difference of the receiver and v. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator* (SIMDRegister v) const noexcept |
Returns the product of the receiver and v. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator+ (ElementType s) const noexcept |
Returns a vector where each element is the sum of the corresponding element in the receiver and the scalar s. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator- (ElementType s) const noexcept |
Returns a vector where each element is the difference of the corresponding element in the receiver and the scalar s. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator* (ElementType s) const noexcept |
Returns a vector where each element is the product of the corresponding element in the receiver and the scalar s. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator& (vMaskType v) const noexcept |
Returns the bit-and of the receiver and v. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator| (vMaskType v) const noexcept |
Returns the bit-or of the receiver and v. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator^ (vMaskType v) const noexcept |
Returns the bit-xor of the receiver and v. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator~ () const noexcept |
Returns a vector where each element is the bit-inverted value of the corresponding element in the receiver. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator& (MaskType s) const noexcept |
Returns a vector where each element is the bit-and'd value of the corresponding element in the receiver and the scalar s. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator| (MaskType s) const noexcept |
Returns a vector where each element is the bit-or'd value of the corresponding element in the receiver and the scalar s. | |
SIMDRegister JUCE_VECTOR_CALLTYPE | operator^ (MaskType s) const noexcept |
Returns a vector where each element is the bit-xor'd value of the corresponding element in the receiver and the scalar s. | |
bool JUCE_VECTOR_CALLTYPE | operator== (SIMDRegister other) const noexcept |
Returns true if all element-wise comparisons return true. | |
bool JUCE_VECTOR_CALLTYPE | operator!= (SIMDRegister other) const noexcept |
Returns true if any element-wise comparisons return false. | |
bool JUCE_VECTOR_CALLTYPE | operator== (Type s) const noexcept |
Returns true if all elements are equal to the scalar. | |
bool JUCE_VECTOR_CALLTYPE | operator!= (Type s) const noexcept |
Returns true if any elements are not equal to the scalar. | |
ElementType | sum () const noexcept |
Returns a scalar which is the sum of all elements of the receiver. | |
Static Public Member Functions | |
static constexpr size_t | size () noexcept |
Returns the number of elements in this vector. | |
static SIMDRegister JUCE_VECTOR_CALLTYPE | expand (ElementType s) noexcept |
Creates a new SIMDRegister from the corresponding scalar primitive. | |
static SIMDRegister JUCE_VECTOR_CALLTYPE | fromNative (vSIMDType a) noexcept |
Creates a new SIMDRegister from the internal SIMD type (for example __mm128 for single-precision floating point on SSE architectures). | |
static SIMDRegister JUCE_VECTOR_CALLTYPE | fromRawArray (const ElementType *a) noexcept |
Creates a new SIMDRegister from the first SIMDNumElements of a scalar array. | |
static vMaskType JUCE_VECTOR_CALLTYPE | equal (SIMDRegister a, SIMDRegister b) noexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is equal to the corresponding element of b, or zero otherwise. | |
static vMaskType JUCE_VECTOR_CALLTYPE | notEqual (SIMDRegister a, SIMDRegister b) noexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is not equal to the corresponding element of b, or zero otherwise. | |
static vMaskType JUCE_VECTOR_CALLTYPE | lessThan (SIMDRegister a, SIMDRegister b) noexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is less than to the corresponding element of b, or zero otherwise. | |
static vMaskType JUCE_VECTOR_CALLTYPE | lessThanOrEqual (SIMDRegister a, SIMDRegister b) noexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is than or equal to the corresponding element of b, or zero otherwise. | |
static vMaskType JUCE_VECTOR_CALLTYPE | greaterThan (SIMDRegister a, SIMDRegister b) noexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is greater than to the corresponding element of b, or zero otherwise. | |
static vMaskType JUCE_VECTOR_CALLTYPE | greaterThanOrEqual (SIMDRegister a, SIMDRegister b) noexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is greater than or equal to the corresponding element of b, or zero otherwise. | |
static SIMDRegister JUCE_VECTOR_CALLTYPE | min (SIMDRegister a, SIMDRegister b) noexcept |
Returns a new vector where each element is the minimum of the corresponding element of a and b. | |
static SIMDRegister JUCE_VECTOR_CALLTYPE | max (SIMDRegister a, SIMDRegister b) noexcept |
Returns a new vector where each element is the maximum of the corresponding element of a and b. | |
static SIMDRegister JUCE_VECTOR_CALLTYPE | multiplyAdd (SIMDRegister a, const SIMDRegister b, SIMDRegister c) noexcept |
Multiplies b and c and adds the result to a. | |
static SIMDRegister JUCE_VECTOR_CALLTYPE | truncate (SIMDRegister a) noexcept |
Truncates each element to its integer part. | |
static SIMDRegister JUCE_VECTOR_CALLTYPE | abs (SIMDRegister a) noexcept |
Returns the absolute value of each element. | |
static bool | isSIMDAligned (const ElementType *ptr) noexcept |
Checks if the given pointer is sufficiently aligned for using SIMD operations. | |
static ElementType * | getNextSIMDAlignedPtr (ElementType *ptr) noexcept |
Returns the next position in memory where isSIMDAligned returns true. | |
Public Attributes | |
vSIMDType | value {} |
Static Public Attributes | |
static constexpr size_t | SIMDRegisterSize = sizeof (vSIMDType) |
The size in bytes of this register. | |
static constexpr size_t | SIMDNumElements = SIMDRegisterSize / sizeof (ElementType) |
The number of elements that this vector can hold. | |
A wrapper around the platform's native SIMD register type.
This class is only available on SIMD machines. Use JUCE_USE_SIMD to query if SIMD is available for your system.
SIMDRegister<Type> is a templated class representing the native vectorized version of FloatingType. SIMDRegister supports all numerical primitive types and std:complex<float> and std::complex<double> supports and most operations of the corresponding primitive type. Additionally, SIMDRegister can be accessed like an array to extract the individual elements.
If you are using SIMDRegister as a pointer, then you must ensure that the memory is sufficiently aligned for SIMD vector operations. Failing to do so will result in crashes or very slow code. Use SIMDRegister::isSIMDAligned to query if a pointer is sufficiently aligned for SIMD vector operations.
Note that using SIMDRegister without enabling optimizations will result in code with very poor performance.
using dsp::SIMDRegister< Type >::ElementType = Type |
The type that represents the individual constituents of the SIMD Register.
using dsp::SIMDRegister< Type >::value_type = ElementType |
STL compatible value_type definition (same as ElementType).
using dsp::SIMDRegister< Type >::MaskType = SIMDInternal::MaskType<ElementType> |
The corresponding primitive integer type, for example, this will be int32_t if type is a float.
using dsp::SIMDRegister< Type >::PrimitiveType = typename SIMDInternal::PrimitiveType<ElementType>::type |
The native primitive type (used internally).
using dsp::SIMDRegister< Type >::NativeOps = SIMDNativeOps<PrimitiveType> |
The native operations for this platform and type combination (used internally)
using dsp::SIMDRegister< Type >::vSIMDType = typename NativeOps::vSIMDType |
The native type (used internally).
using dsp::SIMDRegister< Type >::vMaskType = SIMDRegister<MaskType> |
The corresponding integer SIMDRegister type (used internally).
using dsp::SIMDRegister< Type >::vMaskSIMDType = typename vMaskType::vSIMDType |
The internal native type for the corresponding mask type (used internally).
using dsp::SIMDRegister< Type >::CmplxOps = CmplxSIMDOps<ElementType> |
Wrapper for operations which need to be handled differently for complex and scalar types (used internally).
|
defaultnoexcept |
Default constructor.
|
noexcept |
Constructs an object from the native SIMD type.
|
noexcept |
Constructs an object from a scalar type by broadcasting it to all elements.
|
staticconstexprnoexcept |
Returns the number of elements in this vector.
References dsp::SIMDRegister< Type >::SIMDNumElements.
|
staticnoexcept |
Creates a new SIMDRegister from the corresponding scalar primitive.
The scalar is extended to all elements of the vector.
Referenced by dsp::SIMDRegister< Type >::abs(), and dsp::SIMDRegister< Type >::operator==().
|
staticnoexcept |
Creates a new SIMDRegister from the internal SIMD type (for example __mm128 for single-precision floating point on SSE architectures).
|
staticnoexcept |
Creates a new SIMDRegister from the first SIMDNumElements of a scalar array.
References dsp::SIMDRegister< Type >::isSIMDAligned(), and jassert.
|
noexcept |
Copies the elements of the SIMDRegister to a scalar array in memory.
References dsp::SIMDRegister< Type >::isSIMDAligned(), jassert, and dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns the idx-th element of the receiver.
Note that this does not check if idx is larger than the native register size.
References jassert, dsp::SIMDRegister< Type >::SIMDNumElements, and dsp::SIMDRegister< Type >::value.
Referenced by dsp::SIMDRegister< Type >::operator[]().
|
noexcept |
Sets the idx-th element of the receiver.
Note that this does not check if idx is larger than the native register size.
References jassert, dsp::SIMDRegister< Type >::SIMDNumElements, and dsp::SIMDRegister< Type >::value.
Referenced by dsp::SIMDRegister< Type >::ElementAccess::operator=().
|
noexcept |
Returns the idx-th element of the receiver.
Note that this does not check if idx is larger than the native register size.
References dsp::SIMDRegister< Type >::get().
|
noexcept |
Returns the idx-th element of the receiver.
Note that this does not check if idx is larger than the native register size.
References jassert, and dsp::SIMDRegister< Type >::SIMDNumElements.
|
noexcept |
Adds another SIMDRegister to the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Subtracts another SIMDRegister to the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Multiplies another SIMDRegister to the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Broadcasts the scalar to all elements of the receiver.
References dsp::SIMDRegister< Type >::value.
Referenced by dsp::SIMDRegister< Type >::ElementAccess::operator=().
|
noexcept |
Adds a scalar to the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Subtracts a scalar to the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Multiplies a scalar to the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Bit-and the receiver with SIMDRegister v and store the result in the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Bit-or the receiver with SIMDRegister v and store the result in the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Bit-xor the receiver with SIMDRegister v and store the result in the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Bit-and each element of the receiver with the scalar s and store the result in the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Bit-or each element of the receiver with the scalar s and store the result in the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Bit-xor each element of the receiver with the scalar s and store the result in the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns the sum of the receiver and v.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns the difference of the receiver and v.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns the product of the receiver and v.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns a vector where each element is the sum of the corresponding element in the receiver and the scalar s.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns a vector where each element is the difference of the corresponding element in the receiver and the scalar s.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns a vector where each element is the product of the corresponding element in the receiver and the scalar s.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns the bit-and of the receiver and v.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns the bit-or of the receiver and v.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns the bit-xor of the receiver and v.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns a vector where each element is the bit-inverted value of the corresponding element in the receiver.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns a vector where each element is the bit-and'd value of the corresponding element in the receiver and the scalar s.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns a vector where each element is the bit-or'd value of the corresponding element in the receiver and the scalar s.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns a vector where each element is the bit-xor'd value of the corresponding element in the receiver and the scalar s.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns true if all element-wise comparisons return true.
References dsp::SIMDRegister< Type >::value.
|
noexcept |
Returns true if any element-wise comparisons return false.
|
noexcept |
Returns true if all elements are equal to the scalar.
References dsp::SIMDRegister< Type >::expand().
|
noexcept |
Returns true if any elements are not equal to the scalar.
|
staticnoexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is equal to the corresponding element of b, or zero otherwise.
The result can then be used in bit operations defined above to avoid branches in vector SIMD code.
|
staticnoexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is not equal to the corresponding element of b, or zero otherwise.
The result can then be used in bit operations defined above to avoid branches in vector SIMD code.
|
staticnoexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is less than to the corresponding element of b, or zero otherwise.
The result can then be used in bit operations defined above to avoid branches in vector SIMD code.
Referenced by dsp::SIMDRegister< Type >::abs().
|
staticnoexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is than or equal to the corresponding element of b, or zero otherwise.
The result can then be used in bit operations defined above to avoid branches in vector SIMD code.
|
staticnoexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is greater than to the corresponding element of b, or zero otherwise.
The result can then be used in bit operations defined above to avoid branches in vector SIMD code.
|
staticnoexcept |
Returns a SIMDRegister of the corresponding integral type where each element has each bit set if the corresponding element of a is greater than or equal to the corresponding element of b, or zero otherwise.
The result can then be used in bit operations defined above to avoid branches in vector SIMD code.
|
staticnoexcept |
Returns a new vector where each element is the minimum of the corresponding element of a and b.
Referenced by jmin().
|
staticnoexcept |
Returns a new vector where each element is the maximum of the corresponding element of a and b.
Referenced by jmax().
|
staticnoexcept |
Multiplies b and c and adds the result to a.
|
noexcept |
Returns a scalar which is the sum of all elements of the receiver.
References dsp::SIMDRegister< Type >::value.
|
staticnoexcept |
Truncates each element to its integer part.
Effectively discards the fractional part of each element. A.k.a. round to zero.
|
staticnoexcept |
Returns the absolute value of each element.
References dsp::SIMDRegister< Type >::expand(), and dsp::SIMDRegister< Type >::lessThan().
|
staticnoexcept |
Checks if the given pointer is sufficiently aligned for using SIMD operations.
References dsp::SIMDRegister< Type >::SIMDRegisterSize.
Referenced by dsp::SIMDRegister< Type >::copyToRawArray(), and dsp::SIMDRegister< Type >::fromRawArray().
|
staticnoexcept |
Returns the next position in memory where isSIMDAligned returns true.
If the current position in memory is already aligned then this method will simply return the pointer.
References dsp::SIMDRegister< Type >::SIMDRegisterSize, and snapPointerToAlignment().
|
staticconstexpr |
The size in bytes of this register.
Referenced by dsp::SIMDRegister< Type >::getNextSIMDAlignedPtr(), and dsp::SIMDRegister< Type >::isSIMDAligned().
|
staticconstexpr |
The number of elements that this vector can hold.
Referenced by dsp::SIMDRegister< Type >::get(), dsp::SIMDRegister< Type >::operator[](), dsp::SIMDRegister< Type >::set(), and dsp::SIMDRegister< Type >::size().
vSIMDType dsp::SIMDRegister< Type >::value {} |
Referenced by dsp::SIMDRegister< Type >::copyToRawArray(), dsp::SIMDRegister< Type >::get(), dsp::SIMDRegister< Type >::operator&(), dsp::SIMDRegister< Type >::operator&(), dsp::SIMDRegister< Type >::operator&=(), dsp::SIMDRegister< Type >::operator&=(), dsp::SIMDRegister< Type >::operator*(), dsp::SIMDRegister< Type >::operator*(), dsp::SIMDRegister< Type >::operator*=(), dsp::SIMDRegister< Type >::operator*=(), dsp::SIMDRegister< Type >::operator+(), dsp::SIMDRegister< Type >::operator+(), dsp::SIMDRegister< Type >::operator+=(), dsp::SIMDRegister< Type >::operator+=(), dsp::SIMDRegister< Type >::operator-(), dsp::SIMDRegister< Type >::operator-(), dsp::SIMDRegister< Type >::operator-=(), dsp::SIMDRegister< Type >::operator-=(), dsp::SIMDRegister< Type >::operator=(), dsp::SIMDRegister< Type >::operator==(), dsp::SIMDRegister< Type >::operator^(), dsp::SIMDRegister< Type >::operator^(), dsp::SIMDRegister< Type >::operator^=(), dsp::SIMDRegister< Type >::operator^=(), dsp::SIMDRegister< Type >::operator|(), dsp::SIMDRegister< Type >::operator|(), dsp::SIMDRegister< Type >::operator|=(), dsp::SIMDRegister< Type >::operator|=(), dsp::SIMDRegister< Type >::operator~(), dsp::SIMDRegister< Type >::set(), and dsp::SIMDRegister< Type >::sum().