Inheritance diagram for PHPExcel_Best_Fit:

Collaboration diagram for PHPExcel_Best_Fit:

Public Member Functions
	getError ()

	getBestFitType ()

	getValueOfYForX ($xValue)
	Return the Y-Value for a specified value of X. More...

	getValueOfXForY ($yValue)
	Return the X-Value for a specified value of Y. More...

	getXValues ()
	Return the original set of X-Values. More...

	getEquation ($dp=0)
	Return the Equation of the best-fit line. More...

	getSlope ($dp=0)
	Return the Slope of the line. More...

	getSlopeSE ($dp=0)
	Return the standard error of the Slope. More...

	getIntersect ($dp=0)
	Return the Value of X where it intersects Y = 0. More...

	getIntersectSE ($dp=0)
	Return the standard error of the Intersect. More...

	getGoodnessOfFit ($dp=0)
	Return the goodness of fit for this regression. More...

	getGoodnessOfFitPercent ($dp=0)

	getStdevOfResiduals ($dp=0)
	Return the standard deviation of the residuals for this regression. More...

	getSSRegression ($dp=0)

	getSSResiduals ($dp=0)

	getDFResiduals ($dp=0)

	getF ($dp=0)

	getCovariance ($dp=0)

	getCorrelation ($dp=0)

	getYBestFitValues ()

	__construct ($yValues, $xValues=array(), $const=True)
	Define the regression. More...

Protected Member Functions
	_calculateGoodnessOfFit ($sumX, $sumY, $sumX2, $sumY2, $sumXY, $meanX, $meanY, $const)

	_leastSquareFit ($yValues, $xValues, $const)

Protected Attributes
	$_error = False

	$_bestFitType = 'undetermined'

	$_valueCount = 0

	$_xValues = array()

	$_yValues = array()

	$_adjustToZero = False

	$_yBestFitValues = array()

	$_goodnessOfFit = 1

	$_stdevOfResiduals = 0

	$_covariance = 0

	$_correlation = 0

	$_SSRegression = 0

	$_SSResiduals = 0

	$_DFResiduals = 0

	$_F = 0

	$_slope = 0

	$_slopeSE = 0

	$_intersect = 0

	$_intersectSE = 0

	$_Xoffset = 0

	$_Yoffset = 0

Detailed Description

Definition at line 36 of file bestFitClass.php.

Constructor & Destructor Documentation

◆ __construct()

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

Define the regression.

Parameters

float[]	$yValues	The set of Y-values for this regression
float[]	$xValues	The set of X-values for this regression
boolean	$const

Reimplemented in PHPExcel_Exponential_Best_Fit, PHPExcel_Linear_Best_Fit, PHPExcel_Logarithmic_Best_Fit, and PHPExcel_Power_Best_Fit.

Definition at line 412 of file bestFitClass.php.

                                                                      {
                //      Calculate number of points
                $nY = count($yValues);
                $nX = count($xValues);
 
                //      Define X Values if necessary
                if ($nX == 0) {
                        $xValues = range(1,$nY);
                        $nX = $nY;
                } elseif ($nY != $nX) {
                        //      Ensure both arrays of points are the same size
                        $this->_error = True;
                        return False;
                }
 
                $this->_valueCount = $nY;
                $this->_xValues = $xValues;
                $this->_yValues = $yValues;
        }       //      function __construct()

Member Function Documentation

◆ _calculateGoodnessOfFit()

PHPExcel_Best_Fit::_calculateGoodnessOfFit	(	$sumX,
		$sumY,
		$sumX2,
		$sumY2,
		$sumXY,
		$meanX,
		$meanY,
		$const
	)

protected

