class PHPExcel_Polynomial_Best_Fit in Loft Data Grids 6.2

PHPExcel_Polynomial_Best_Fit

@category PHPExcel @package PHPExcel_Shared_Trend @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

Hierarchy

• class \PHPExcel_Best_Fit
  • class \PHPExcel_Polynomial_Best_Fit

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Shared/trend/polynomialBestFitClass.php, line 40

class PHPExcel_Polynomial_Best_Fit extends PHPExcel_Best_Fit {

  /**
   * Algorithm type to use for best-fit
   * (Name of this trend class)
   *
   * @var	string
   **/
  protected $_bestFitType = 'polynomial';

  /**
   * Polynomial order
   *
   * @protected
   * @var	int
   **/
  protected $_order = 0;

  /**
   * Return the order of this polynomial
   *
   * @return	 int
   **/
  public function getOrder() {
    return $this->_order;
  }

  //	function getOrder()

  /**
   * Return the Y-Value for a specified value of X
   *
   * @param	 float		$xValue			X-Value
   * @return	 float						Y-Value
   **/
  public function getValueOfYForX($xValue) {
    $retVal = $this
      ->getIntersect();
    $slope = $this
      ->getSlope();
    foreach ($slope as $key => $value) {
      if ($value != 0.0) {
        $retVal += $value * pow($xValue, $key + 1);
      }
    }
    return $retVal;
  }

  //	function getValueOfYForX()

  /**
   * Return the X-Value for a specified value of Y
   *
   * @param	 float		$yValue			Y-Value
   * @return	 float						X-Value
   **/
  public function getValueOfXForY($yValue) {
    return ($yValue - $this
      ->getIntersect()) / $this
      ->getSlope();
  }

  //	function getValueOfXForY()

  /**
   * Return the Equation of the best-fit line
   *
   * @param	 int		$dp		Number of places of decimal precision to display
   * @return	 string
   **/
  public function getEquation($dp = 0) {
    $slope = $this
      ->getSlope($dp);
    $intersect = $this
      ->getIntersect($dp);
    $equation = 'Y = ' . $intersect;
    foreach ($slope as $key => $value) {
      if ($value != 0.0) {
        $equation .= ' + ' . $value . ' * X';
        if ($key > 0) {
          $equation .= '^' . ($key + 1);
        }
      }
    }
    return $equation;
  }

  //	function getEquation()

  /**
   * Return the Slope of the line
   *
   * @param	 int		$dp		Number of places of decimal precision to display
   * @return	 string
   **/
  public function getSlope($dp = 0) {
    if ($dp != 0) {
      $coefficients = array();
      foreach ($this->_slope as $coefficient) {
        $coefficients[] = round($coefficient, $dp);
      }
      return $coefficients;
    }
    return $this->_slope;
  }

  //	function getSlope()
  public function getCoefficients($dp = 0) {
    return array_merge(array(
      $this
        ->getIntersect($dp),
    ), $this
      ->getSlope($dp));
  }

  //	function getCoefficients()

