Vc/common/storeinterface.h

0001 /*  This file is part of the Vc library. {{{
0002 Copyright © 2014 Matthias Kretz <kretz@kde.org>
0003
0004 Redistribution and use in source and binary forms, with or without
0005 modification, are permitted provided that the following conditions are met:
0006     * Redistributions of source code must retain the above copyright
0007       notice, this list of conditions and the following disclaimer.
0008     * Redistributions in binary form must reproduce the above copyright
0009       notice, this list of conditions and the following disclaimer in the
0010       documentation and/or other materials provided with the distribution.
0011     * Neither the names of contributing organizations nor the
0012       names of its contributors may be used to endorse or promote products
0013       derived from this software without specific prior written permission.
0014
0015 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
0016 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
0017 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
0018 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
0019 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
0020 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
0021 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
0022 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0023 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
0024 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0025
0026 }}}*/
0027
0028 ///////////////////////////////////////////////////////////////////////////////////////////
0029 // stores
0030
0031 /**
0032  * Store the vector data to \p mem.
0033  *
0034  * \param mem A pointer to memory, where \VSize{T} consecutive values will be stored.
0035  * \param flags The flags parameter can be used to select e.g. the Vc::Aligned,
0036  *              Vc::Unaligned, Vc::Streaming, and/or Vc::PrefetchDefault flags.
0037  */
0038 template <
0039     typename U,
0040     typename Flags = DefaultStoreTag,
0041     typename = enable_if<std::is_arithmetic<U>::value &&Traits::is_load_store_flag<Flags>::value>>
0042 Vc_INTRINSIC_L void store(U *mem, Flags flags = Flags()) const Vc_INTRINSIC_R;
0043
0044 /**
0045  * Store the vector data to \p mem where \p mask is set.
0046  *
0047  * \param mem A pointer to memory, where \VSize{T} consecutive values will be stored.
0048  * \param mask A mask object that determines which entries of the vector should be stored
0049  *             to \p mem.
0050  * \param flags The flags parameter can be used to select e.g. the Vc::Aligned,
0051  *              Vc::Unaligned, Vc::Streaming, and/or Vc::PrefetchDefault flags.
0052  *
0053  * \note
0054  * The masked store does not pack the values into memory. I.e. the value at offset \c i
0055  * will be stored to `mem[i]`, independent of whether `mask[j]` for any `j < i` is \c
0056  * false.
0057  */
0058 template <
0059     typename U,
0060     typename Flags = DefaultStoreTag,
0061     typename = enable_if<std::is_arithmetic<U>::value &&Traits::is_load_store_flag<Flags>::value>>
0062 Vc_INTRINSIC_L void Vc_VDECL store(U *mem, MaskType mask, Flags flags = Flags()) const Vc_INTRINSIC_R;
0063
0064 //@{
0065 /**
0066  * The following store overloads support classes that have a cast operator to `EntryType
0067  * *`.
0068  */
0069 Vc_INTRINSIC void store(EntryType *mem) const
0070 {
0071     store<EntryType, DefaultStoreTag>(mem, DefaultStoreTag());
0072 }
0073
0074 template <typename Flags, typename = enable_if<Traits::is_load_store_flag<Flags>::value>>
0075 Vc_INTRINSIC void store(EntryType *mem, Flags flags) const
0076 {
0077     store<EntryType, Flags>(mem, flags);
0078 }
0079
0080 Vc_INTRINSIC void Vc_VDECL store(EntryType *mem, MaskType mask) const
0081 {
0082     store<EntryType, DefaultStoreTag>(mem, mask, DefaultStoreTag());
0083 }
0084
0085 template <typename Flags, typename = enable_if<Traits::is_load_store_flag<Flags>::value>>
0086 Vc_INTRINSIC void Vc_VDECL store(EntryType *mem, MaskType mask, Flags flags) const
0087 {
0088     store<EntryType, Flags>(mem, mask, flags);
0089 }
0090 //@}
0091
0092 // vim: foldmethod=marker