/******************************************************************************
* Copyright (c) 2016 - present Advanced Micro Devices, Inc. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*******************************************************************************/

#ifndef PLAN_H
#define PLAN_H

#include <array>
#include <cstring>
#include <vector>

#include "tree_node.h"

static inline bool IsPo2(size_t u)
{
    return (u != 0) && (0 == (u & (u - 1)));
}

std::string PrintScheme(ComputeScheme cs);

inline bool SupportedLength(size_t len)
{
    size_t p = len;
    while(!(p % 2))
        p /= 2;
    while(!(p % 3))
        p /= 3;
    while(!(p % 5))
        p /= 5;
    // while(!(p%7)) p /= 7;

    if(p == 1)
        return true;
    else
        return false;
}

inline size_t FindBlue(size_t len)
{
    size_t p = 1;
    while(p < len)
        p <<= 1;
    return 2 * p;
}

struct rocfft_plan_description_t
{

    rocfft_array_type inArrayType, outArrayType;

    std::array<size_t, 3> inStrides;
    std::array<size_t, 3> outStrides;

    size_t inDist;
    size_t outDist;

    std::array<size_t, 2> inOffset;
    std::array<size_t, 2> outOffset;

    double scale;

    rocfft_plan_description_t()
    {
        inArrayType  = rocfft_array_type_complex_interleaved;
        outArrayType = rocfft_array_type_complex_interleaved;

        inStrides.fill(0);
        outStrides.fill(0);

        inDist  = 0;
        outDist = 0;

        inOffset.fill(0);
        outOffset.fill(0);

        scale = 1.0;
    }
};

struct rocfft_plan_t
{
    size_t                rank;
    std::array<size_t, 3> lengths;
    size_t                batch;

    rocfft_result_placement placement;
    rocfft_transform_type   transformType;
    rocfft_precision        precision;
    int                     padding; // it is only for 8 bytes alignment
    size_t                  base_type_size;

    rocfft_plan_description_t desc;

    rocfft_plan_t()
        : placement(rocfft_placement_inplace)
        , rank(1)
        , batch(1)
        , transformType(rocfft_transform_type_complex_forward)
        , precision(rocfft_precision_single)
        , base_type_size(sizeof(float))
        , padding(0)
    {
        lengths.fill(1);
    }

    bool operator<(const rocfft_plan_t& b) const
    {
        const rocfft_plan_t& a = *this;

        assert(sizeof(rocfft_plan_t) % 8 == 0);
        // The below memcmp() works only with 8 bytes alignment,
        // and also potentially depends on implementation of std::array.
        // The better way should be comparison with each attribute.
        return (memcmp(&a, &b, sizeof(rocfft_plan_t)) < 0 ? true : false);
    }
};

void PlanPowX(ExecPlan& execPlan);

#endif // PLAN_H