  /**
   * Execute the regression and calculate the goodness of fit for a set of X and Y data values
   *
   * @param	int			$order		Order of Polynomial for this regression
   * @param	float[]		$yValues	The set of Y-values for this regression
   * @param	float[]		$xValues	The set of X-values for this regression
   * @param	boolean		$const
   */
  private function _polynomial_regression($order, $yValues, $xValues, $const) {

    // calculate sums
    $x_sum = array_sum($xValues);
    $y_sum = array_sum($yValues);
    $xx_sum = $xy_sum = 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];
    }

    /*
     *	This routine uses logic from the PHP port of polyfit version 0.1
     *	written by Michael Bommarito and Paul Meagher
     *
     *	The function fits a polynomial function of order $order through
     *	a series of x-y data points using least squares.
     *
     */
    for ($i = 0; $i < $this->_valueCount; ++$i) {
      for ($j = 0; $j <= $order; ++$j) {
        $A[$i][$j] = pow($xValues[$i], $j);
      }
    }
    for ($i = 0; $i < $this->_valueCount; ++$i) {
      $B[$i] = array(
        $yValues[$i],
      );
    }
    $matrixA = new Matrix($A);
    $matrixB = new Matrix($B);
    $C = $matrixA
      ->solve($matrixB);
    $coefficients = array();
    for ($i = 0; $i < $C->m; ++$i) {
      $r = $C
        ->get($i, 0);
      if (abs($r) <= pow(10, -9)) {
        $r = 0;
      }
      $coefficients[] = $r;
    }
    $this->_intersect = array_shift($coefficients);
    $this->_slope = $coefficients;
    $this
      ->_calculateGoodnessOfFit($x_sum, $y_sum, $xx_sum, $yy_sum, $xy_sum);
    foreach ($this->_xValues as $xKey => $xValue) {
      $this->_yBestFitValues[$xKey] = $this
        ->getValueOfYForX($xValue);
    }
  }

  //	function _polynomial_regression()

  /**
   * Define the regression and calculate the goodness of fit for a set of X and Y data values
   *
   * @param	int			$order		Order of Polynomial for this regression
   * @param	float[]		$yValues	The set of Y-values for this regression
   * @param	float[]		$xValues	The set of X-values for this regression
   * @param	boolean		$const
   */
  function __construct($order, $yValues, $xValues = array(), $const = True) {
    if (parent::__construct($yValues, $xValues) !== False) {
      if ($order < $this->_valueCount) {
        $this->_bestFitType .= '_' . $order;
        $this->_order = $order;
        $this
          ->_polynomial_regression($order, $yValues, $xValues, $const);
        if ($this
          ->getGoodnessOfFit() < 0.0 || $this
          ->getGoodnessOfFit() > 1.0) {
          $this->_error = True;
        }
      }
      else {
        $this->_error = True;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPExcel_Best_Fit::$_adjustToZero	protected	property	* Flag indicating whether values should be adjusted to Y=0 * * *
PHPExcel_Best_Fit::$_correlation	protected	property
PHPExcel_Best_Fit::$_covariance	protected	property
PHPExcel_Best_Fit::$_DFResiduals	protected	property
PHPExcel_Best_Fit::$_error	protected	property	* Indicator flag for a calculation error * * *
PHPExcel_Best_Fit::$_F	protected	property
PHPExcel_Best_Fit::$_goodnessOfFit	protected	property
PHPExcel_Best_Fit::$_intersect	protected	property
PHPExcel_Best_Fit::$_intersectSE	protected	property
PHPExcel_Best_Fit::$_slope	protected	property
PHPExcel_Best_Fit::$_slopeSE	protected	property
PHPExcel_Best_Fit::$_SSRegression	protected	property
PHPExcel_Best_Fit::$_SSResiduals	protected	property
PHPExcel_Best_Fit::$_stdevOfResiduals	protected	property
PHPExcel_Best_Fit::$_valueCount	protected	property	* Number of entries in the sets of x- and y-value arrays * * *
PHPExcel_Best_Fit::$_Xoffset	protected	property
PHPExcel_Best_Fit::$_xValues	protected	property	* X-value dataseries of values * * *
PHPExcel_Best_Fit::$_yBestFitValues	protected	property	* Y-value series of best-fit values * * *
PHPExcel_Best_Fit::$_Yoffset	protected	property
PHPExcel_Best_Fit::$_yValues	protected	property	* Y-value dataseries of values * * *
PHPExcel_Best_Fit::getBestFitType	public	function
PHPExcel_Best_Fit::getCorrelation	public	function
PHPExcel_Best_Fit::getCovariance	public	function
PHPExcel_Best_Fit::getDFResiduals	public	function
PHPExcel_Best_Fit::getError	public	function
PHPExcel_Best_Fit::getF	public	function
PHPExcel_Best_Fit::getGoodnessOfFit	public	function	* Return the goodness of fit for this regression * *
PHPExcel_Best_Fit::getGoodnessOfFitPercent	public	function
PHPExcel_Best_Fit::getIntersect	public	function	* Return the Value of X where it intersects Y = 0 * *	2
PHPExcel_Best_Fit::getIntersectSE	public	function	* Return the standard error of the Intersect * *
PHPExcel_Best_Fit::getSlopeSE	public	function	* Return the standard error of the Slope * *
PHPExcel_Best_Fit::getSSRegression	public	function
PHPExcel_Best_Fit::getSSResiduals	public	function
PHPExcel_Best_Fit::getStdevOfResiduals	public	function	* Return the standard deviation of the residuals for this regression * *
PHPExcel_Best_Fit::getXValues	public	function	* Return the original set of X-Values * *
PHPExcel_Best_Fit::getYBestFitValues	public	function
PHPExcel_Best_Fit::_calculateGoodnessOfFit	protected	function
PHPExcel_Best_Fit::_leastSquareFit	protected	function
PHPExcel_Polynomial_Best_Fit::$_bestFitType	protected	property	* Algorithm type to use for best-fit * (Name of this trend class) * * * Overrides PHPExcel_Best_Fit::$_bestFitType
PHPExcel_Polynomial_Best_Fit::$_order	protected	property	* Polynomial order * * @protected * *
PHPExcel_Polynomial_Best_Fit::getCoefficients	public	function
PHPExcel_Polynomial_Best_Fit::getEquation	public	function	* Return the Equation of the best-fit line * * Overrides PHPExcel_Best_Fit::getEquation
PHPExcel_Polynomial_Best_Fit::getOrder	public	function	* Return the order of this polynomial * *
PHPExcel_Polynomial_Best_Fit::getSlope	public	function	* Return the Slope of the line * * Overrides PHPExcel_Best_Fit::getSlope
PHPExcel_Polynomial_Best_Fit::getValueOfXForY	public	function	* Return the X-Value for a specified value of Y * * Overrides PHPExcel_Best_Fit::getValueOfXForY
PHPExcel_Polynomial_Best_Fit::getValueOfYForX	public	function	* Return the Y-Value for a specified value of X * * Overrides PHPExcel_Best_Fit::getValueOfYForX
PHPExcel_Polynomial_Best_Fit::_polynomial_regression	private	function	* Execute the regression and calculate the goodness of fit for a set of X and Y data values * *
PHPExcel_Polynomial_Best_Fit::__construct		function	* Define the regression and calculate the goodness of fit for a set of X and Y data values * * Overrides PHPExcel_Best_Fit::__construct