SAGA API  v9.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CSG_Regression Class Reference

#include <mat_tools.h>

Public Member Functions

 CSG_Regression (void)
 
virtual ~CSG_Regression (void)
 
void Destroy (void)
 
bool Set_Values (int nValues, double *x, double *y)
 
bool Add_Values (double x, double y)
 
int Get_Count (void) const
 
double Get_xValue (int i) const
 
double Get_yValue (int i) const
 
bool Get_Values (int i, double &x, double &y) const
 
double Get_xMin (void) const
 
double Get_xMax (void) const
 
double Get_xMean (void) const
 
double Get_xVariance (void) const
 
double Get_x (double y) const
 
double Get_yMin (void) const
 
double Get_yMax (void) const
 
double Get_yMean (void) const
 
double Get_yVariance (void) const
 
double Get_y (double x) const
 
double Get_Constant (void) const
 
double Get_Coefficient (void) const
 
double Get_R (void) const
 
double Get_R2 (void) const
 
double Get_R2_Adj (void) const
 
double Get_P (void) const
 
double Get_StdError (void) const
 
const SG_Char * asString (void)
 
TSG_Regression_Type Get_Type (void) const
 
bool Calculate (TSG_Regression_Type Type=REGRESSION_Linear, bool bStdError=false)
 
bool Calculate (int nValues, double *x, double *y, TSG_Regression_Type Type=REGRESSION_Linear, bool bStdError=false)
 

Protected Member Functions

double _Y_Transform (double x)
 
double _X_Transform (double y)
 

Protected Attributes

double m_RConst
 
double m_RCoeff
 
double m_R
 
double m_R2
 
double m_R2_Adj
 
double m_P
 
double m_SE
 
double m_xMin
 
double m_xMax
 
double m_xMean
 
double m_xVar
 
double m_yMin
 
double m_yMax
 
double m_yMean
 
double m_yVar
 
CSG_Vector m_x
 
CSG_Vector m_y
 
TSG_Regression_Type m_Type
 

Detailed Description

Definition at line 1599 of file mat_tools.h.

Constructor & Destructor Documentation

◆ CSG_Regression()

CSG_Regression::CSG_Regression ( void  )

Definition at line 109 of file mat_regression.cpp.

References Destroy().

◆ ~CSG_Regression()

CSG_Regression::~CSG_Regression ( void  )
virtual

Definition at line 115 of file mat_regression.cpp.

References Destroy().

Member Function Documentation

◆ _X_Transform()

double CSG_Regression::_X_Transform ( double  y)
inlineprotected

Definition at line 293 of file mat_regression.cpp.

References M_FLT_EPSILON, m_Type, REGRESSION_Log, REGRESSION_Pow, and REGRESSION_Rez_X.

Referenced by Calculate().

◆ _Y_Transform()

double CSG_Regression::_Y_Transform ( double  x)
inlineprotected

Definition at line 274 of file mat_regression.cpp.

References M_FLT_EPSILON, m_Type, REGRESSION_Exp, REGRESSION_Pow, and REGRESSION_Rez_Y.

Referenced by Calculate().

◆ Add_Values()

bool CSG_Regression::Add_Values ( double  x,
double  y 
)

Definition at line 142 of file mat_regression.cpp.

References CSG_Vector::Add_Row(), m_x, and m_y.

◆ asString()

const SG_Char * CSG_Regression::asString ( void  )

Definition at line 161 of file mat_regression.cpp.

References CSG_String::Clear(), CSG_String::Format(), Get_Count(), m_R, m_R2, m_RCoeff, m_RConst, m_Type, m_xMax, m_xMean, m_xMin, m_xVar, m_yMax, m_yMean, m_yMin, m_yVar, REGRESSION_Exp, REGRESSION_Linear, REGRESSION_Log, REGRESSION_Pow, REGRESSION_Rez_X, REGRESSION_Rez_Y, and SG_T.

◆ Calculate() [1/2]

bool CSG_Regression::Calculate ( int  nValues,
double *  x,
double *  y,
TSG_Regression_Type  Type = REGRESSION_Linear,
bool  bStdError = false 
)

Definition at line 433 of file mat_regression.cpp.

References Calculate(), and Set_Values().

◆ Calculate() [2/2]

