CosSimOp.h

/* Copyright (c) 2016 PaddlePaddle Authors. 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. */

#pragma once

#include "Function.h"

namespace paddle {

/**
 * \brief   Cosine Similarity Forward.
 * for each row i,
 * out[i] = scale * cos(in1[i], in2[i])
 *        = scale * \sum_j (in1[i][j] * in2[i][j]) /
 *                  sqrt(sum_j (in1[i][j]^2) * sum_j (in2[i][j])^2)
 *
 * \param[out]  output            output value.
 * \param[in]   intput1           input value.
 * \param[in]   intput2           input value.
 * \param[in]   scale             default 1.0.
 *
 */
template <DeviceType Device>
void CosSimForward(typename Tensor<real, Device>::Matrix& output,
                   const typename Tensor<real, Device>::Matrix& input1,
                   const typename Tensor<real, Device>::Matrix& input2,
                   real scale);

/**
 * \brief   Cosine Similarity BackWard for Derivative.
 *
 * \param[in]       output grad           backward loss output grad.
 * \param[in]       output val            forward-output value.
 * \param[in]       input val1            forward input value 1.
 * \param[in]       input val2            forward input value 2.
 * \param[in/out]   input grad            forward input grad 1.
 * \param[in/out]   input grad            forward input grad 2.
 * \param[in]       scale                 default 1.0.
 *
 */
template <DeviceType Device>
void CosSimBackward(const typename Tensor<real, Device>::Matrix& out_grad,
                    const typename Tensor<real, Device>::Matrix& out_value,
                    const typename Tensor<real, Device>::Matrix& in1_value,
                    const typename Tensor<real, Device>::Matrix& in2_value,
                    typename Tensor<real, Device>::Matrix& in1_grad,
                    typename Tensor<real, Device>::Matrix& in2_grad,
                    real scale);

}  // namespace paddle