chillerlan-QRCode-Common-ReedSolomonDecoder.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
  56. <ul class="phpdocumentor-list">
  57. <li>
  58. <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
  59. </li>
  60. <li>
  61. <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
  62. </li>
  63. </ul>
  64. </section>
  65. <section class="phpdocumentor-sidebar__category">
  66. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  67. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
  68. </section>
  69. <section class="phpdocumentor-sidebar__category">
  70. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  71. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  74. </section>
  75. <section class="phpdocumentor-sidebar__category">
  76. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  78. </section>
  79. </aside>
  80. <div class="phpdocumentor-column -eight phpdocumentor-content">
  81. <ul class="phpdocumentor-breadcrumbs">
  82. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  84. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-common.html">Common</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. ReedSolomonDecoder
  89. <div class="phpdocumentor-element__package">
  90. in package
  91. <ul class="phpdocumentor-breadcrumbs">
  92. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  93. </ul>
  94. </div>
  95. </h2>
  96. <aside class="phpdocumentor-element-found-in">
  97. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonDecoder.php"><a href="files/src-common-reedsolomondecoder.html"><abbr title="src/Common/ReedSolomonDecoder.php">ReedSolomonDecoder.php</abbr></a></abbr>
  98. :
  99. <span class="phpdocumentor-element-found-in__line">39</span>
  100. </aside>
  101. <p class="phpdocumentor-summary">Implements Reed-Solomon decoding, as the name implies.</p>
  102. <section class="phpdocumentor-description"><p>The algorithm will not be explained here, but the following references were helpful
  103. in creating this implementation:</p>
  104. <ul>
  105. <li>Bruce Maggs.
  106. <a href="http://www.cs.cmu.edu/afs/cs.cmu.edu/project/pscico-guyb/realworld/www/rs_decode.ps">
  107. "Decoding Reed-Solomon Codes"</a> (see discussion of Forney's Formula)</li>
  108. <li>J.I. Hall. <a href="www.mth.msu.edu/~jhall/classes/codenotes/GRS.pdf">
  109. "Chapter 5. Generalized Reed-Solomon Codes"</a>
  110. (see discussion of Euclidean algorithm)</li>
  111. </ul>
  112. <p>Much credit is due to William Rucklidge since portions of this code are an indirect
  113. port of his C++ Reed-Solomon implementation.</p>
  114. </section>
  115. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  116. Tags
  117. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  118. </h5>
  119. <dl class="phpdocumentor-tag-list">
  120. <dt class="phpdocumentor-tag-list__entry">
  121. <span class="phpdocumentor-tag__name">author</span>
  122. </dt>
  123. <dd class="phpdocumentor-tag-list__definition">
  124. <section class="phpdocumentor-description"><p>Sean Owen</p>
  125. </section>
  126. </dd>
  127. <dt class="phpdocumentor-tag-list__entry">
  128. <span class="phpdocumentor-tag__name">author</span>
  129. </dt>
  130. <dd class="phpdocumentor-tag-list__definition">
  131. <section class="phpdocumentor-description"><p>William Rucklidge</p>
  132. </section>
  133. </dd>
  134. <dt class="phpdocumentor-tag-list__entry">
  135. <span class="phpdocumentor-tag__name">author</span>
  136. </dt>
  137. <dd class="phpdocumentor-tag-list__definition">
  138. <section class="phpdocumentor-description"><p>sanfordsquires</p>
  139. </section>
  140. </dd>
  141. </dl>
  142. <h3 id="toc">
  143. Table of Contents
  144. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  145. </h3>
  146. <dl class="phpdocumentor-table-of-contents">
  147. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  148. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_decode">decode()</a>
  149. <span>
  150. &nbsp;: array&lt;string|int, int&gt; </span>
  151. </dt>
  152. <dd>Decodes given set of received codewords, which include both data and error-correction
  153. codewords. Really, this means it uses Reed-Solomon to detect and correct errors, in-place,
  154. in the input.</dd>
  155. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  156. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_findErrorLocations">findErrorLocations()</a>
  157. <span>
  158. &nbsp;: array&lt;string|int, mixed&gt; </span>
  159. </dt>
  160. <dd></dd>
  161. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  162. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_findErrorMagnitudes">findErrorMagnitudes()</a>
  163. <span>
  164. &nbsp;: array&lt;string|int, mixed&gt; </span>
  165. </dt>
  166. <dd></dd>
  167. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  168. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_runEuclideanAlgorithm">runEuclideanAlgorithm()</a>
  169. <span>
  170. &nbsp;: array&lt;string|int, <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a>&gt; </span>
  171. </dt>
  172. <dd></dd>
  173. </dl>
  174. <section class="phpdocumentor-methods">
  175. <h3 class="phpdocumentor-elements__header" id="methods">
  176. Methods
  177. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  178. </h3>
  179. <article
  180. class="phpdocumentor-element
  181. -method
  182. -public
  183. "
  184. >
  185. <h4 class="phpdocumentor-element__name" id="method_decode">
  186. decode()
  187. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_decode" class="headerlink"><i class="fas fa-link"></i></a>
  188. </h4>
  189. <aside class="phpdocumentor-element-found-in">
  190. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonDecoder.php"><a href="files/src-common-reedsolomondecoder.html"><abbr title="src/Common/ReedSolomonDecoder.php">ReedSolomonDecoder.php</abbr></a></abbr>
  191. :
  192. <span class="phpdocumentor-element-found-in__line">52</span>
  193. </aside>
  194. <p class="phpdocumentor-summary">Decodes given set of received codewords, which include both data and error-correction
  195. codewords. Really, this means it uses Reed-Solomon to detect and correct errors, in-place,
  196. in the input.</p>
  197. <code class="phpdocumentor-code phpdocumentor-signature ">
  198. <span class="phpdocumentor-signature__visibility">public</span>
  199. <span class="phpdocumentor-signature__name">decode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$received</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$numEccCodewords</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, int&gt;</span></code>
  200. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  201. <dl class="phpdocumentor-argument-list">
  202. <dt class="phpdocumentor-argument-list__entry">
  203. <span class="phpdocumentor-signature__argument__name">$received</span>
  204. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  205. </dt>
  206. <dd class="phpdocumentor-argument-list__definition">
  207. <section class="phpdocumentor-description"><p>data and error-correction codewords</p>
  208. </section>
  209. </dd>
  210. <dt class="phpdocumentor-argument-list__entry">
  211. <span class="phpdocumentor-signature__argument__name">$numEccCodewords</span>
  212. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  213. </dt>
  214. <dd class="phpdocumentor-argument-list__definition">
  215. <section class="phpdocumentor-description"><p>number of error-correction codewords available</p>
  216. </section>
  217. </dd>
  218. </dl>
  219. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  220. Tags
  221. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  222. </h5>
  223. <dl class="phpdocumentor-tag-list">
  224. <dt class="phpdocumentor-tag-list__entry">
  225. <span class="phpdocumentor-tag__name">throws</span>
  226. </dt>
  227. <dd class="phpdocumentor-tag-list__definition">
  228. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  229. <section class="phpdocumentor-description"><p>if decoding fails for any reason</p>
  230. </section>
  231. </dd>
  232. </dl>
  233. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  234. <span class="phpdocumentor-signature__response_type">array&lt;string|int, int&gt;</span>
  235. &mdash;
  236. </article>
  237. <article
  238. class="phpdocumentor-element
  239. -method
  240. -private
  241. "
  242. >
  243. <h4 class="phpdocumentor-element__name" id="method_findErrorLocations">
  244. findErrorLocations()
  245. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_findErrorLocations" class="headerlink"><i class="fas fa-link"></i></a>
  246. </h4>
  247. <aside class="phpdocumentor-element-found-in">
  248. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonDecoder.php"><a href="files/src-common-reedsolomondecoder.html"><abbr title="src/Common/ReedSolomonDecoder.php">ReedSolomonDecoder.php</abbr></a></abbr>
  249. :
  250. <span class="phpdocumentor-element-found-in__line">142</span>
  251. </aside>
  252. <code class="phpdocumentor-code phpdocumentor-signature ">
  253. <span class="phpdocumentor-signature__visibility">private</span>
  254. <span class="phpdocumentor-signature__name">findErrorLocations</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errorLocator</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  255. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  256. <dl class="phpdocumentor-argument-list">
  257. <dt class="phpdocumentor-argument-list__entry">
  258. <span class="phpdocumentor-signature__argument__name">$errorLocator</span>
  259. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a></span>
  260. </dt>
  261. <dd class="phpdocumentor-argument-list__definition">
  262. <section class="phpdocumentor-description"></section>
  263. </dd>
  264. </dl>
  265. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  266. Tags
  267. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  268. </h5>
  269. <dl class="phpdocumentor-tag-list">
  270. <dt class="phpdocumentor-tag-list__entry">
  271. <span class="phpdocumentor-tag__name">throws</span>
  272. </dt>
  273. <dd class="phpdocumentor-tag-list__definition">
  274. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  275. </dd>
  276. </dl>
  277. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  278. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  279. &mdash;
  280. </article>
  281. <article
  282. class="phpdocumentor-element
  283. -method
  284. -private
  285. "
  286. >
  287. <h4 class="phpdocumentor-element__name" id="method_findErrorMagnitudes">
  288. findErrorMagnitudes()
  289. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_findErrorMagnitudes" class="headerlink"><i class="fas fa-link"></i></a>
  290. </h4>
  291. <aside class="phpdocumentor-element-found-in">
  292. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonDecoder.php"><a href="files/src-common-reedsolomondecoder.html"><abbr title="src/Common/ReedSolomonDecoder.php">ReedSolomonDecoder.php</abbr></a></abbr>
  293. :
  294. <span class="phpdocumentor-element-found-in__line">170</span>
  295. </aside>
  296. <code class="phpdocumentor-code phpdocumentor-signature ">
  297. <span class="phpdocumentor-signature__visibility">private</span>
  298. <span class="phpdocumentor-signature__name">findErrorMagnitudes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errorEvaluator</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errorLocations</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  299. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  300. <dl class="phpdocumentor-argument-list">
  301. <dt class="phpdocumentor-argument-list__entry">
  302. <span class="phpdocumentor-signature__argument__name">$errorEvaluator</span>
  303. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a></span>
  304. </dt>
  305. <dd class="phpdocumentor-argument-list__definition">
  306. <section class="phpdocumentor-description"></section>
  307. </dd>
  308. <dt class="phpdocumentor-argument-list__entry">
  309. <span class="phpdocumentor-signature__argument__name">$errorLocations</span>
  310. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  311. </dt>
  312. <dd class="phpdocumentor-argument-list__definition">
  313. <section class="phpdocumentor-description"></section>
  314. </dd>
  315. </dl>
  316. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  317. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  318. &mdash;
  319. </article>
  320. <article
  321. class="phpdocumentor-element
  322. -method
  323. -private
  324. "
  325. >
  326. <h4 class="phpdocumentor-element__name" id="method_runEuclideanAlgorithm">
  327. runEuclideanAlgorithm()
  328. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_runEuclideanAlgorithm" class="headerlink"><i class="fas fa-link"></i></a>
  329. </h4>
  330. <aside class="phpdocumentor-element-found-in">
  331. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonDecoder.php"><a href="files/src-common-reedsolomondecoder.html"><abbr title="src/Common/ReedSolomonDecoder.php">ReedSolomonDecoder.php</abbr></a></abbr>
  332. :
  333. <span class="phpdocumentor-element-found-in__line">98</span>
  334. </aside>
  335. <code class="phpdocumentor-code phpdocumentor-signature ">
  336. <span class="phpdocumentor-signature__visibility">private</span>
  337. <span class="phpdocumentor-signature__name">runEuclideanAlgorithm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$a</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$b</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$R</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a>&gt;</span></code>
  338. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  339. <dl class="phpdocumentor-argument-list">
  340. <dt class="phpdocumentor-argument-list__entry">
  341. <span class="phpdocumentor-signature__argument__name">$a</span>
  342. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a></span>
  343. </dt>
  344. <dd class="phpdocumentor-argument-list__definition">
  345. <section class="phpdocumentor-description"></section>
  346. </dd>
  347. <dt class="phpdocumentor-argument-list__entry">
  348. <span class="phpdocumentor-signature__argument__name">$b</span>
  349. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a></span>
  350. </dt>
  351. <dd class="phpdocumentor-argument-list__definition">
  352. <section class="phpdocumentor-description"></section>
  353. </dd>
  354. <dt class="phpdocumentor-argument-list__entry">
  355. <span class="phpdocumentor-signature__argument__name">$R</span>
  356. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  357. </dt>
  358. <dd class="phpdocumentor-argument-list__definition">
  359. <section class="phpdocumentor-description"></section>
  360. </dd>
  361. </dl>
  362. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  363. Tags
  364. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  365. </h5>
  366. <dl class="phpdocumentor-tag-list">
  367. <dt class="phpdocumentor-tag-list__entry">
  368. <span class="phpdocumentor-tag__name">throws</span>
  369. </dt>
  370. <dd class="phpdocumentor-tag-list__definition">
  371. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  372. </dd>
  373. </dl>
  374. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  375. <span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a>&gt;</span>
  376. &mdash;
  377. <section class="phpdocumentor-description"><p>[sigma, omega]</p>
  378. </section>
  379. </article>
  380. </section>
  381. <script type="text/javascript">
  382. function loadExternalCodeSnippets(line) {
  383. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  384. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  385. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  386. var language = 'php';
  387. var code = document.createElement('code');
  388. code.className = 'language-' + language;
  389. pre.textContent = '';
  390. pre.setAttribute('data-line', line)
  391. code.textContent = 'Loading…';
  392. pre.appendChild(code);
  393. var xhr = new XMLHttpRequest();
  394. xhr.open('GET', src, true);
  395. xhr.onreadystatechange = function () {
  396. if (xhr.readyState == 4) {
  397. if (xhr.status < 400 && xhr.responseText) {
  398. code.textContent = xhr.responseText;
  399. Prism.highlightElement(code);
  400. }
  401. else if (xhr.status >= 400) {
  402. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  403. }
  404. else {
  405. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  406. }
  407. }
  408. };
  409. xhr.send(null);
  410. });
  411. }
  412. var modals = document.querySelectorAll("[data-modal]");
  413. modals.forEach(function (trigger) {
  414. trigger.addEventListener("click", function (event) {
  415. //event.preventDefault();
  416. const modal = document.getElementById(trigger.dataset.modal);
  417. modal.classList.add("phpdocumentor-modal__open");
  418. loadExternalCodeSnippets(trigger.dataset.line)
  419. const exits = modal.querySelectorAll("[data-exit-button]");
  420. exits.forEach(function (exit) {
  421. exit.addEventListener("click", function (event) {
  422. event.preventDefault();
  423. modal.classList.remove("phpdocumentor-modal__open");
  424. });
  425. });
  426. });
  427. });
  428. </script>
  429. </article>
  430. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  431. <section class="phpdocumentor-search-results__dialog">
  432. <header class="phpdocumentor-search-results__header">
  433. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  434. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  435. </header>
  436. <section class="phpdocumentor-search-results__body">
  437. <ul class="phpdocumentor-search-results__entries"></ul>
  438. </section>
  439. </section>
  440. </section>
  441. </div>
  442. </div>
  443. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  444. </main>
  445. <script>
  446. cssVars({});
  447. </script>
  448. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  449. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  450. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  451. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  452. </body>
  453. </html>