SCIP Doxygen Documentation
 
Loading...
Searching...
No Matches

Detailed Description

methods for linear regression

Below are the public methods for incremental linear regression of observations pairs \((X_i,Y_i), i=1\dots,n\)

Functions

int SCIPregressionGetNObservations (SCIP_REGRESSION *regression)
 
SCIP_Real SCIPregressionGetSlope (SCIP_REGRESSION *regression)
 
SCIP_Real SCIPregressionGetIntercept (SCIP_REGRESSION *regression)
 
void SCIPregressionRemoveObservation (SCIP_REGRESSION *regression, SCIP_Real x, SCIP_Real y)
 
void SCIPregressionAddObservation (SCIP_REGRESSION *regression, SCIP_Real x, SCIP_Real y)
 
void SCIPregressionReset (SCIP_REGRESSION *regression)
 
SCIP_RETCODE SCIPregressionCreate (SCIP_REGRESSION **regression)
 
void SCIPregressionFree (SCIP_REGRESSION **regression)
 

Function Documentation

◆ SCIPregressionGetNObservations()

int SCIPregressionGetNObservations ( SCIP_REGRESSION * regression)

returns the number of observations of this regression

Parameters
regressionregression data structure

Definition at line 254 of file misc.c.

References assert(), SCIP_Regression::nobservations, and NULL.

Referenced by getCurrentRegressionTangentAxisIntercept().

◆ SCIPregressionGetSlope()

SCIP_Real SCIPregressionGetSlope ( SCIP_REGRESSION * regression)

return the current slope of the regression

Parameters
regressionregression data structure

Definition at line 264 of file misc.c.

References assert(), NULL, and SCIP_Regression::slope.

Referenced by getCurrentRegressionTangentAxisIntercept().

◆ SCIPregressionGetIntercept()

SCIP_Real SCIPregressionGetIntercept ( SCIP_REGRESSION * regression)

get the current y-intercept of the regression

Parameters
regressionregression data structure

Definition at line 274 of file misc.c.

References assert(), SCIP_Regression::intercept, and NULL.

Referenced by getCurrentRegressionTangentAxisIntercept().

◆ SCIPregressionRemoveObservation()

void SCIPregressionRemoveObservation ( SCIP_REGRESSION * regression,
SCIP_Real x,
SCIP_Real y )

removes an observation (x,y) from the regression

Parameters
regressionregression data structure
xX of observation
yY of the observation

Definition at line 349 of file misc.c.

References assert(), FALSE, i, incrementalStatsUpdate(), SCIP_Regression::meanx, SCIP_Regression::meany, SCIP_Regression::nobservations, NULL, regressionRecompute(), SCIPregressionReset(), SCIP_Regression::sumxy, SCIP_Regression::variancesumx, SCIP_Regression::variancesumy, x, and y.

Referenced by updateLogRegression().

◆ SCIPregressionAddObservation()

void SCIPregressionAddObservation ( SCIP_REGRESSION * regression,
SCIP_Real x,
SCIP_Real y )

update regression by a new observation (x,y)

Parameters
regressionregression data structure
xX of observation
yY of the observation

Definition at line 381 of file misc.c.

References assert(), i, incrementalStatsUpdate(), SCIP_Regression::meanx, SCIP_Regression::meany, SCIP_Regression::nobservations, NULL, regressionRecompute(), SCIP_Regression::sumxy, TRUE, SCIP_Regression::variancesumx, SCIP_Regression::variancesumy, x, and y.

Referenced by solveNode(), and updateLogRegression().

◆ SCIPregressionReset()

◆ SCIPregressionCreate()

SCIP_RETCODE SCIPregressionCreate ( SCIP_REGRESSION ** regression)

creates and resets a regression

Parameters
regressionregression data structure

Definition at line 416 of file misc.c.

References assert(), BMSallocMemory, NULL, SCIP_ALLOC, SCIP_OKAY, and SCIPregressionReset().

Referenced by SCIPincludeEventHdlrSolvingphase(), and SCIPstatCreate().

◆ SCIPregressionFree()

void SCIPregressionFree ( SCIP_REGRESSION ** regression)

frees a regression

creates and resets a regression

Parameters
regressionregression data structure

Definition at line 432 of file misc.c.

References BMSfreeMemory.

Referenced by SCIP_DECL_EVENTFREE(), and SCIPstatFree().