Definition at line 314 of file bestFitClass.php.

                                                                                                           {
                $SSres = $SScov = $SScor = $SStot = $SSsex = 0.0;
                foreach($this->_xValues as $xKey => $xValue) {
                        $bestFitY = $this->_yBestFitValues[$xKey] = $this->getValueOfYForX($xValue);
 
                        $SSres += ($this->_yValues[$xKey] - $bestFitY) * ($this->_yValues[$xKey] - $bestFitY);
                        if ($const) {
                                $SStot += ($this->_yValues[$xKey] - $meanY) * ($this->_yValues[$xKey] - $meanY);
                        } else {
                                $SStot += $this->_yValues[$xKey] * $this->_yValues[$xKey];
                        }
                        $SScov += ($this->_xValues[$xKey] - $meanX) * ($this->_yValues[$xKey] - $meanY);
                        if ($const) {
                                $SSsex += ($this->_xValues[$xKey] - $meanX) * ($this->_xValues[$xKey] - $meanX);
                        } else {
                                $SSsex += $this->_xValues[$xKey] * $this->_xValues[$xKey];
                        }
                }
 
                $this->_SSResiduals = $SSres;
                $this->_DFResiduals = $this->_valueCount - 1 - $const;
 
                if ($this->_DFResiduals == 0.0) {
                        $this->_stdevOfResiduals = 0.0;
                } else {
                        $this->_stdevOfResiduals = sqrt($SSres / $this->_DFResiduals);
                }
                if (($SStot == 0.0) || ($SSres == $SStot)) {
                        $this->_goodnessOfFit = 1;
                } else {
                        $this->_goodnessOfFit = 1 - ($SSres / $SStot);
                }
 
                $this->_SSRegression = $this->_goodnessOfFit * $SStot;
                $this->_covariance = $SScov / $this->_valueCount;
                $this->_correlation = ($this->_valueCount * $sumXY - $sumX * $sumY) / sqrt(($this->_valueCount * $sumX2 - pow($sumX,2)) * ($this->_valueCount * $sumY2 - pow($sumY,2)));
                $this->_slopeSE = $this->_stdevOfResiduals / sqrt($SSsex);
                $this->_intersectSE = $this->_stdevOfResiduals * sqrt(1 / ($this->_valueCount - ($sumX * $sumX) / $sumX2));
                if ($this->_SSResiduals != 0.0) {
                        if ($this->_DFResiduals == 0.0) {
                                $this->_F = 0.0;
                        } else {
                                $this->_F = $this->_SSRegression / ($this->_SSResiduals / $this->_DFResiduals);
                        }
                } else {
                        if ($this->_DFResiduals == 0.0) {
                                $this->_F = 0.0;
                        } else {
                                $this->_F = $this->_SSRegression / $this->_DFResiduals;
                        }
                }
        }       //      function _calculateGoodnessOfFit()

References $_DFResiduals, $_valueCount, and getValueOfYForX().

Referenced by _leastSquareFit(), and PHPExcel_Polynomial_Best_Fit\_polynomial_regression().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _leastSquareFit()

PHPExcel_Best_Fit::_leastSquareFit	(	$yValues,
		$xValues,
		$const
	)

protected

Definition at line 368 of file bestFitClass.php.

                                                                       {
                // calculate sums
                $x_sum = array_sum($xValues);
                $y_sum = array_sum($yValues);
                $meanX = $x_sum / $this->_valueCount;
                $meanY = $y_sum / $this->_valueCount;
                $mBase = $mDivisor = $xx_sum = $xy_sum = $yy_sum = 0.0;
                for($i = 0; $i < $this->_valueCount; ++$i) {
                        $xy_sum += $xValues[$i] * $yValues[$i];
                        $xx_sum += $xValues[$i] * $xValues[$i];
                        $yy_sum += $yValues[$i] * $yValues[$i];
 
                        if ($const) {
                                $mBase += ($xValues[$i] - $meanX) * ($yValues[$i] - $meanY);
                                $mDivisor += ($xValues[$i] - $meanX) * ($xValues[$i] - $meanX);
                        } else {
                                $mBase += $xValues[$i] * $yValues[$i];
                                $mDivisor += $xValues[$i] * $xValues[$i];
                        }
                }
 
                // calculate slope
//              $this->_slope = (($this->_valueCount * $xy_sum) - ($x_sum * $y_sum)) / (($this->_valueCount * $xx_sum) - ($x_sum * $x_sum));
                $this->_slope = $mBase / $mDivisor;
 
                // calculate intersect
//              $this->_intersect = ($y_sum - ($this->_slope * $x_sum)) / $this->_valueCount;
                if ($const) {
                        $this->_intersect = $meanY - ($this->_slope * $meanX);
                } else {
                        $this->_intersect = 0;
                }
 
                $this->_calculateGoodnessOfFit($x_sum,$y_sum,$xx_sum,$yy_sum,$xy_sum,$meanX,$meanY,$const);
        }       //      function _leastSquareFit()

