linear_regression.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_LINEAR_REGRESSION_LINEAR_REGRESSION_HPP
#define MLPACK_METHODS_LINEAR_REGRESSION_LINEAR_REGRESSION_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace regression  {

class LinearRegression
{
 public:
  LinearRegression(const arma::mat& predictors,
                   const arma::vec& responses,
                   const double lambda = 0,
                   const bool intercept = true,
                   const arma::vec& weights = arma::vec());

  LinearRegression(const LinearRegression& linearRegression);

  LinearRegression() : lambda(0.0), intercept(true) { }

  void Train(const arma::mat& predictors,
             const arma::vec& responses,
             const bool intercept = true,
             const arma::vec& weights = arma::vec());

  void Predict(const arma::mat& points, arma::vec& predictions) const;

  double ComputeError(const arma::mat& points,
                      const arma::vec& responses) const;

  const arma::vec& Parameters() const { return parameters; }
  arma::vec& Parameters() { return parameters; }

  double Lambda() const { return lambda; }
  double& Lambda() { return lambda; }

  bool Intercept() const { return intercept; }

  template<typename Archive>
  void Serialize(Archive& ar, const unsigned int /* version */)
  {
    ar & data::CreateNVP(parameters, "parameters");
    ar & data::CreateNVP(lambda, "lambda");
    ar & data::CreateNVP(intercept, "intercept");
  }

 private:
  arma::vec parameters;

  double lambda;

  bool intercept;
};

} // namespace linear_regression
} // namespace mlpack

#endif // MLPACK_METHODS_LINEAR_REGRESSION_HPP