/*******************************************************************************
* Copyright 2016-2018 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.
*******************************************************************************/

#ifndef SOFTMAX_FWD_PD_HPP
#define SOFTMAX_FWD_PD_HPP

#include "mkldnn.h"

#include "c_types_map.hpp"
#include "primitive_desc.hpp"
#include "memory_pd.hpp"

namespace mkldnn {
namespace impl {

struct softmax_fwd_pd_t: public primitive_desc_t {
    typedef softmax_fwd_pd_t base_class;
    typedef softmax_fwd_pd_t hint_class;
    static constexpr auto base_pkind = primitive_kind::softmax;

    softmax_fwd_pd_t(mkldnn::impl::engine_t *engine,
            const softmax_desc_t *adesc, const primitive_attr_t *attr,
            const softmax_fwd_pd_t *hint_fwd_pd)
        : primitive_desc_t(engine, attr, primitive_kind::softmax)
        , desc_(*adesc), hint_fwd_pd_(hint_fwd_pd) {}
    virtual ~softmax_fwd_pd_t() {}

    const softmax_desc_t *desc() const { return &desc_; }
    virtual const op_desc_t *op_desc() const override
    { return reinterpret_cast<const op_desc_t *>(this->desc()); }
    virtual void init_info() override { init_info_softmax(this, this->info_); }

    virtual const memory_pd_t *input_pd(int index = 0) const override
    { return index == 0 ? src_pd() : nullptr; }
    virtual const memory_pd_t *output_pd(int index = 0) const override {
        if (index == 0) return dst_pd();
        if (index == 1) return workspace_pd();
        return nullptr;
    }

    virtual int n_inputs() const override { return 1; }
    virtual int n_outputs() const override
    { return 1 + (workspace_pd() != nullptr); }

    virtual status_t query(query_t what, int idx, void *result) const override
    {
        switch (what) {
        case query::softmax_d:
            *(const softmax_desc_t**)result = desc(); break;
        default: return primitive_desc_t::query(what, idx, result);
        }
        return status::success;
    }

    /* common softmax aux functions */

    inline int MB() const { return desc_.data_desc.dims[0]; }
    inline int C() const { return desc_.data_desc.dims[1]; }
    inline int D() const { return ndims() >= 5 ? desc_.data_desc.dims[ndims() - 3] : 1; }
    inline int H() const { return ndims() >= 4 ? desc_.data_desc.dims[ndims() - 2] : 1; }
    inline int W() const { return ndims() >= 3 ? desc_.data_desc.dims[ndims() - 1] : 1; }

    dim_t outer_size() const {
        return utils::array_product(desc_.data_desc.dims, axis());
    }
    dim_t axis_size() const { return desc_.data_desc.dims[axis()]; }
    dim_t inner_size() const {
        return utils::array_product(desc_.data_desc.dims + axis() + 1,
                ndims() - 1 - axis());
    }

    dim_t outer_stride() const {
        const memory_desc_wrapper data_d(desc_.data_desc);
        return axis() > 0
            ? (dim_t)data_d.blocking_desc().strides[0][axis() - 1]
            : 1;
    }

    int axis() const { return desc_.softmax_axis; }
    int ndims() const { return desc_.data_desc.ndims; }

    bool is_fwd() const {
        return utils::one_of(desc_.prop_kind, prop_kind::forward_training,
                prop_kind::forward_inference);
    }

    bool has_zero_dim_memory() const {
        return memory_desc_wrapper(desc_.data_desc).has_zero_dim();
    }

protected:
    softmax_desc_t desc_;
    const softmax_fwd_pd_t *hint_fwd_pd_;
};

struct softmax_bwd_pd_t: public primitive_desc_t {
    typedef softmax_bwd_pd_t base_class;
    typedef softmax_fwd_pd_t hint_class;
    static constexpr auto base_pkind = primitive_kind::softmax;

    softmax_bwd_pd_t(mkldnn::impl::engine_t *engine,
            const softmax_desc_t *adesc, const primitive_attr_t *attr,
            const softmax_fwd_pd_t *hint_fwd_pd)    // FWD?
        : primitive_desc_t(engine, attr, primitive_kind::softmax)
        , desc_(*adesc), hint_fwd_pd_(hint_fwd_pd) {}
    virtual ~softmax_bwd_pd_t() {}

    const softmax_desc_t *desc() const { return &desc_; }
    virtual const op_desc_t *op_desc() const override
    { return reinterpret_cast<const op_desc_t *>(this->desc()); }
    virtual void init_info() override { init_info_softmax(this, this->info_); }

    virtual const memory_pd_t *input_pd(int index = 0) const override {
        if (index == 0) return dst_pd();
        if (index == 1) return diff_dst_pd();
        return nullptr;
    }
    virtual const memory_pd_t *output_pd(int index = 0) const override
    { return index == 0 ? diff_src_pd() : nullptr; }

    virtual int n_inputs() const override
    { return 2 + (workspace_pd() != nullptr); }
    virtual int n_outputs() const override { return 1; }

    virtual status_t query(query_t what, int idx, void *result) const override
    {
        switch (what) {
        case query::softmax_d:
            *(const softmax_desc_t**)result = desc(); break;
        default: return primitive_desc_t::query(what, idx, result);
        }
        return status::success;
    }

    /* common softmax aux functions */

    inline int MB() const { return desc_.data_desc.dims[0]; }
    inline int C() const { return desc_.data_desc.dims[1]; }
    inline int D() const { return ndims() >= 5 ? desc_.data_desc.dims[ndims() - 3] : 1; }
    inline int H() const { return ndims() >= 4 ? desc_.data_desc.dims[ndims() - 2] : 1; }
    inline int W() const { return ndims() >= 3 ? desc_.data_desc.dims[ndims() - 1] : 1; }

    dim_t outer_size() const {
        return utils::array_product(desc_.data_desc.dims, axis());
    }
    dim_t axis_size() const { return desc_.data_desc.dims[axis()]; }
    dim_t inner_size() const {
        return utils::array_product(desc_.data_desc.dims + axis() + 1,
                ndims() - 1 - axis());
    }

    dim_t outer_stride() const {
        const memory_desc_wrapper data_d(desc_.data_desc);
        return axis() > 0
            ? (dim_t)data_d.blocking_desc().strides[0][axis() - 1]
            : 1;
    }

    int axis() const { return desc_.softmax_axis; }
    int ndims() const { return desc_.data_desc.ndims; }

    bool is_fwd() const {
        return utils::one_of(desc_.prop_kind, prop_kind::forward_training,
                prop_kind::forward_inference);
    }

    bool has_zero_dim_memory() const {
        return memory_desc_wrapper(desc_.data_desc).has_zero_dim();
    }

protected:
    softmax_desc_t desc_;
    const softmax_fwd_pd_t *hint_fwd_pd_;
};


}
}

#endif

// vim: et ts=4 sw=4 cindent cino^=l0,\:0,N-s