margin_ranking_loss.hpp

Go to the documentation of this file.

#ifndef MLPACK_ANN_LOSS_FUNCTION_MARGIN_RANKING_LOSS_HPP
#define MLPACK_ANN_LOSS_FUNCTION_MARGIN_RANKING_LOSS_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace ann  {

template <
    typename InputDataType = arma::mat,
    typename OutputDataType = arma::mat
>
class MarginRankingLoss
{
 public:
  MarginRankingLoss(const double margin = 1.0);

  template<typename PredictionType, typename TargetType>
  typename PredictionType::elem_type Forward(const PredictionType& prediction,
                                             const TargetType& target);

  template <
    typename PredictionType,
    typename TargetType,
    typename LossType
  >
  void Backward(const PredictionType& prediction,
                const TargetType& target,
                LossType& loss);

  OutputDataType& OutputParameter() const { return outputParameter; }
  OutputDataType& OutputParameter() { return outputParameter; }

  double Margin() const { return margin; }
  double& Margin() { return margin; }

  template<typename Archive>
  void serialize(Archive& ar, const uint32_t /* version */);

 private:
  OutputDataType outputParameter;

  double margin;
}; // class MarginRankingLoss

} // namespace ann
} // namespace mlpack

// include implementation.
#include "margin_ranking_loss_impl.hpp"

#endif