AoS.hpp

Go to the documentation of this file.

// Copyright 2022 Alexander Matthes, Bernhard Manfred Gruber
// SPDX-License-Identifier: MPL-2.0
 
#pragma once
 
#include "Common.hpp"
 
namespace llama::mapping
{
    LLAMA_EXPORT
    template<
        typename TArrayExtents,
        typename TRecordDim,
        FieldAlignment TFieldAlignment = FieldAlignment::Align,
        typename TLinearizeArrayIndexFunctor = LinearizeArrayIndexRight,
        template<typename> typename PermuteFields = PermuteFieldsInOrder>
    struct AoS : MappingBase<TArrayExtents, TRecordDim>
    {
    private:
        using Base = MappingBase<TArrayExtents, TRecordDim>;
        using size_type = typename Base::size_type;
 
    public:
        inline static constexpr FieldAlignment fieldAlignment = TFieldAlignment;
        using LinearizeArrayIndexFunctor = TLinearizeArrayIndexFunctor;
        using Permuter = PermuteFields<FlatRecordDim<TRecordDim>>;
        inline static constexpr std::size_t blobCount = 1;
 
        using Base::Base;
 
        LLAMA_FN_HOST_ACC_INLINE constexpr auto blobSize(size_type) const -> size_type
        {
            return LinearizeArrayIndexFunctor{}.size(Base::extents())
                * flatSizeOf<typename Permuter::FlatRecordDim, fieldAlignment == FieldAlignment::Align>;
        }
 
        template<std::size_t... RecordCoords>
        LLAMA_FN_HOST_ACC_INLINE constexpr auto blobNrAndOffset(
            typename Base::ArrayIndex ai,
            RecordCoord<RecordCoords...> = {}) const -> NrAndOffset<size_type>
        {
            constexpr std::size_t flatFieldIndex =
#if defined(__NVCC__) && __CUDACC_VER_MAJOR__ == 11 && __CUDACC_VER_MINOR__ <= 6
                *& // mess with nvcc compiler state to workaround bug
#endif
                 Permuter::template permute<flatRecordCoord<TRecordDim, RecordCoord<RecordCoords...>>>;
            const auto offset
                = LinearizeArrayIndexFunctor{}(ai, Base::extents())
                    * static_cast<size_type>(
                        flatSizeOf<typename Permuter::FlatRecordDim, fieldAlignment == FieldAlignment::Align>)
                + static_cast<size_type>(flatOffsetOf<
                                         typename Permuter::FlatRecordDim,
                                         flatFieldIndex,
                                         fieldAlignment == FieldAlignment::Align>);
            return {size_type{0}, offset};
        }
    };
 
    // we can drop this when inherited ctors also inherit deduction guides
    LLAMA_EXPORT
    template<typename TArrayExtents, typename TRecordDim>
    AoS(TArrayExtents, TRecordDim) -> AoS<TArrayExtents, TRecordDim>;
 
    LLAMA_EXPORT
    template<typename ArrayExtents, typename RecordDim, typename LinearizeArrayIndexFunctor = LinearizeArrayIndexRight>
    using AlignedAoS = AoS<ArrayExtents, RecordDim, FieldAlignment::Align, LinearizeArrayIndexFunctor>;
 
    LLAMA_EXPORT
    template<typename ArrayExtents, typename RecordDim, typename LinearizeArrayIndexFunctor = LinearizeArrayIndexRight>
    using MinAlignedAoS = AoS<
        ArrayExtents,
        RecordDim,
        FieldAlignment::Align,
        LinearizeArrayIndexFunctor,
        PermuteFieldsMinimizePadding>;
 
    LLAMA_EXPORT
    template<typename ArrayExtents, typename RecordDim, typename LinearizeArrayIndexFunctor = LinearizeArrayIndexRight>
    using PackedAoS = AoS<ArrayExtents, RecordDim, FieldAlignment::Pack, LinearizeArrayIndexFunctor>;
 
    LLAMA_EXPORT
    template<
        FieldAlignment Alignment = FieldAlignment::Align,
        typename LinearizeArrayIndexFunctor = LinearizeArrayIndexRight>
    struct BindAoS
    {
        template<typename ArrayExtents, typename RecordDim>
        using fn = AoS<ArrayExtents, RecordDim, Alignment, LinearizeArrayIndexFunctor>;
    };
 
    LLAMA_EXPORT
    template<typename Mapping>
    inline constexpr bool isAoS = false;
 
    LLAMA_EXPORT
    template<
        typename ArrayExtents,
        typename RecordDim,
        FieldAlignment FieldAlignment,
        typename LinearizeArrayIndexFunctor,
        template<typename>
        typename PermuteFields>
    inline constexpr bool
        isAoS<AoS<ArrayExtents, RecordDim, FieldAlignment, LinearizeArrayIndexFunctor, PermuteFields>>
        = true;
} // namespace llama::mapping