Docs For Class PHPExcel_Best_Fit

PHPExcel_Shared_Best_Fit

# Class: PHPExcel_Best_Fit

Source Location: /PHPExcel/Shared/trend/bestFitClass.php

### Class Overview

PHPExcel_Best_Fit

#### Author(s):

#### Copyright:

- Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

### Variables

- $_adjustToZero
- $_bestFitType
- $_correlation
- $_covariance
- $_DFResiduals
- $_error
- $_F
- $_goodnessOfFit
- $_intersect
- $_intersectSE
- $_slope
- $_slopeSE
- $_SSRegression
- $_SSResiduals
- $_stdevOfResiduals
- $_valueCount
- $_Xoffset
- $_xValues
- $_yBestFitValues
- $_Yoffset
- $_yValues

### Methods

- __construct
- getBestFitType
- getCorrelation
- getCovariance
- getDFResiduals
- getEquation
- getError
- getF
- getGoodnessOfFit
- getGoodnessOfFitPercent
- getIntersect
- getIntersectSE
- getSlope
- getSlopeSE
- getSSRegression
- getSSResiduals
- getStdevOfResiduals
- getValueOfXForY
- getValueOfYForX
- getXValues
- getYBestFitValues
- _calculateGoodnessOfFit
- _leastSquareFit

### Child classes:

PHPExcel_Exponential_Best_Fit
  PHPExcel_Exponential_Best_Fit

PHPExcel_Linear_Best_Fit
  PHPExcel_Linear_Best_Fit

PHPExcel_Logarithmic_Best_Fit
  PHPExcel_Logarithmic_Best_Fit

PHPExcel_Polynomial_Best_Fit
  PHPExcel_Polynomial_Best_Fit

PHPExcel_Power_Best_Fit
  PHPExcel_Power_Best_Fit

### Class Details

[line 36]
PHPExcel_Best_Fit

#### Tags:

copyright: | Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

[ Top ]

### Class Variables

#### $_adjustToZero = False

[line 48]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_bestFitType = 'undetermined'

[line 40]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_correlation = 0

[line 58]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_covariance = 0

[line 56]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_DFResiduals = 0

[line 64]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_error = False

[line 38]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_F = 0

[line 66]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_goodnessOfFit = 1

[line 52]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_intersect = 0

[line 72]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_intersectSE = 0

[line 74]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_slope = 0

[line 68]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_slopeSE = 0

[line 70]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_SSRegression = 0

[line 60]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_SSResiduals = 0

[line 62]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_stdevOfResiduals = 0

[line 54]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_valueCount = 0

[line 42]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_Xoffset = 0

[line 76]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_xValues = array()

[line 44]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_yBestFitValues = array()

[line 50]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_Yoffset = 0

[line 78]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

#### $_yValues = array()

[line 46]

#### Tags:

access: | protected

Type: | mixed

[ Top ]

### Class Methods

### constructor __construct [line 311]

`PHPExcel_Best_Fit __construct( $yValues, [ $xValues = array()], [ $const = True])`

Overridden in child classes as:

PHPExcel_Exponential_Best_Fit::__construct()

PHPExcel_Linear_Best_Fit::__construct()

PHPExcel_Logarithmic_Best_Fit::__construct()

PHPExcel_Polynomial_Best_Fit::__construct()

PHPExcel_Power_Best_Fit::__construct()

#### Parameters:

| $yValues |
| $xValues |
| $const |

[ Top ]

### method getBestFitType [line 86]

`void getBestFitType( )`

#### Tags:

access: | public

[ Top ]

### method getCorrelation [line 207]

`void getCorrelation( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getCovariance [line 199]

`void getCovariance( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getDFResiduals [line 183]

`void getDFResiduals( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getEquation [line 106]

`void getEquation( [ $dp = 0])`

#### Tags:

access: | public

Overridden in child classes as:

PHPExcel_Exponential_Best_Fit::getEquation()

PHPExcel_Linear_Best_Fit::getEquation()

PHPExcel_Logarithmic_Best_Fit::getEquation()

PHPExcel_Polynomial_Best_Fit::getEquation()

PHPExcel_Power_Best_Fit::getEquation()

#### Parameters:

| $dp |

[ Top ]

### method getError [line 81]

`void getError( )`

#### Tags:

access: | public

[ Top ]

### method getF [line 191]

`void getF( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getGoodnessOfFit [line 143]

`void getGoodnessOfFit( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getGoodnessOfFitPercent [line 151]

`void getGoodnessOfFitPercent( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getIntersect [line 127]

`void getIntersect( [ $dp = 0])`

#### Tags:

access: | public

Overridden in child classes as:

PHPExcel_Exponential_Best_Fit::getIntersect()

PHPExcel_Power_Best_Fit::getIntersect()

#### Parameters:

| $dp |

[ Top ]

### method getIntersectSE [line 135]

`void getIntersectSE( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getSlope [line 111]

`void getSlope( [ $dp = 0])`

#### Tags:

access: | public

Overridden in child classes as:

PHPExcel_Exponential_Best_Fit::getSlope()

PHPExcel_Polynomial_Best_Fit::getSlope()

#### Parameters:

| $dp |

[ Top ]

### method getSlopeSE [line 119]

`void getSlopeSE( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getSSRegression [line 167]

`void getSSRegression( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getSSResiduals [line 175]

`void getSSResiduals( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getStdevOfResiduals [line 159]

`void getStdevOfResiduals( [ $dp = 0])`

#### Tags:

access: | public

#### Parameters:

| $dp |

[ Top ]

### method getValueOfXForY [line 96]

`void getValueOfXForY( $yValue)`

#### Tags:

access: | public

Overridden in child classes as:

PHPExcel_Exponential_Best_Fit::getValueOfXForY()

PHPExcel_Linear_Best_Fit::getValueOfXForY()

PHPExcel_Logarithmic_Best_Fit::getValueOfXForY()

PHPExcel_Polynomial_Best_Fit::getValueOfXForY()

PHPExcel_Power_Best_Fit::getValueOfXForY()

#### Parameters:

| $yValue |

[ Top ]

### method getValueOfYForX [line 91]

`void getValueOfYForX( $xValue)`

#### Tags:

access: | public

Overridden in child classes as:

PHPExcel_Exponential_Best_Fit::getValueOfYForX()

PHPExcel_Linear_Best_Fit::getValueOfYForX()

PHPExcel_Logarithmic_Best_Fit::getValueOfYForX()

PHPExcel_Polynomial_Best_Fit::getValueOfYForX()

PHPExcel_Power_Best_Fit::getValueOfYForX()

#### Parameters:

| $xValue |

[ Top ]

### method getXValues [line 101]

`void getXValues( )`

#### Tags:

access: | public

[ Top ]

### method getYBestFitValues [line 215]

`void getYBestFitValues( )`

#### Tags:

access: | public

[ Top ]

### method _calculateGoodnessOfFit [line 220]

`void _calculateGoodnessOfFit( $sumX, $sumY, $sumX2, $sumY2, $sumXY, $meanX, $meanY, $const)`

#### Tags:

access: | protected

#### Parameters:

| $sumX |
| $sumY |
| $sumX2 |
| $sumY2 |
| $sumXY |
| $meanX |
| $meanY |
| $const |

[ Top ]

### method _leastSquareFit [line 274]

`void _leastSquareFit( $yValues, $xValues, $const)`

#### Tags:

access: | protected

#### Parameters:

| $yValues |
| $xValues |
| $const |

[ Top ]

Documentation generated on Sun, 27 Feb 2011 16:28:30 -0800 by phpDocumentor 1.4.3