WireCell::LinearModel Class Reference

#include <LinearModel.h>

Inheritance diagram for WireCell::LinearModel:

Public Member Functions
	LinearModel ()
virtual	~LinearModel ()
Eigen::VectorXd &	Gety ()
Eigen::MatrixXd &	GetX ()
Eigen::VectorXd &	Getbeta ()
virtual void	SetData (Eigen::MatrixXd X, Eigen::VectorXd y)
virtual void	Sety (Eigen::VectorXd y)
virtual void	SetX (Eigen::MatrixXd X)
virtual void	Setbeta (Eigen::VectorXd beta)
virtual void	Fit ()
Eigen::VectorXd	Predict ()
double	chi2_base ()
double	MeanResidual ()

Public Attributes
std::string	name

Protected Attributes
Eigen::VectorXd	_y
Eigen::MatrixXd	_X
Eigen::VectorXd	_beta

Detailed Description

Definition at line 9 of file LinearModel.h.

Constructor & Destructor Documentation

WireCell::LinearModel::LinearModel

(

)

Definition at line 6 of file LinearModel.cxx.

{}

WireCell::LinearModel::~LinearModel ( )

virtual

Definition at line 9 of file LinearModel.cxx.

{}

Member Function Documentation

double WireCell::LinearModel::chi2_base

(

)

Definition at line 17 of file LinearModel.cxx.

{
    return ( _y - Predict() ).squaredNorm();
}

virtual void WireCell::LinearModel::Fit ( )

inlinevirtual

Reimplemented in WireCell::ElasticNetModel, and WireCell::LassoModel.

Definition at line 23 of file LinearModel.h.

{};

Eigen::VectorXd& WireCell::LinearModel::Getbeta ( )

inline

Definition at line 16 of file LinearModel.h.

{ return _beta; }

Eigen::MatrixXd& WireCell::LinearModel::GetX ( )

inline

Definition at line 15 of file LinearModel.h.

{ return _X; }

Eigen::VectorXd& WireCell::LinearModel::Gety ( )

inline

Definition at line 14 of file LinearModel.h.

{ return _y; }

double WireCell::LinearModel::MeanResidual

(

)

Definition at line 23 of file LinearModel.cxx.

{
    return ( _y - Predict() ).norm() / _y.size();
}

VectorXd WireCell::LinearModel::Predict

(

)

Definition at line 12 of file LinearModel.cxx.

{
    return _X * _beta;
}

virtual void WireCell::LinearModel::Setbeta ( Eigen::VectorXd  beta )

inlinevirtual

Definition at line 21 of file LinearModel.h.

{ _beta = beta; }

virtual void WireCell::LinearModel::SetData ( Eigen::MatrixXd  X, Eigen::VectorXd  y  )

inlinevirtual

Definition at line 18 of file LinearModel.h.

{ SetX(X); Sety(y); }

virtual void WireCell::LinearModel::SetX ( Eigen::MatrixXd  X )

inlinevirtual

Reimplemented in WireCell::ElasticNetModel.

Definition at line 20 of file LinearModel.h.

{ _X = X; _beta = Eigen::VectorXd::Zero(X.cols());}

virtual void WireCell::LinearModel::Sety ( Eigen::VectorXd  y )

inlinevirtual

Definition at line 19 of file LinearModel.h.

{ _y = y; }

Member Data Documentation

Eigen::VectorXd WireCell::LinearModel::_beta

protected

Definition at line 34 of file LinearModel.h.

Eigen::MatrixXd WireCell::LinearModel::_X

protected

Definition at line 33 of file LinearModel.h.

Eigen::VectorXd WireCell::LinearModel::_y

protected

Definition at line 32 of file LinearModel.h.

std::string WireCell::LinearModel::name

Definition at line 27 of file LinearModel.h.

---

The documentation for this class was generated from the following files:

• wire-cell-build/ress/inc/WireCellRess/LinearModel.h
• wire-cell-build/ress/src/LinearModel.cxx