References $_valueCount, $i, and _calculateGoodnessOfFit().

Referenced by PHPExcel_Exponential_Best_Fit\_exponential_regression(), PHPExcel_Linear_Best_Fit\_linear_regression(), PHPExcel_Logarithmic_Best_Fit\_logarithmic_regression(), and PHPExcel_Power_Best_Fit\_power_regression().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBestFitType()

PHPExcel_Best_Fit::getBestFitType ( )

Definition at line 121 of file bestFitClass.php.

                                         {
                return $this->_bestFitType;
        }       //      function getBestFitType()

References $_bestFitType.

◆ getCorrelation()

PHPExcel_Best_Fit::getCorrelation ( $dp = 0 )

Definition at line 301 of file bestFitClass.php.

                                              {
                if ($dp != 0) {
                        return round($this->_correlation,$dp);
                }
                return $this->_correlation;
        }       //      function getCorrelation()

References $_correlation.

◆ getCovariance()

PHPExcel_Best_Fit::getCovariance ( $dp = 0 )

Definition at line 293 of file bestFitClass.php.

                                             {
                if ($dp != 0) {
                        return round($this->_covariance,$dp);
                }
                return $this->_covariance;
        }       //      function getCovariance()

References $_covariance.

◆ getDFResiduals()

PHPExcel_Best_Fit::getDFResiduals ( $dp = 0 )

Definition at line 277 of file bestFitClass.php.

                                              {
                if ($dp != 0) {
                        return round($this->_DFResiduals,$dp);
                }
                return $this->_DFResiduals;
        }       //      function getDFResiduals()

References $_DFResiduals.

◆ getEquation()

PHPExcel_Best_Fit::getEquation ( $dp = 0 )

Return the Equation of the best-fit line.

Parameters

int $dp Number of places of decimal precision to display

Returns: string

Reimplemented in PHPExcel_Exponential_Best_Fit, PHPExcel_Linear_Best_Fit, PHPExcel_Logarithmic_Best_Fit, PHPExcel_Polynomial_Best_Fit, and PHPExcel_Power_Best_Fit.

Definition at line 164 of file bestFitClass.php.

                                           {
                return False;
        }       //      function getEquation()

◆ getError()

PHPExcel_Best_Fit::getError ( )

Definition at line 116 of file bestFitClass.php.

                                   {
                return $this->_error;
        }       //      function getBestFitType()

References $_error.

◆ getF()

PHPExcel_Best_Fit::getF ( $dp = 0 )

Definition at line 285 of file bestFitClass.php.

                                    {
                if ($dp != 0) {
                        return round($this->_F,$dp);
                }
                return $this->_F;
        }       //      function getF()

References $_F.

◆ getGoodnessOfFit()

PHPExcel_Best_Fit::getGoodnessOfFit ( $dp = 0 )

Return the goodness of fit for this regression.

Parameters

int $dp Number of places of decimal precision to return

Returns: float

Definition at line 231 of file bestFitClass.php.

                                                {
                if ($dp != 0) {
                        return round($this->_goodnessOfFit,$dp);
                }
                return $this->_goodnessOfFit;
        }       //      function getGoodnessOfFit()

References $_goodnessOfFit.

Referenced by PHPExcel_Polynomial_Best_Fit\__construct().

Here is the caller graph for this function:

◆ getGoodnessOfFitPercent()