bool CSG_Regression::Calculate ( TSG_Regression_Type  Type = REGRESSION_Linear,
bool  bStdError = false 
)

Definition at line 317 of file mat_regression.cpp.

References _X_Transform(), _Y_Transform(), CSG_Simple_Statistics::Create(), Get_Count(), CSG_Test_Distribution::Get_F_Tail_from_R2(), CSG_Simple_Statistics::Get_Maximum(), CSG_Simple_Statistics::Get_Mean(), CSG_Simple_Statistics::Get_Minimum(), CSG_Simple_Statistics::Get_Variance(), Get_y(), m_P, m_R, m_R2, m_R2_Adj, m_RCoeff, m_RConst, m_SE, m_Type, m_x, m_xMax, m_xMean, m_xMin, m_xVar, m_y, m_yMax, m_yMean, m_yMin, m_yVar, REGRESSION_Exp, REGRESSION_Log, REGRESSION_Pow, REGRESSION_Rez_X, REGRESSION_Rez_Y, and SG_Regression_Get_Adjusted_R2().

Referenced by Calculate().

◆ Destroy()

void CSG_Regression::Destroy ( void  )

Definition at line 126 of file mat_regression.cpp.

References CSG_Vector::Destroy(), m_R2, m_Type, m_x, m_y, and REGRESSION_Linear.

Referenced by CSG_Regression(), Set_Values(), and ~CSG_Regression().

◆ Get_Coefficient()

double CSG_Regression::Get_Coefficient ( void  ) const
inline

Definition at line 1640 of file mat_tools.h.

◆ Get_Constant()

double CSG_Regression::Get_Constant ( void  ) const
inline

Definition at line 1639 of file mat_tools.h.

◆ Get_Count()

int CSG_Regression::Get_Count ( void  ) const
inline

Definition at line 1610 of file mat_tools.h.

Referenced by asString(), and Calculate().

◆ Get_P()

double CSG_Regression::Get_P ( void  ) const
inline

Definition at line 1644 of file mat_tools.h.

◆ Get_R()

double CSG_Regression::Get_R ( void  ) const
inline

Definition at line 1641 of file mat_tools.h.

◆ Get_R2()

double CSG_Regression::Get_R2 ( void  ) const
inline

Definition at line 1642 of file mat_tools.h.

◆ Get_R2_Adj()

double CSG_Regression::Get_R2_Adj ( void  ) const
inline

Definition at line 1643 of file mat_tools.h.

◆ Get_StdError()

double CSG_Regression::Get_StdError ( void  ) const
inline

Definition at line 1645 of file mat_tools.h.

◆ Get_Type()

TSG_Regression_Type CSG_Regression::Get_Type ( void  ) const
inline

Definition at line 1649 of file mat_tools.h.

◆ Get_Values()

bool CSG_Regression::Get_Values ( int  i,
double &  x,
double &  y 
) const
inline

Definition at line 1614 of file mat_tools.h.

◆ Get_x()

double CSG_Regression::Get_x ( double  y) const

Definition at line 191 of file mat_regression.cpp.

References m_R2, m_RCoeff, m_RConst, m_Type, REGRESSION_Exp, REGRESSION_Linear, REGRESSION_Log, REGRESSION_Pow, REGRESSION_Rez_X, and REGRESSION_Rez_Y.

◆ Get_xMax()

double CSG_Regression::Get_xMax ( void  ) const
inline

Definition at line 1628 of file mat_tools.h.

◆ Get_xMean()

double CSG_Regression::Get_xMean ( void  ) const
inline

Definition at line 1629 of file mat_tools.h.

◆ Get_xMin()

double CSG_Regression::Get_xMin ( void  ) const
inline

Definition at line 1627 of file mat_tools.h.

◆ Get_xValue()

double CSG_Regression::Get_xValue ( int  i) const
inline

Definition at line 1612 of file mat_tools.h.

◆ Get_xVariance()

double CSG_Regression::Get_xVariance ( void  ) const
inline

Definition at line 1630 of file mat_tools.h.

◆ Get_y()

double CSG_Regression::Get_y ( double  x) const

Definition at line 233 of file mat_regression.cpp.

References m_R2, m_RCoeff, m_RConst, m_Type, REGRESSION_Exp, REGRESSION_Linear, REGRESSION_Log, REGRESSION_Pow, REGRESSION_Rez_X, and REGRESSION_Rez_Y.

