/****************************************************************************
*
*    Copyright (c) 2020 Vivante Corporation
*
*    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 TIM_VX_OPS_LOCALRESPONSENORMALIZATION_H_
#define TIM_VX_OPS_LOCALRESPONSENORMALIZATION_H_
#include "tim/vx/builtin_op.h"

/**
 * ## LocalResponseNormalization
 *
 * Applies Local Response Normalization along the depth dimension:
 *
 * ```
 * sqr_sum[a, b, c, d] = sum(
 *     pow(input[a, b, c, d - depth_radius : d + depth_radius + 1], 2))
 * output = input / pow((bias + alpha * sqr_sum), beta)
 * output = input / pow((bias + alpha * sqr_sum), beta)
 * size : width of the 1-D normalization window.
 * bias : An offset (usually positive to avoid dividing by 0).
 * alpha : A scale factor.
 * beta : An exponent.
 * ```
 */

namespace tim {
namespace vx {
namespace ops {
class LocalResponseNormalization : public BuiltinOp {
 public:
  LocalResponseNormalization(Graph* graph, uint32_t size, float alpha,
                             float beta, float bias, int32_t axis);

  std::shared_ptr<Operation> Clone(std::shared_ptr<Graph>& graph) const override;

 protected:
  uint32_t size_;
  float alpha_;
  float beta_;
  float bias_;
  int32_t axis_;
};

using LRN = LocalResponseNormalization;
}  // namespace ops
}  // namespace vx
}  // namespace tim

#endif