PHPExcel_Best_Fit::getGoodnessOfFitPercent ( $dp = 0 )

Definition at line 239 of file bestFitClass.php.

                                                       {
                if ($dp != 0) {
                        return round($this->_goodnessOfFit * 100,$dp);
                }
                return $this->_goodnessOfFit * 100;
        }       //      function getGoodnessOfFitPercent()

◆ getIntersect()

PHPExcel_Best_Fit::getIntersect ( $dp = 0 )

Return the Value of X where it intersects Y = 0.

Parameters

int $dp Number of places of decimal precision to display

Returns: string

Reimplemented in PHPExcel_Exponential_Best_Fit, and PHPExcel_Power_Best_Fit.

Definition at line 203 of file bestFitClass.php.

                                            {
                if ($dp != 0) {
                        return round($this->_intersect,$dp);
                }
                return $this->_intersect;
        }       //      function getIntersect()

References $_intersect.

Referenced by PHPExcel_Polynomial_Best_Fit\getCoefficients(), PHPExcel_Linear_Best_Fit\getEquation(), PHPExcel_Logarithmic_Best_Fit\getEquation(), PHPExcel_Polynomial_Best_Fit\getEquation(), PHPExcel_Linear_Best_Fit\getValueOfXForY(), PHPExcel_Logarithmic_Best_Fit\getValueOfXForY(), PHPExcel_Polynomial_Best_Fit\getValueOfXForY(), PHPExcel_Linear_Best_Fit\getValueOfYForX(), PHPExcel_Logarithmic_Best_Fit\getValueOfYForX(), and PHPExcel_Polynomial_Best_Fit\getValueOfYForX().

Here is the caller graph for this function:

◆ getIntersectSE()

PHPExcel_Best_Fit::getIntersectSE ( $dp = 0 )

Return the standard error of the Intersect.

Parameters

int $dp Number of places of decimal precision to display

Returns: string

Definition at line 217 of file bestFitClass.php.

                                              {
                if ($dp != 0) {
                        return round($this->_intersectSE,$dp);
                }
                return $this->_intersectSE;
        }       //      function getIntersectSE()

References $_intersectSE.

◆ getSlope()

PHPExcel_Best_Fit::getSlope ( $dp = 0 )

Return the Slope of the line.

Parameters

int $dp Number of places of decimal precision to display

Returns: string

Reimplemented in PHPExcel_Exponential_Best_Fit, and PHPExcel_Polynomial_Best_Fit.

Definition at line 175 of file bestFitClass.php.

                                        {
                if ($dp != 0) {
                        return round($this->_slope,$dp);
                }
                return $this->_slope;
        }       //      function getSlope()

References $_slope.

Referenced by PHPExcel_Linear_Best_Fit\getEquation(), PHPExcel_Logarithmic_Best_Fit\getEquation(), PHPExcel_Power_Best_Fit\getEquation(), PHPExcel_Linear_Best_Fit\getValueOfXForY(), PHPExcel_Logarithmic_Best_Fit\getValueOfXForY(), PHPExcel_Power_Best_Fit\getValueOfXForY(), PHPExcel_Linear_Best_Fit\getValueOfYForX(), PHPExcel_Logarithmic_Best_Fit\getValueOfYForX(), and PHPExcel_Power_Best_Fit\getValueOfYForX().

Here is the caller graph for this function:

◆ getSlopeSE()

PHPExcel_Best_Fit::getSlopeSE ( $dp = 0 )

Return the standard error of the Slope.

Parameters

int $dp Number of places of decimal precision to display

Returns: string

Definition at line 189 of file bestFitClass.php.

                                          {
                if ($dp != 0) {
                        return round($this->_slopeSE,$dp);
                }
                return $this->_slopeSE;
        }       //      function getSlopeSE()

References $_slopeSE.

◆ getSSRegression()

PHPExcel_Best_Fit::getSSRegression ( $dp = 0 )

Definition at line 261 of file bestFitClass.php.

                                               {
                if ($dp != 0) {
                        return round($this->_SSRegression,$dp);
                }
                return $this->_SSRegression;
        }       //      function getSSRegression()