Referenced by Calculate().

◆ Get_yMax()

double CSG_Regression::Get_yMax ( void  ) const
inline

Definition at line 1634 of file mat_tools.h.

◆ Get_yMean()

double CSG_Regression::Get_yMean ( void  ) const
inline

Definition at line 1635 of file mat_tools.h.

◆ Get_yMin()

double CSG_Regression::Get_yMin ( void  ) const
inline

Definition at line 1633 of file mat_tools.h.

◆ Get_yValue()

double CSG_Regression::Get_yValue ( int  i) const
inline

Definition at line 1613 of file mat_tools.h.

◆ Get_yVariance()

double CSG_Regression::Get_yVariance ( void  ) const
inline

Definition at line 1636 of file mat_tools.h.

◆ Set_Values()

bool CSG_Regression::Set_Values ( int  nValues,
double *  x,
double *  y 
)

Definition at line 148 of file mat_regression.cpp.

References CSG_Vector::Create(), Destroy(), m_x, and m_y.

Referenced by Calculate().

Member Data Documentation

◆ m_P

double CSG_Regression::m_P
protected

Definition at line 1657 of file mat_tools.h.

Referenced by Calculate().

◆ m_R

double CSG_Regression::m_R
protected

Definition at line 1657 of file mat_tools.h.

Referenced by asString(), and Calculate().

◆ m_R2

double CSG_Regression::m_R2
protected

Definition at line 1657 of file mat_tools.h.

Referenced by asString(), Calculate(), Destroy(), Get_x(), and Get_y().

◆ m_R2_Adj

double CSG_Regression::m_R2_Adj
protected

Definition at line 1657 of file mat_tools.h.

Referenced by Calculate().

◆ m_RCoeff

double CSG_Regression::m_RCoeff
protected

Definition at line 1657 of file mat_tools.h.

Referenced by asString(), Calculate(), Get_x(), and Get_y().

◆ m_RConst

double CSG_Regression::m_RConst
protected

Definition at line 1657 of file mat_tools.h.

Referenced by asString(), Calculate(), Get_x(), and Get_y().

◆ m_SE

double CSG_Regression::m_SE
protected

Definition at line 1657 of file mat_tools.h.

Referenced by Calculate().

◆ m_Type

TSG_Regression_Type CSG_Regression::m_Type
protected

Definition at line 1663 of file mat_tools.h.

Referenced by _X_Transform(), _Y_Transform(), asString(), Calculate(), Destroy(), Get_x(), and Get_y().

◆ m_x

CSG_Vector CSG_Regression::m_x
protected

Definition at line 1661 of file mat_tools.h.

Referenced by Add_Values(), Calculate(), Destroy(), and Set_Values().

◆ m_xMax

double CSG_Regression::m_xMax
protected

Definition at line 1658 of file mat_tools.h.

Referenced by asString(), and Calculate().

◆ m_xMean

double CSG_Regression::m_xMean
protected

Definition at line 1658 of file mat_tools.h.

Referenced by asString(), and Calculate().

◆ m_xMin

double CSG_Regression::m_xMin
protected

Definition at line 1658 of file mat_tools.h.

Referenced by asString(), and Calculate().

◆ m_xVar

double CSG_Regression::m_xVar
protected

Definition at line 1658 of file mat_tools.h.

Referenced by asString(), and Calculate().

◆ m_y

CSG_Vector CSG_Regression::m_y
protected

Definition at line 1661 of file mat_tools.h.

Referenced by Add_Values(), Calculate(), Destroy(), and Set_Values().

◆ m_yMax

double CSG_Regression::m_yMax
protected

Definition at line 1659 of file mat_tools.h.

Referenced by asString(), and Calculate().

◆ m_yMean

double CSG_Regression::m_yMean
protected

Definition at line 1659 of file mat_tools.h.

Referenced by asString(), and Calculate().

◆ m_yMin

double CSG_Regression::m_yMin
protected

Definition at line 1659 of file mat_tools.h.

Referenced by asString(), and Calculate().

◆ m_yVar

double CSG_Regression::m_yVar
protected

Definition at line 1659 of file mat_tools.h.

Referenced by asString(), and Calculate().

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