chillerlan-QRCode-Common-ReedSolomonDecoder.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566
  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">35</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 &quot;Decoding Reed-Solomon Codes&quot; (see discussion of Forney's Formula)
  106. http://www.cs.cmu.edu/afs/cs.cmu.edu/project/pscico-guyb/realworld/www/rs_decode.ps</li>
  107. <li>J.I. Hall. &quot;Chapter 5. Generalized Reed-Solomon Codes&quot; (see discussion of Euclidean algorithm)
  108. https://users.math.msu.edu/users/halljo/classes/codenotes/GRS.pdf</li>
  109. </ul>
  110. <p>Much credit is due to William Rucklidge since portions of this code are an indirect
  111. port of his C++ Reed-Solomon implementation.</p>
  112. </section>
  113. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  114. Tags
  115. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  116. </h5>
  117. <dl class="phpdocumentor-tag-list">
  118. <dt class="phpdocumentor-tag-list__entry">
  119. <span class="phpdocumentor-tag__name">author</span>
  120. </dt>
  121. <dd class="phpdocumentor-tag-list__definition">
  122. <section class="phpdocumentor-description"><p>Sean Owen</p>
  123. </section>
  124. </dd>
  125. <dt class="phpdocumentor-tag-list__entry">
  126. <span class="phpdocumentor-tag__name">author</span>
  127. </dt>
  128. <dd class="phpdocumentor-tag-list__definition">
  129. <section class="phpdocumentor-description"><p>William Rucklidge</p>
  130. </section>
  131. </dd>
  132. <dt class="phpdocumentor-tag-list__entry">
  133. <span class="phpdocumentor-tag__name">author</span>
  134. </dt>
  135. <dd class="phpdocumentor-tag-list__definition">
  136. <section class="phpdocumentor-description"><p>sanfordsquires</p>
  137. </section>
  138. </dd>
  139. </dl>
  140. <h3 id="toc">
  141. Table of Contents
  142. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  143. </h3>
  144. <dl class="phpdocumentor-table-of-contents">
  145. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  146. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_decode">decode()</a>
  147. <span>
  148. &nbsp;: array&lt;string|int, int&gt; </span>
  149. </dt>
  150. <dd>Decodes given set of received codewords, which include both data and error-correction
  151. codewords. Really, this means it uses Reed-Solomon to detect and correct errors, in-place,
  152. in the input.</dd>
  153. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  154. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_findErrorLocations">findErrorLocations()</a>
  155. <span>
  156. &nbsp;: array&lt;string|int, mixed&gt; </span>
  157. </dt>
  158. <dd></dd>
  159. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  160. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_findErrorMagnitudes">findErrorMagnitudes()</a>
  161. <span>
  162. &nbsp;: array&lt;string|int, mixed&gt; </span>
  163. </dt>
  164. <dd></dd>
  165. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  166. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_runEuclideanAlgorithm">runEuclideanAlgorithm()</a>
  167. <span>
  168. &nbsp;: array&lt;string|int, <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a>&gt; </span>
  169. </dt>
  170. <dd></dd>
  171. </dl>
  172. <section class="phpdocumentor-methods">
  173. <h3 class="phpdocumentor-elements__header" id="methods">
  174. Methods
  175. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  176. </h3>
  177. <article
  178. class="phpdocumentor-element
  179. -method
  180. -public
  181. "
  182. >
  183. <h4 class="phpdocumentor-element__name" id="method_decode">
  184. decode()
  185. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_decode" class="headerlink"><i class="fas fa-link"></i></a>
  186. </h4>
  187. <aside class="phpdocumentor-element-found-in">
  188. <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>
  189. :
  190. <span class="phpdocumentor-element-found-in__line">48</span>
  191. </aside>
  192. <p class="phpdocumentor-summary">Decodes given set of received codewords, which include both data and error-correction
  193. codewords. Really, this means it uses Reed-Solomon to detect and correct errors, in-place,
  194. in the input.</p>
  195. <code class="phpdocumentor-code phpdocumentor-signature ">
  196. <span class="phpdocumentor-signature__visibility">public</span>
  197. <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>
  198. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  199. <dl class="phpdocumentor-argument-list">
  200. <dt class="phpdocumentor-argument-list__entry">
  201. <span class="phpdocumentor-signature__argument__name">$received</span>
  202. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  203. </dt>
  204. <dd class="phpdocumentor-argument-list__definition">
  205. <section class="phpdocumentor-description"><p>data and error-correction codewords</p>
  206. </section>
  207. </dd>
  208. <dt class="phpdocumentor-argument-list__entry">
  209. <span class="phpdocumentor-signature__argument__name">$numEccCodewords</span>
  210. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  211. </dt>
  212. <dd class="phpdocumentor-argument-list__definition">
  213. <section class="phpdocumentor-description"><p>number of error-correction codewords available</p>
  214. </section>
  215. </dd>
  216. </dl>
  217. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  218. Tags
  219. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  220. </h5>
  221. <dl class="phpdocumentor-tag-list">
  222. <dt class="phpdocumentor-tag-list__entry">
  223. <span class="phpdocumentor-tag__name">throws</span>
  224. </dt>
  225. <dd class="phpdocumentor-tag-list__definition">
  226. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  227. <section class="phpdocumentor-description"><p>if decoding fails for any reason</p>
  228. </section>
  229. </dd>
  230. </dl>
  231. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  232. <span class="phpdocumentor-signature__response_type">array&lt;string|int, int&gt;</span>
  233. &mdash;
  234. </article>
  235. <article
  236. class="phpdocumentor-element
  237. -method
  238. -private
  239. "
  240. >
  241. <h4 class="phpdocumentor-element__name" id="method_findErrorLocations">
  242. findErrorLocations()
  243. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_findErrorLocations" class="headerlink"><i class="fas fa-link"></i></a>
  244. </h4>
  245. <aside class="phpdocumentor-element-found-in">
  246. <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>
  247. :
  248. <span class="phpdocumentor-element-found-in__line">138</span>
  249. </aside>
  250. <code class="phpdocumentor-code phpdocumentor-signature ">
  251. <span class="phpdocumentor-signature__visibility">private</span>
  252. <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>
  253. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  254. <dl class="phpdocumentor-argument-list">
  255. <dt class="phpdocumentor-argument-list__entry">
  256. <span class="phpdocumentor-signature__argument__name">$errorLocator</span>
  257. : <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>
  258. </dt>
  259. <dd class="phpdocumentor-argument-list__definition">
  260. <section class="phpdocumentor-description"></section>
  261. </dd>
  262. </dl>
  263. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  264. Tags
  265. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  266. </h5>
  267. <dl class="phpdocumentor-tag-list">
  268. <dt class="phpdocumentor-tag-list__entry">
  269. <span class="phpdocumentor-tag__name">throws</span>
  270. </dt>
  271. <dd class="phpdocumentor-tag-list__definition">
  272. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  273. </dd>
  274. </dl>
  275. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  276. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  277. &mdash;
  278. </article>
  279. <article
  280. class="phpdocumentor-element
  281. -method
  282. -private
  283. "
  284. >
  285. <h4 class="phpdocumentor-element__name" id="method_findErrorMagnitudes">
  286. findErrorMagnitudes()
  287. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_findErrorMagnitudes" class="headerlink"><i class="fas fa-link"></i></a>
  288. </h4>
  289. <aside class="phpdocumentor-element-found-in">
  290. <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>
  291. :
  292. <span class="phpdocumentor-element-found-in__line">166</span>
  293. </aside>
  294. <code class="phpdocumentor-code phpdocumentor-signature ">
  295. <span class="phpdocumentor-signature__visibility">private</span>
  296. <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>
  297. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  298. <dl class="phpdocumentor-argument-list">
  299. <dt class="phpdocumentor-argument-list__entry">
  300. <span class="phpdocumentor-signature__argument__name">$errorEvaluator</span>
  301. : <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>
  302. </dt>
  303. <dd class="phpdocumentor-argument-list__definition">
  304. <section class="phpdocumentor-description"></section>
  305. </dd>
  306. <dt class="phpdocumentor-argument-list__entry">
  307. <span class="phpdocumentor-signature__argument__name">$errorLocations</span>
  308. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  309. </dt>
  310. <dd class="phpdocumentor-argument-list__definition">
  311. <section class="phpdocumentor-description"></section>
  312. </dd>
  313. </dl>
  314. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  315. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  316. &mdash;
  317. </article>
  318. <article
  319. class="phpdocumentor-element
  320. -method
  321. -private
  322. "
  323. >
  324. <h4 class="phpdocumentor-element__name" id="method_runEuclideanAlgorithm">
  325. runEuclideanAlgorithm()
  326. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#method_runEuclideanAlgorithm" class="headerlink"><i class="fas fa-link"></i></a>
  327. </h4>
  328. <aside class="phpdocumentor-element-found-in">
  329. <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>
  330. :
  331. <span class="phpdocumentor-element-found-in__line">94</span>
  332. </aside>
  333. <code class="phpdocumentor-code phpdocumentor-signature ">
  334. <span class="phpdocumentor-signature__visibility">private</span>
  335. <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>
  336. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  337. <dl class="phpdocumentor-argument-list">
  338. <dt class="phpdocumentor-argument-list__entry">
  339. <span class="phpdocumentor-signature__argument__name">$a</span>
  340. : <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>
  341. </dt>
  342. <dd class="phpdocumentor-argument-list__definition">
  343. <section class="phpdocumentor-description"></section>
  344. </dd>
  345. <dt class="phpdocumentor-argument-list__entry">
  346. <span class="phpdocumentor-signature__argument__name">$b</span>
  347. : <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>
  348. </dt>
  349. <dd class="phpdocumentor-argument-list__definition">
  350. <section class="phpdocumentor-description"></section>
  351. </dd>
  352. <dt class="phpdocumentor-argument-list__entry">
  353. <span class="phpdocumentor-signature__argument__name">$R</span>
  354. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  355. </dt>
  356. <dd class="phpdocumentor-argument-list__definition">
  357. <section class="phpdocumentor-description"></section>
  358. </dd>
  359. </dl>
  360. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  361. Tags
  362. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  363. </h5>
  364. <dl class="phpdocumentor-tag-list">
  365. <dt class="phpdocumentor-tag-list__entry">
  366. <span class="phpdocumentor-tag__name">throws</span>
  367. </dt>
  368. <dd class="phpdocumentor-tag-list__definition">
  369. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  370. </dd>
  371. </dl>
  372. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  373. <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>
  374. &mdash;
  375. <section class="phpdocumentor-description"><p>[sigma, omega]</p>
  376. </section>
  377. </article>
  378. </section>
  379. <script type="text/javascript">
  380. function loadExternalCodeSnippets(line) {
  381. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  382. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  383. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  384. var language = 'php';
  385. var code = document.createElement('code');
  386. code.className = 'language-' + language;
  387. pre.textContent = '';
  388. pre.setAttribute('data-line', line)
  389. code.textContent = 'Loading…';
  390. pre.appendChild(code);
  391. var xhr = new XMLHttpRequest();
  392. xhr.open('GET', src, true);
  393. xhr.onreadystatechange = function () {
  394. if (xhr.readyState == 4) {
  395. if (xhr.status < 400 && xhr.responseText) {
  396. code.textContent = xhr.responseText;
  397. Prism.highlightElement(code);
  398. }
  399. else if (xhr.status >= 400) {
  400. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  401. }
  402. else {
  403. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  404. }
  405. }
  406. };
  407. xhr.send(null);
  408. });
  409. }
  410. var modals = document.querySelectorAll("[data-modal]");
  411. modals.forEach(function (trigger) {
  412. trigger.addEventListener("click", function (event) {
  413. //event.preventDefault();
  414. const modal = document.getElementById(trigger.dataset.modal);
  415. modal.classList.add("phpdocumentor-modal__open");
  416. loadExternalCodeSnippets(trigger.dataset.line)
  417. const exits = modal.querySelectorAll("[data-exit-button]");
  418. exits.forEach(function (exit) {
  419. exit.addEventListener("click", function (event) {
  420. event.preventDefault();
  421. modal.classList.remove("phpdocumentor-modal__open");
  422. });
  423. });
  424. });
  425. });
  426. </script>
  427. </article>
  428. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  429. <section class="phpdocumentor-search-results__dialog">
  430. <header class="phpdocumentor-search-results__header">
  431. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  432. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  433. </header>
  434. <section class="phpdocumentor-search-results__body">
  435. <ul class="phpdocumentor-search-results__entries"></ul>
  436. </section>
  437. </section>
  438. </section>
  439. </div>
  440. </div>
  441. <a href="classes/chillerlan-QRCode-Common-ReedSolomonDecoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  442. </main>
  443. <script>
  444. cssVars({});
  445. </script>
  446. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  447. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  448. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  449. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  450. </body>
  451. </html>