References $_SSRegression.

◆ getSSResiduals()

PHPExcel_Best_Fit::getSSResiduals ( $dp = 0 )

Definition at line 269 of file bestFitClass.php.

                                              {
                if ($dp != 0) {
                        return round($this->_SSResiduals,$dp);
                }
                return $this->_SSResiduals;
        }       //      function getSSResiduals()

References $_SSResiduals.

◆ getStdevOfResiduals()

PHPExcel_Best_Fit::getStdevOfResiduals ( $dp = 0 )

Return the standard deviation of the residuals for this regression.

Parameters

int $dp Number of places of decimal precision to return

Returns: float

Definition at line 253 of file bestFitClass.php.

                                                   {
                if ($dp != 0) {
                        return round($this->_stdevOfResiduals,$dp);
                }
                return $this->_stdevOfResiduals;
        }       //      function getStdevOfResiduals()

References $_stdevOfResiduals.

◆ getValueOfXForY()

PHPExcel_Best_Fit::getValueOfXForY ( $yValue )

Return the X-Value for a specified value of Y.

Parameters

float $yValue Y-Value

Returns: float X-Value

Reimplemented in PHPExcel_Exponential_Best_Fit, PHPExcel_Linear_Best_Fit, PHPExcel_Logarithmic_Best_Fit, PHPExcel_Polynomial_Best_Fit, and PHPExcel_Power_Best_Fit.

Definition at line 143 of file bestFitClass.php.

                                                 {
                return False;
        }       //      function getValueOfXForY()

◆ getValueOfYForX()

PHPExcel_Best_Fit::getValueOfYForX ( $xValue )

Return the Y-Value for a specified value of X.

Parameters

float $xValue X-Value

Returns: float Y-Value

Reimplemented in PHPExcel_Exponential_Best_Fit, PHPExcel_Linear_Best_Fit, PHPExcel_Logarithmic_Best_Fit, PHPExcel_Polynomial_Best_Fit, and PHPExcel_Power_Best_Fit.

Definition at line 132 of file bestFitClass.php.

                                                 {
                return False;
        }       //      function getValueOfYForX()

Referenced by _calculateGoodnessOfFit().

Here is the caller graph for this function:

◆ getXValues()

PHPExcel_Best_Fit::getXValues ( )

Return the original set of X-Values.

Returns: float[] X-Values

Definition at line 153 of file bestFitClass.php.

                                     {
                return $this->_xValues;
        }       //      function getValueOfXForY()

References $_xValues.

◆ getYBestFitValues()

PHPExcel_Best_Fit::getYBestFitValues ( )

Definition at line 309 of file bestFitClass.php.

                                            {
                return $this->_yBestFitValues;
        }       //      function getYBestFitValues()

References $_yBestFitValues.

Field Documentation

◆ $_adjustToZero

PHPExcel_Best_Fit::$_adjustToZero = False

protected

Definition at line 78 of file bestFitClass.php.

◆ $_bestFitType

PHPExcel_Best_Fit::$_bestFitType = 'undetermined'

protected

Definition at line 50 of file bestFitClass.php.

Referenced by getBestFitType().

◆ $_correlation

PHPExcel_Best_Fit::$_correlation = 0

protected

Definition at line 93 of file bestFitClass.php.

Referenced by getCorrelation().

◆ $_covariance

PHPExcel_Best_Fit::$_covariance = 0

protected

Definition at line 91 of file bestFitClass.php.

Referenced by getCovariance().

◆ $_DFResiduals

PHPExcel_Best_Fit::$_DFResiduals = 0

protected

Definition at line 99 of file bestFitClass.php.

Referenced by _calculateGoodnessOfFit(), and getDFResiduals().

◆ $_error

PHPExcel_Best_Fit::$_error = False

protected

Definition at line 43 of file bestFitClass.php.

Referenced by getError().

◆ $_F

PHPExcel_Best_Fit::$_F = 0

