mask.h

/*  This file is part of the Vc library. {{{
Copyright © 2015 Matthias Kretz <kretz@kde.org>

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the names of contributing organizations nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

}}}*/

#ifndef VC_COMMON_MASK_H_
#define VC_COMMON_MASK_H_

#include "macros.h"

namespace Vc_VERSIONED_NAMESPACE
{
template <typename T, typename Abi = VectorAbi::Best<T>> class Mask
{
public:
    static constexpr size_t size() { return VectorTraits<T, Abi>::size(); }
    static constexpr size_t Size = VectorTraits<T, Abi>::size();

    static constexpr size_t MemoryAlignment = VectorTraits<T, Abi>::maskMemoryAlignment();

    using abi = Abi;

    using EntryType = bool;
    using value_type = EntryType;

    using EntryReference = typename VectorTraits<T, Abi>::EntryReference;
    using value_reference = EntryReference;

    using VectorEntryType = typename VectorTraits<T, Abi>::VectorEntryType;

    using VectorType = typename VectorTraits<T, Abi>::VectorType;
    using vector_type = VectorType;

    /*
     * The associated Vector<T> type.
     */
    //using Vector = Vector<T, Abi>;


    Vc_INTRINSIC static Mask Zero();

    Vc_INTRINSIC static Mask One();

    template <typename G> static Vc_INTRINSIC Mask generate(G &&gen);


    Vc_INTRINSIC Mask() = default;

    Vc_INTRINSIC explicit Mask(VectorSpecialInitializerZero);

    Vc_INTRINSIC explicit Mask(VectorSpecialInitializerOne);


    Vc_INTRINSIC explicit Mask(bool b);

    template <typename U>
    Vc_INTRINSIC Mask(U &&otherMask,
                      Common::enable_if_mask_converts_implicitly<T, U> = nullarg);

#if Vc_IS_VERSION_1

    template <typename U>
    Vc_DEPRECATED(
        "use simd_cast instead of explicit type casting to convert between mask types")
        Vc_INTRINSIC_L
        explicit Mask(U &&otherMask, Common::enable_if_mask_converts_explicitly<T, U> =
                                         nullarg) Vc_INTRINSIC_R;
#endif


    Vc_ALWAYS_INLINE explicit Mask(const bool *mem);
    template <typename Flags> Vc_ALWAYS_INLINE explicit Mask(const bool *mem, Flags flags);

    Vc_ALWAYS_INLINE void load(const bool *mem);
    template <typename Flags> Vc_ALWAYS_INLINE void load(const bool *mem, Flags flags);

    Vc_ALWAYS_INLINE void store(bool *mem) const;
    template <typename Flags> Vc_ALWAYS_INLINE void store(bool *mem, Flags flags) const;


    Vc_ALWAYS_INLINE bool operator==(const Mask &mask) const;

    Vc_ALWAYS_INLINE bool operator!=(const Mask &mask) const;


    Vc_ALWAYS_INLINE Mask operator&&(const Mask &mask) const;
    Vc_ALWAYS_INLINE Mask operator&(const Mask &mask) const;
    Vc_ALWAYS_INLINE Mask operator||(const Mask &mask) const;
    Vc_ALWAYS_INLINE Mask operator|(const Mask &mask) const;
    Vc_ALWAYS_INLINE Mask operator^(const Mask &mask) const;
    Vc_ALWAYS_INLINE Mask operator!() const;

    Vc_ALWAYS_INLINE Mask &operator&=(const Mask &mask);
    Vc_ALWAYS_INLINE Mask &operator|=(const Mask &mask);
    Vc_ALWAYS_INLINE Mask &operator^=(const Mask &mask);


    Vc_ALWAYS_INLINE bool isFull() const;
    Vc_ALWAYS_INLINE bool isNotEmpty() const;
    Vc_ALWAYS_INLINE bool isEmpty() const;
    Vc_ALWAYS_INLINE bool isMix() const;

    Vc_ALWAYS_INLINE bool data() const;
    Vc_ALWAYS_INLINE bool dataI() const;
    Vc_ALWAYS_INLINE bool dataD() const;


    Vc_ALWAYS_INLINE EntryReference operator[](size_t index);

    Vc_ALWAYS_INLINE EntryType operator[](size_t index) const;

    Vc_ALWAYS_INLINE int count() const;

    Vc_ALWAYS_INLINE int firstOne() const;

    Vc_ALWAYS_INLINE int toInt() const;

    Vc_INTRINSIC Vc_PURE Mask shifted(int amount) const;

    Vc_FREE_STORE_OPERATORS_ALIGNED(alignof(Mask));

private:
    VectorType d;
};

}  // namespace Vc

#endif  // VC_COMMON_MASK_H_

// vim: foldmethod=marker