mygsl::linear_regression::fit_data Class Reference

The serializable result data of the linear regression algorithm. More...

#include <bayeux/mygsl/linear_regression.h>

Inheritance diagram for mygsl::linear_regression::fit_data:

Public Member Functions
	fit_data ()
	Constructor. More...
virtual	~fit_data ()
	Destructor. More...
bool	is_valid () const
	Check if the fit data are valid. More...
bool	is_weighted () const
	Check if the fit was weighted. More...
bool	has_constant () const
	Check if the linear fit uses a constant parameter. More...
void	reset ()
	Reset the fit data. More...
double	get_slope () const
	Return the slope parameter. More...
double	get_constant () const
	Return the constant parameter. More...
size_t	get_ndof () const
	Return the number of degrees of freedom. More...
double	get_chisq () const
	Return the chi squared. More...
double	get_sumsq () const
	Return the sum of squared residuals. More...
double	get_slope_err () const
	Return the error on the slope. More...
double	get_constant_err () const
	Return the error on the constant. More...
Public Member Functions inherited from datatools::i_serializable
	i_serializable ()
	Default constructor. More...
virtual	~i_serializable ()
	Destructor. More...
virtual const std::string &	get_serial_tag () const =0
	Return the serialization string identifier of the class. More...

Public Attributes
uint32_t	n
int32_t	status
	Number of fitted points. More...
bool	weighted
	Status of the fit 0 == fit results; no fit otherwise. More...
bool	with_constant
	Flag for a weighted fut. More...
double	c1
	Flag for a linear fit with a constant. More...
double	c0
	Slope parameter. More...
double	cov00
	Constant parameter. More...
double	cov01
	Covariance coefficient. More...
double	cov11
	Covariance coefficient. More...
double	sumsq
	Covariance coefficient. More...
double	chisq
	Sum of squared residuals. More...

Detailed Description

The serializable result data of the linear regression algorithm.

Constructor & Destructor Documentation

fit_data()

mygsl::linear_regression::fit_data::fit_data

(

)

Constructor.

~fit_data()

virtual mygsl::linear_regression::fit_data::~fit_data ( )

virtual

Destructor.

Member Function Documentation

get_chisq()

double mygsl::linear_regression::fit_data::get_chisq

(

)

const

Return the chi squared.

get_constant()

double mygsl::linear_regression::fit_data::get_constant

(

)

const

Return the constant parameter.

get_constant_err()

double mygsl::linear_regression::fit_data::get_constant_err

(

)

const

Return the error on the constant.

get_ndof()

size_t mygsl::linear_regression::fit_data::get_ndof

(

)

const

Return the number of degrees of freedom.

get_slope()

double mygsl::linear_regression::fit_data::get_slope

(

)

const

Return the slope parameter.

get_slope_err()

double mygsl::linear_regression::fit_data::get_slope_err

(

)

const

Return the error on the slope.

get_sumsq()

double mygsl::linear_regression::fit_data::get_sumsq

(

)

const

Return the sum of squared residuals.

has_constant()

bool mygsl::linear_regression::fit_data::has_constant

(

)

const

Check if the linear fit uses a constant parameter.

is_valid()

bool mygsl::linear_regression::fit_data::is_valid

(

)

const

Check if the fit data are valid.

is_weighted()

bool mygsl::linear_regression::fit_data::is_weighted

(

)

const

Check if the fit was weighted.

reset()

void mygsl::linear_regression::fit_data::reset

(

)

Reset the fit data.

Member Data Documentation

c0

double mygsl::linear_regression::fit_data::c0

Slope parameter.

c1

double mygsl::linear_regression::fit_data::c1

Flag for a linear fit with a constant.

chisq

double mygsl::linear_regression::fit_data::chisq

Sum of squared residuals.

cov00

double mygsl::linear_regression::fit_data::cov00

Constant parameter.

cov01

double mygsl::linear_regression::fit_data::cov01

Covariance coefficient.

cov11

double mygsl::linear_regression::fit_data::cov11

Covariance coefficient.

n

uint32_t mygsl::linear_regression::fit_data::n

status

int32_t mygsl::linear_regression::fit_data::status

Number of fitted points.

sumsq

double mygsl::linear_regression::fit_data::sumsq

Covariance coefficient.

weighted

bool mygsl::linear_regression::fit_data::weighted

Status of the fit 0 == fit results; no fit otherwise.

with_constant

bool mygsl::linear_regression::fit_data::with_constant

Flag for a weighted fut.

---

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

• bayeux/mygsl/linear_regression.h