multilabel_softmargin_loss.hpp

Go to the documentation of this file.

#ifndef MLPACK_ANN_LOSS_FUNCTION_MULTILABEL_SOFTMARGIN_LOSS_HPP
#define MLPACK_ANN_LOSS_FUNCTION_MULTILABEL_SOFTMARGIN_LOSS_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace ann  {

template <
    typename InputDataType = arma::mat,
    typename OutputDataType = arma::mat
>
class MultiLabelSoftMarginLoss
{
 public:
  MultiLabelSoftMarginLoss(const bool reduction = true,
                           const arma::rowvec& weights = arma::rowvec());

  template<typename InputType, typename TargetType>
  typename InputType::elem_type Forward(const InputType& input,
                                        const TargetType& target);

  template<typename InputType, typename TargetType, typename OutputType>
  void Backward(const InputType& input,
                const TargetType& target,
                OutputType& output);

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

  const arma::rowvec& ClassWeights() const { return classWeights; }
  arma::rowvec& ClassWeights() { return classWeights; }

  bool Reduction() const { return reduction; }
  bool& Reduction() { return reduction; }

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

 private:
  OutputDataType outputParameter;

  bool reduction;

  arma::rowvec classWeights;

  // An internal parameter used during initialisation of class weights.
  bool weighted;
}; // class MultiLabelSoftMarginLoss

} // namespace ann
} // namespace mlpack

// include implementation.
#include "multilabel_softmargin_loss_impl.hpp"

#endif