/*
// Copyright (c) 2016 Intel Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/

#pragma once

#include "common_kernel_base.h"
#include "kernel_selector_params.h"

namespace kernel_selector 
{
    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    // pooling_params
    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    struct pooling_params : public base_params
    {
        pooling_params() : base_params(KernelType::POOLING) {}

        PoolType            poolType = PoolType::MAX;
        PoolRemainder       remainderAction = PoolRemainder::FLOOR;
        KernelDividerMode   divMode = KernelDividerMode::DONT_CARE;
        uSize               poolSize;
        uSize               poolStride;
        uSize               poolPad;

        virtual ParamsKey GetParamsKey() const
        {
            ParamsKey k = base_params::GetParamsKey();

            k.EnablePoolType(poolType);
            k.EnablePoolRemainder(remainderAction);
            k.EnablePoolKernelDividerMode(divMode);

            return k;
        }
    };

    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    // pooling_optional_params
    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    struct pooling_optional_params : optional_params
    {
        pooling_optional_params() : optional_params(KernelType::POOLING) {}
    };

    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    // PoolingKernelBase
    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    class PoolingKernelBase : public common_kernel_base
    {
    public:
        using common_kernel_base::common_kernel_base;
        virtual ~PoolingKernelBase() {}

        struct DispatchData : public CommonDispatchData
        {
            bool needsBoundary;
        };

    protected:
        virtual bool Validate(const Params&, const optional_params&) const override;
        virtual JitConstants GetJitConstants(const pooling_params& params, DispatchData kd) const;
        virtual DispatchData SetDefault(const pooling_params& params) const;
        KernelsData GetCommonKernelsData(const Params& params, const optional_params&, float estimatedTime) const;

        bool NeedsBoundaryCheck(const pooling_params& params) const;
    };
}