You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

269 lines
17 KiB

  1. <!DOCTYPE html><html lang="en">
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  5. <meta charset="utf-8">
  6. <title>PHPExcel classes » \trendClass</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">PHPExcel classes</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Packages</a></li>
  23. <li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
  24. <li><a href="../packages/JAMA.html"><i class="icon-folder-open"></i> JAMA</a></li>
  25. <li><a href="../packages/JAMA%0D%0ACholesky%20decomposition%20class%0D%0AFor%20a%20symmetric,%20positive%20definite%20matrix%20A,%20the%20Cholesky%20decomposition%0D%0Ais%20an%20lower%20triangular%20matrix%20L%20so%20that%20A%20=%20L*L'.html"><i class="icon-folder-open"></i> JAMA
  26. Cholesky decomposition class
  27. For a symmetric, positive definite matrix A, the Cholesky decomposition
  28. is an lower triangular matrix L so that A = L*L'</a></li>
  29. <li><a href="../packages/JAMA%0D%0AClass%20to%20obtain%20eigenvalues%20and%20eigenvectors%20of%20a%20real%20matrix.html"><i class="icon-folder-open"></i> JAMA
  30. Class to obtain eigenvalues and eigenvectors of a real matrix</a></li>
  31. <li><a href="../packages/JAMA%0D%0AError%20handling.html"><i class="icon-folder-open"></i> JAMA
  32. Error handling</a></li>
  33. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20LU%20decomposition%20is%20an%20m-by-n%0D%0Aunit%20lower%20triangular%20matrix%20L,%20an%20n-by-n%20upper%20triangular%20matrix%20U,%0D%0Aand%20a%20permutation%20vector%20piv%20of%20length%20m%20so%20that%20A(piv,:)%20=%20L*U.html"><i class="icon-folder-open"></i> JAMA
  34. For an m-by-n matrix A with m &gt;= n, the LU decomposition is an m-by-n
  35. unit lower triangular matrix L, an n-by-n upper triangular matrix U,
  36. and a permutation vector piv of length m so that A(piv,:) = L*U</a></li>
  37. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20QR%20decomposition%20is%20an%20m-by-n%0D%0Aorthogonal%20matrix%20Q%20and%20an%20n-by-n%20upper%20triangular%20matrix%20R%20so%20that%0D%0AA%20=%20Q*R.html"><i class="icon-folder-open"></i> JAMA
  38. For an m-by-n matrix A with m &gt;= n, the QR decomposition is an m-by-n
  39. orthogonal matrix Q and an n-by-n upper triangular matrix R so that
  40. A = Q*R</a></li>
  41. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20singular%20value%20decomposition%20is%0D%0Aan%20m-by-n%20orthogonal%20matrix%20U,%20an%20n-by-n%20diagonal%20matrix%20S,%20and%0D%0Aan%20n-by-n%20orthogonal%20matrix%20V%20so%20that%20A%20=%20U*S*V'.html"><i class="icon-folder-open"></i> JAMA
  42. For an m-by-n matrix A with m &gt;= n, the singular value decomposition is
  43. an m-by-n orthogonal matrix U, an n-by-n diagonal matrix S, and
  44. an n-by-n orthogonal matrix V so that A = U*S*V'</a></li>
  45. <li><a href="../packages/JAMA%0D%0APythagorean%20Theorem:%0D%0Aa%20=%203%0D%0Ab%20=%204%0D%0Ar%20=%20sqrt(square(a)%20+%20square(b))%0D%0Ar%20=%205%0D%0Ar%20=%20sqrt(a%5E2%20+%20b%5E2)%20without%20under.overflow.html"><i class="icon-folder-open"></i> JAMA
  46. Pythagorean Theorem:
  47. a = 3
  48. b = 4
  49. r = sqrt(square(a) + square(b))
  50. r = 5
  51. r = sqrt(a^2 + b^2) without under/overflow</a></li>
  52. <li><a href="../packages/PHPExcel.html"><i class="icon-folder-open"></i> PHPExcel</a></li>
  53. </ul>
  54. </li>
  55. <li class="dropdown" id="charts-menu">
  56. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  57. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  58. </li>
  59. <li class="dropdown" id="reports-menu">
  60. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  61. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  62. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  63. <span class="label label-info">551</span></a></li>
  64. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  65. <ul>
  66. <li>todo 
  67. <span class="label label-info">19</span>
  68. </li>
  69. <li>fixme 
  70. <span class="label label-info">10</span>
  71. </li>
  72. </ul></a></li>
  73. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  74. <span class="label label-info">12</span></a></li>
  75. </ul>
  76. </li>
  77. </ul></div>
  78. </div></div>
  79. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  80. </div>
  81. <div id="___" class="container">
  82. <noscript><div class="alert alert-warning">
  83. Javascript is disabled; several features are only available
  84. if Javascript is enabled.
  85. </div></noscript>
  86. <div class="row">
  87. <div class="span4">
  88. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  89. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  90. </div>
  91. <ul class="side-nav nav nav-list">
  92. <li class="nav-header">
  93. <i class="icon-custom icon-method"></i> Methods
  94. <ul><li class="method public "><a href="#method_calculate" title="calculate :: "><span class="description">calculate()
  95. </span><pre>calculate()</pre></a></li></ul>
  96. </li>
  97. <li class="nav-header">
  98. <i class="icon-custom icon-property"></i> Properties
  99. <ul></ul>
  100. </li>
  101. <li class="nav-header private">» Private
  102. <ul>
  103. <li class="property private "><a href="#property__trendCache" title="$_trendCache :: Cached results for each method when trying to identify which provides the best fit"><span class="description"></span><pre>$_trendCache</pre></a></li>
  104. <li class="property private "><a href="#property__trendTypePolyOrders" title="$_trendTypePolyOrders :: Names of the best-fit trend polynomial orders"><span class="description"></span><pre>$_trendTypePolyOrders</pre></a></li>
  105. <li class="property private "><a href="#property__trendTypes" title="$_trendTypes :: Names of the best-fit trend analysis methods"><span class="description"></span><pre>$_trendTypes</pre></a></li>
  106. </ul>
  107. </li>
  108. <li class="nav-header">
  109. <i class="icon-custom icon-constant"></i> Constants
  110. <ul>
  111. <li class="constant "><a href="#constant_TREND_BEST_FIT" title="TREND_BEST_FIT :: "><span class="description">TREND_BEST_FIT</span><pre>TREND_BEST_FIT</pre></a></li>
  112. <li class="constant "><a href="#constant_TREND_BEST_FIT_NO_POLY" title="TREND_BEST_FIT_NO_POLY :: "><span class="description">TREND_BEST_FIT_NO_POLY</span><pre>TREND_BEST_FIT_NO_POLY</pre></a></li>
  113. <li class="constant "><a href="#constant_TREND_EXPONENTIAL" title="TREND_EXPONENTIAL :: "><span class="description">TREND_EXPONENTIAL</span><pre>TREND_EXPONENTIAL</pre></a></li>
  114. <li class="constant "><a href="#constant_TREND_LINEAR" title="TREND_LINEAR :: "><span class="description">TREND_LINEAR</span><pre>TREND_LINEAR</pre></a></li>
  115. <li class="constant "><a href="#constant_TREND_LOGARITHMIC" title="TREND_LOGARITHMIC :: "><span class="description">TREND_LOGARITHMIC</span><pre>TREND_LOGARITHMIC</pre></a></li>
  116. <li class="constant "><a href="#constant_TREND_POLYNOMIAL_2" title="TREND_POLYNOMIAL_2 :: "><span class="description">TREND_POLYNOMIAL_2</span><pre>TREND_POLYNOMIAL_2</pre></a></li>
  117. <li class="constant "><a href="#constant_TREND_POLYNOMIAL_3" title="TREND_POLYNOMIAL_3 :: "><span class="description">TREND_POLYNOMIAL_3</span><pre>TREND_POLYNOMIAL_3</pre></a></li>
  118. <li class="constant "><a href="#constant_TREND_POLYNOMIAL_4" title="TREND_POLYNOMIAL_4 :: "><span class="description">TREND_POLYNOMIAL_4</span><pre>TREND_POLYNOMIAL_4</pre></a></li>
  119. <li class="constant "><a href="#constant_TREND_POLYNOMIAL_5" title="TREND_POLYNOMIAL_5 :: "><span class="description">TREND_POLYNOMIAL_5</span><pre>TREND_POLYNOMIAL_5</pre></a></li>
  120. <li class="constant "><a href="#constant_TREND_POLYNOMIAL_6" title="TREND_POLYNOMIAL_6 :: "><span class="description">TREND_POLYNOMIAL_6</span><pre>TREND_POLYNOMIAL_6</pre></a></li>
  121. <li class="constant "><a href="#constant_TREND_POWER" title="TREND_POWER :: "><span class="description">TREND_POWER</span><pre>TREND_POWER</pre></a></li>
  122. </ul>
  123. </li>
  124. </ul>
  125. </div>
  126. <div class="span8">
  127. <a id="\trendClass"></a><ul class="breadcrumb">
  128. <li>
  129. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  130. </li>
  131. <li><a href="../namespaces/global.html">global</a></li>
  132. <li class="active">
  133. <span class="divider">\</span><a href="../classes/trendClass.html">trendClass</a>
  134. </li>
  135. </ul>
  136. <div class="element class">
  137. <p class="short_description">PHPExcel_trendClass</p>
  138. <div class="details">
  139. <div class="long_description"></div>
  140. <table class="table table-bordered">
  141. <tr>
  142. <th>category</th>
  143. <td>PHPExcel</td>
  144. </tr>
  145. <tr>
  146. <th>package</th>
  147. <td><a href="../packages/PHPExcel.Shared.Trend.html">PHPExcel_Shared_Trend</a></td>
  148. </tr>
  149. <tr>
  150. <th>copyright</th>
  151. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>
  152. </tr>
  153. </table>
  154. <h3>
  155. <i class="icon-custom icon-method"></i> Methods</h3>
  156. <a id="method_calculate"></a><div class="element clickable method public method_calculate" data-toggle="collapse" data-target=".method_calculate .collapse">
  157. <h2>calculate()
  158. </h2>
  159. <pre>calculate($trendType, $yValues, $xValues, $const) </pre>
  160. <div class="labels"><span class="label">Static</span></div>
  161. <div class="row collapse"><div class="detail-description">
  162. <div class="long_description"></div>
  163. <h3>Parameters</h3>
  164. <div class="subelement argument"><h4>$trendType</h4></div>
  165. <div class="subelement argument"><h4>$yValues</h4></div>
  166. <div class="subelement argument"><h4>$xValues</h4></div>
  167. <div class="subelement argument"><h4>$const</h4></div>
  168. </div></div>
  169. </div>
  170. <h3>
  171. <i class="icon-custom icon-property"></i> Properties</h3>
  172. <a id="property__trendCache"> </a><div class="element clickable property private property__trendCache" data-toggle="collapse" data-target=".property__trendCache .collapse">
  173. <h2></h2>
  174. <pre>$_trendCache : <a href="PHPExcel.Shared.trend.bestFitClass.html#%5CPHPExcel_Best_Fit">\PHPExcel_Best_Fit[]</a></pre>
  175. <div class="labels"></div>
  176. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  177. </div>
  178. <a id="property__trendTypePolyOrders"> </a><div class="element clickable property private property__trendTypePolyOrders" data-toggle="collapse" data-target=".property__trendTypePolyOrders .collapse">
  179. <h2></h2>
  180. <pre>$_trendTypePolyOrders : string[]</pre>
  181. <div class="labels"></div>
  182. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  183. </div>
  184. <a id="property__trendTypes"> </a><div class="element clickable property private property__trendTypes" data-toggle="collapse" data-target=".property__trendTypes .collapse">
  185. <h2></h2>
  186. <pre>$_trendTypes : string[]</pre>
  187. <div class="labels"></div>
  188. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  189. </div>
  190. <h3>
  191. <i class="icon-custom icon-constant"></i> Constants</h3>
  192. <a id="constant_TREND_BEST_FIT"> </a><div class="element clickable constant constant_TREND_BEST_FIT" data-toggle="collapse" data-target=".constant_TREND_BEST_FIT .collapse">
  193. <h2>TREND_BEST_FIT</h2>
  194. <pre>TREND_BEST_FIT </pre>
  195. <div class="labels"></div>
  196. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  197. </div>
  198. <a id="constant_TREND_BEST_FIT_NO_POLY"> </a><div class="element clickable constant constant_TREND_BEST_FIT_NO_POLY" data-toggle="collapse" data-target=".constant_TREND_BEST_FIT_NO_POLY .collapse">
  199. <h2>TREND_BEST_FIT_NO_POLY</h2>
  200. <pre>TREND_BEST_FIT_NO_POLY </pre>
  201. <div class="labels"></div>
  202. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  203. </div>
  204. <a id="constant_TREND_EXPONENTIAL"> </a><div class="element clickable constant constant_TREND_EXPONENTIAL" data-toggle="collapse" data-target=".constant_TREND_EXPONENTIAL .collapse">
  205. <h2>TREND_EXPONENTIAL</h2>
  206. <pre>TREND_EXPONENTIAL </pre>
  207. <div class="labels"></div>
  208. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  209. </div>
  210. <a id="constant_TREND_LINEAR"> </a><div class="element clickable constant constant_TREND_LINEAR" data-toggle="collapse" data-target=".constant_TREND_LINEAR .collapse">
  211. <h2>TREND_LINEAR</h2>
  212. <pre>TREND_LINEAR </pre>
  213. <div class="labels"></div>
  214. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  215. </div>
  216. <a id="constant_TREND_LOGARITHMIC"> </a><div class="element clickable constant constant_TREND_LOGARITHMIC" data-toggle="collapse" data-target=".constant_TREND_LOGARITHMIC .collapse">
  217. <h2>TREND_LOGARITHMIC</h2>
  218. <pre>TREND_LOGARITHMIC </pre>
  219. <div class="labels"></div>
  220. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  221. </div>
  222. <a id="constant_TREND_POLYNOMIAL_2"> </a><div class="element clickable constant constant_TREND_POLYNOMIAL_2" data-toggle="collapse" data-target=".constant_TREND_POLYNOMIAL_2 .collapse">
  223. <h2>TREND_POLYNOMIAL_2</h2>
  224. <pre>TREND_POLYNOMIAL_2 </pre>
  225. <div class="labels"></div>
  226. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  227. </div>
  228. <a id="constant_TREND_POLYNOMIAL_3"> </a><div class="element clickable constant constant_TREND_POLYNOMIAL_3" data-toggle="collapse" data-target=".constant_TREND_POLYNOMIAL_3 .collapse">
  229. <h2>TREND_POLYNOMIAL_3</h2>
  230. <pre>TREND_POLYNOMIAL_3 </pre>
  231. <div class="labels"></div>
  232. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  233. </div>
  234. <a id="constant_TREND_POLYNOMIAL_4"> </a><div class="element clickable constant constant_TREND_POLYNOMIAL_4" data-toggle="collapse" data-target=".constant_TREND_POLYNOMIAL_4 .collapse">
  235. <h2>TREND_POLYNOMIAL_4</h2>
  236. <pre>TREND_POLYNOMIAL_4 </pre>
  237. <div class="labels"></div>
  238. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  239. </div>
  240. <a id="constant_TREND_POLYNOMIAL_5"> </a><div class="element clickable constant constant_TREND_POLYNOMIAL_5" data-toggle="collapse" data-target=".constant_TREND_POLYNOMIAL_5 .collapse">
  241. <h2>TREND_POLYNOMIAL_5</h2>
  242. <pre>TREND_POLYNOMIAL_5 </pre>
  243. <div class="labels"></div>
  244. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  245. </div>
  246. <a id="constant_TREND_POLYNOMIAL_6"> </a><div class="element clickable constant constant_TREND_POLYNOMIAL_6" data-toggle="collapse" data-target=".constant_TREND_POLYNOMIAL_6 .collapse">
  247. <h2>TREND_POLYNOMIAL_6</h2>
  248. <pre>TREND_POLYNOMIAL_6 </pre>
  249. <div class="labels"></div>
  250. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  251. </div>
  252. <a id="constant_TREND_POWER"> </a><div class="element clickable constant constant_TREND_POWER" data-toggle="collapse" data-target=".constant_TREND_POWER .collapse">
  253. <h2>TREND_POWER</h2>
  254. <pre>TREND_POWER </pre>
  255. <div class="labels"></div>
  256. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  257. </div>
  258. </div>
  259. </div>
  260. </div>
  261. </div>
  262. <div class="row"><footer class="span12">
  263. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
  264. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  265. generated on 2014-03-02T15:27:37Z.<br></footer></div>
  266. </div>
  267. </body>
  268. </html>