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.

CholeskyDecomposition.html 14 KiB

3 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  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 » \CholeskyDecomposition</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>
  95. <li class="method public "><a href="#method___construct" title="__construct :: CholeskyDecomposition"><span class="description">CholeskyDecomposition</span><pre>__construct()</pre></a></li>
  96. <li class="method public "><a href="#method_getL" title="getL :: getL"><span class="description">getL</span><pre>getL()</pre></a></li>
  97. <li class="method public "><a href="#method_isSPD" title="isSPD :: Is the matrix symmetric and positive definite?"><span class="description">Is the matrix symmetric and positive definite?</span><pre>isSPD()</pre></a></li>
  98. <li class="method public "><a href="#method_solve" title="solve :: Solve A*X = B"><span class="description">Solve A*X = B</span><pre>solve()</pre></a></li>
  99. </ul>
  100. </li>
  101. <li class="nav-header">
  102. <i class="icon-custom icon-property"></i> Properties
  103. <ul></ul>
  104. </li>
  105. <li class="nav-header private">» Private
  106. <ul>
  107. <li class="property private "><a href="#property_L" title="$L :: Decomposition storage"><span class="description"></span><pre>$L</pre></a></li>
  108. <li class="property private "><a href="#property_isspd" title="$isspd :: Symmetric positive definite flag"><span class="description"></span><pre>$isspd</pre></a></li>
  109. <li class="property private "><a href="#property_m" title="$m :: Matrix row and column dimension"><span class="description"></span><pre>$m</pre></a></li>
  110. </ul>
  111. </li>
  112. </ul>
  113. </div>
  114. <div class="span8">
  115. <a id="\CholeskyDecomposition"></a><ul class="breadcrumb">
  116. <li>
  117. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  118. </li>
  119. <li><a href="../namespaces/global.html">global</a></li>
  120. <li class="active">
  121. <span class="divider">\</span><a href="../classes/CholeskyDecomposition.html">CholeskyDecomposition</a>
  122. </li>
  123. </ul>
  124. <div class="element class">
  125. <p class="short_description"></p>
  126. <div class="details">
  127. <div class="long_description"></div>
  128. <table class="table table-bordered">
  129. <tr>
  130. <th>package</th>
  131. <td><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'.%0D%0AIf%20the%20matrix%20is%20not%20symmetric%20or%20positive%20definite,%20the%20constructor%0D%0Areturns%20a%20partial%20decomposition%20and%20sets%20an%20internal%20flag%20that%20may%0D%0Abe%20queried%20by%20the%20isSPD()%20method..html">JAMA
  132. Cholesky decomposition class
  133. For a symmetric, positive definite matrix A, the Cholesky decomposition
  134. is an lower triangular matrix L so that A = L*L'.
  135. If the matrix is not symmetric or positive definite, the constructor
  136. returns a partial decomposition and sets an internal flag that may
  137. be queried by the isSPD() method.</a></td>
  138. </tr>
  139. <tr>
  140. <th>author</th>
  141. <td><a href="">Paul Meagher</a></td>
  142. </tr>
  143. <tr>
  144. <th>author</th>
  145. <td><a href="">Michael Bommarito</a></td>
  146. </tr>
  147. <tr>
  148. <th>version</th>
  149. <td>1.2</td>
  150. </tr>
  151. </table>
  152. <h3>
  153. <i class="icon-custom icon-method"></i> Methods</h3>
  154. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
  155. <h2>CholeskyDecomposition</h2>
  156. <pre>__construct(mixed $A) </pre>
  157. <div class="labels"></div>
  158. <div class="row collapse"><div class="detail-description">
  159. <div class="long_description"><p>Class constructor - decomposes symmetric positive definite matrix</p></div>
  160. <h3>Parameters</h3>
  161. <div class="subelement argument">
  162. <h4>$A</h4>
  163. <code>mixed</code><p>Matrix square symmetric positive definite matrix</p></div>
  164. </div></div>
  165. </div>
  166. <a id="method_getL"></a><div class="element clickable method public method_getL" data-toggle="collapse" data-target=".method_getL .collapse">
  167. <h2>getL</h2>
  168. <pre>getL() : \Matrix</pre>
  169. <div class="labels"></div>
  170. <div class="row collapse"><div class="detail-description">
  171. <div class="long_description"><p>Return triangular factor.</p></div>
  172. <h3>Returns</h3>
  173. <div class="subelement response">
  174. <code>\Matrix</code>Lower triangular matrix</div>
  175. </div></div>
  176. </div>
  177. <a id="method_isSPD"></a><div class="element clickable method public method_isSPD" data-toggle="collapse" data-target=".method_isSPD .collapse">
  178. <h2>Is the matrix symmetric and positive definite?</h2>
  179. <pre>isSPD() : boolean</pre>
  180. <div class="labels"></div>
  181. <div class="row collapse"><div class="detail-description">
  182. <div class="long_description"></div>
  183. <h3>Returns</h3>
  184. <div class="subelement response"><code>boolean</code></div>
  185. </div></div>
  186. </div>
  187. <a id="method_solve"></a><div class="element clickable method public method_solve" data-toggle="collapse" data-target=".method_solve .collapse">
  188. <h2>Solve A*X = B</h2>
  189. <pre>solve($B) : \Matrix</pre>
  190. <div class="labels"></div>
  191. <div class="row collapse"><div class="detail-description">
  192. <div class="long_description"></div>
  193. <h3>Parameters</h3>
  194. <div class="subelement argument">
  195. <h4>$B</h4><p>Row-equal matrix</p>
  196. </div>
  197. <h3>Returns</h3>
  198. <div class="subelement response">
  199. <code>\Matrix</code>L * L' * X = B</div>
  200. </div></div>
  201. </div>
  202. <h3>
  203. <i class="icon-custom icon-property"></i> Properties</h3>
  204. <a id="property_L"> </a><div class="element clickable property private property_L" data-toggle="collapse" data-target=".property_L .collapse">
  205. <h2></h2>
  206. <pre>$L : array</pre>
  207. <div class="labels"></div>
  208. <div class="row collapse"><div class="detail-description">
  209. <div class="long_description"></div>
  210. <table class="table table-bordered"><tr>
  211. <th>access</th>
  212. <td>private</td>
  213. </tr></table>
  214. </div></div>
  215. </div>
  216. <a id="property_isspd"> </a><div class="element clickable property private property_isspd" data-toggle="collapse" data-target=".property_isspd .collapse">
  217. <h2></h2>
  218. <pre>$isspd : boolean</pre>
  219. <div class="labels"></div>
  220. <div class="row collapse"><div class="detail-description">
  221. <div class="long_description"></div>
  222. <table class="table table-bordered"><tr>
  223. <th>access</th>
  224. <td>private</td>
  225. </tr></table>
  226. </div></div>
  227. </div>
  228. <a id="property_m"> </a><div class="element clickable property private property_m" data-toggle="collapse" data-target=".property_m .collapse">
  229. <h2></h2>
  230. <pre>$m : int</pre>
  231. <div class="labels"></div>
  232. <div class="row collapse"><div class="detail-description">
  233. <div class="long_description"></div>
  234. <table class="table table-bordered"><tr>
  235. <th>access</th>
  236. <td>private</td>
  237. </tr></table>
  238. </div></div>
  239. </div>
  240. </div>
  241. </div>
  242. </div>
  243. </div>
  244. <div class="row"><footer class="span12">
  245. 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>
  246. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  247. generated on 2014-03-02T15:27:36Z.<br></footer></div>
  248. </div>
  249. </body>
  250. </html>