/* Copyright (c) 2018 Anakin Authors, Inc. All Rights Reserved.

   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. 
*/

#ifndef ANAKIN_OPERATOR_PIXEL_SHUFFLE_H
#define ANAKIN_OPERATOR_PIXEL_SHUFFLE_H

#include "framework/core/base.h"
#include "framework/core/data_types.h"
#include "framework/core/operator/operator.h"
#include "utils/logger/logger.h"
#include "saber/funcs/pixel_shuffle.h"

namespace anakin {

namespace ops {

template<typename Ttype, Precision Ptype>
class PixelShuffleHelper;

/// pooling op
/**
 * \brief PixelShuffle implementation class
 * public inherit Operator
 */
template<typename Ttype, Precision Ptype>
class PixelShuffle : public Operator<Ttype, Ptype> {
public:
    PixelShuffle() {}

    /// forward impl
    virtual void operator() (OpContext<Ttype> &ctx, 
                             const std::vector<Tensor4dPtr<Ttype> >& ins, 
                             std::vector<Tensor4dPtr<Ttype> >& outs);
                             

    friend class PixelShuffleHelper<Ttype, Ptype>;
};

/**
 * \brief Permut helper class to implement conv 3X3
 * public inherit OperatorHelper
 * including init resource and shape size in Permut context
 */
template<typename Ttype, Precision Ptype>
class PixelShuffleHelper : public OperatorHelper<Ttype, Ptype> {
public:
    PixelShuffleHelper()=default;

    ~PixelShuffleHelper() {}

    Status InitParam() override;

    /**
    * \brief initial all the resource needed by pooling
    * \param ctx stand for Permut operation context
    * \param ins stand for input tensor vector
    * \param outs stand for output tensor vector
    * \return status
    */
    Status Init(OpContext<Ttype> &ctx,
                const std::vector<Tensor4dPtr<Ttype> >& ins, 
                std::vector<Tensor4dPtr<Ttype> >& outs) override;

    /**
    * \brief infer the shape of output and input.
    * \param ins stand for input tensor vector
    * \param outs stand for output tensor vector
    * \return status
    */
    Status InferShape(const std::vector<Tensor4dPtr<Ttype> >& ins,
                      std::vector<Tensor4dPtr<Ttype> >& outs) override;

public:
    ///< _param_PixelShuffle stand for PixelShuffle parameter
    saber::PixelShuffleParam<Ttype> _param_pixel_shuffle;
    ///< _funcs_PixelShuffle stand for PixelShuffle function
    saber::PixelShuffle<Ttype, PrecisionWrapper<Ptype>::saber_type> _funcs_pixel_shuffle;
};
        
} /* namespace ops */

} /* namespace anakin */

#endif