protected

Definition at line 101 of file bestFitClass.php.

Referenced by getF().

◆ $_goodnessOfFit

PHPExcel_Best_Fit::$_goodnessOfFit = 1

protected

Definition at line 87 of file bestFitClass.php.

Referenced by getGoodnessOfFit().

◆ $_intersect

PHPExcel_Best_Fit::$_intersect = 0

protected

Definition at line 107 of file bestFitClass.php.

Referenced by getIntersect().

◆ $_intersectSE

PHPExcel_Best_Fit::$_intersectSE = 0

protected

Definition at line 109 of file bestFitClass.php.

Referenced by getIntersectSE().

◆ $_slope

PHPExcel_Best_Fit::$_slope = 0

protected

Definition at line 103 of file bestFitClass.php.

Referenced by getSlope(), and PHPExcel_Polynomial_Best_Fit\getSlope().

◆ $_slopeSE

PHPExcel_Best_Fit::$_slopeSE = 0

protected

Definition at line 105 of file bestFitClass.php.

Referenced by getSlopeSE().

◆ $_SSRegression

PHPExcel_Best_Fit::$_SSRegression = 0

protected

Definition at line 95 of file bestFitClass.php.

Referenced by getSSRegression().

◆ $_SSResiduals

PHPExcel_Best_Fit::$_SSResiduals = 0

protected

Definition at line 97 of file bestFitClass.php.

Referenced by getSSResiduals().

◆ $_stdevOfResiduals

PHPExcel_Best_Fit::$_stdevOfResiduals = 0

protected

Definition at line 89 of file bestFitClass.php.

Referenced by getStdevOfResiduals().

◆ $_valueCount

PHPExcel_Best_Fit::$_valueCount = 0

protected

Definition at line 57 of file bestFitClass.php.

Referenced by _calculateGoodnessOfFit(), _leastSquareFit(), and PHPExcel_Polynomial_Best_Fit\_polynomial_regression().

◆ $_Xoffset

PHPExcel_Best_Fit::$_Xoffset = 0

protected

Definition at line 111 of file bestFitClass.php.

◆ $_xValues

PHPExcel_Best_Fit::$_xValues = array()

protected

Definition at line 64 of file bestFitClass.php.

Referenced by getXValues().

◆ $_yBestFitValues

PHPExcel_Best_Fit::$_yBestFitValues = array()

protected

Definition at line 85 of file bestFitClass.php.

Referenced by getYBestFitValues().

◆ $_Yoffset

PHPExcel_Best_Fit::$_Yoffset = 0

protected

Definition at line 113 of file bestFitClass.php.

◆ $_yValues

PHPExcel_Best_Fit::$_yValues = array()

protected

Definition at line 71 of file bestFitClass.php.

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Shared/trend/bestFitClass.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _calculateGoodnessOfFit()

◆ _leastSquareFit()

◆ getBestFitType()

◆ getCorrelation()

◆ getCovariance()

◆ getDFResiduals()

◆ getEquation()

◆ getError()

◆ getF()

◆ getGoodnessOfFit()

◆ getGoodnessOfFitPercent()

◆ getIntersect()

◆ getIntersectSE()

◆ getSlope()

◆ getSlopeSE()

◆ getSSRegression()

◆ getSSResiduals()

◆ getStdevOfResiduals()

◆ getValueOfXForY()

◆ getValueOfYForX()

◆ getXValues()

◆ getYBestFitValues()

Field Documentation

◆ $_adjustToZero

◆ $_bestFitType

◆ $_correlation

◆ $_covariance

◆ $_DFResiduals

◆ $_error

◆ $_F

◆ $_goodnessOfFit

◆ $_intersect

◆ $_intersectSE

◆ $_slope

◆ $_slopeSE

◆ $_SSRegression

◆ $_SSResiduals

◆ $_stdevOfResiduals

◆ $_valueCount

◆ $_Xoffset

◆ $_xValues

◆ $_yBestFitValues

◆ $_Yoffset

◆ $_yValues