chillerlan-QRCode-Common-GenericGFPoly.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947
  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">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-common.html">Common</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. GenericGFPoly
  93. <div class="phpdocumentor-element__package">
  94. in package
  95. <ul class="phpdocumentor-breadcrumbs">
  96. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  97. </ul>
  98. </div>
  99. </h2>
  100. <aside class="phpdocumentor-element-found-in">
  101. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  102. :
  103. <span class="phpdocumentor-element-found-in__line">27</span>
  104. </aside>
  105. <p class="phpdocumentor-summary">Represents a polynomial whose coefficients are elements of a GF.</p>
  106. <section class="phpdocumentor-description"><p>Instances of this class are immutable.</p>
  107. <p>Much credit is due to William Rucklidge since portions of this code are an indirect
  108. port of his C++ Reed-Solomon implementation.</p>
  109. </section>
  110. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  111. Tags
  112. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  113. </h5>
  114. <dl class="phpdocumentor-tag-list">
  115. <dt class="phpdocumentor-tag-list__entry">
  116. <span class="phpdocumentor-tag__name">author</span>
  117. </dt>
  118. <dd class="phpdocumentor-tag-list__definition">
  119. <section class="phpdocumentor-description"><p>Sean Owen</p>
  120. </section>
  121. </dd>
  122. </dl>
  123. <h3 id="toc">
  124. Table of Contents
  125. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  126. </h3>
  127. <dl class="phpdocumentor-table-of-contents">
  128. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  129. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#property_coefficients">$coefficients</a>
  130. <span>
  131. &nbsp;: array&lt;string|int, mixed&gt; </span>
  132. </dt>
  133. <dd></dd>
  134. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  135. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method___construct">__construct()</a>
  136. <span>
  137. &nbsp;: mixed </span>
  138. </dt>
  139. <dd></dd>
  140. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  141. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_addOrSubtract">addOrSubtract()</a>
  142. <span>
  143. &nbsp;: self </span>
  144. </dt>
  145. <dd></dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  147. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_divide">divide()</a>
  148. <span>
  149. &nbsp;: array&lt;string|int, <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a>&gt; </span>
  150. </dt>
  151. <dd></dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  153. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_evaluateAt">evaluateAt()</a>
  154. <span>
  155. &nbsp;: int </span>
  156. </dt>
  157. <dd></dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  159. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_getCoefficient">getCoefficient()</a>
  160. <span>
  161. &nbsp;: int </span>
  162. </dt>
  163. <dd></dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  165. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_getCoefficients">getCoefficients()</a>
  166. <span>
  167. &nbsp;: array&lt;string|int, int&gt; </span>
  168. </dt>
  169. <dd></dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  171. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_getDegree">getDegree()</a>
  172. <span>
  173. &nbsp;: int </span>
  174. </dt>
  175. <dd></dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  177. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_isZero">isZero()</a>
  178. <span>
  179. &nbsp;: bool </span>
  180. </dt>
  181. <dd></dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  183. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_mod">mod()</a>
  184. <span>
  185. &nbsp;: self </span>
  186. </dt>
  187. <dd></dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  189. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_multiply">multiply()</a>
  190. <span>
  191. &nbsp;: self </span>
  192. </dt>
  193. <dd></dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  195. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_multiplyByMonomial">multiplyByMonomial()</a>
  196. <span>
  197. &nbsp;: self </span>
  198. </dt>
  199. <dd></dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  201. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_multiplyInt">multiplyInt()</a>
  202. <span>
  203. &nbsp;: self </span>
  204. </dt>
  205. <dd></dd>
  206. </dl>
  207. <section class="phpdocumentor-properties">
  208. <h3 class="phpdocumentor-elements__header" id="properties">
  209. Properties
  210. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  211. </h3>
  212. <article
  213. class="
  214. phpdocumentor-element
  215. -property
  216. -private
  217. "
  218. >
  219. <h4 class="phpdocumentor-element__name" id="property_coefficients">
  220. $coefficients
  221. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#property_coefficients" class="headerlink"><i class="fas fa-link"></i></a>
  222. <span class="phpdocumentor-element__modifiers">
  223. </span>
  224. </h4>
  225. <aside class="phpdocumentor-element-found-in">
  226. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  227. :
  228. <span class="phpdocumentor-element-found-in__line">29</span>
  229. </aside>
  230. <code class="phpdocumentor-code phpdocumentor-signature ">
  231. <span class="phpdocumentor-signature__visibility">private</span>
  232. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  233. <span class="phpdocumentor-signature__name">$coefficients</span>
  234. </code>
  235. <section class="phpdocumentor-description"></section>
  236. <section class="phpdocumentor-description"></section>
  237. </article>
  238. </section>
  239. <section class="phpdocumentor-methods">
  240. <h3 class="phpdocumentor-elements__header" id="methods">
  241. Methods
  242. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  243. </h3>
  244. <article
  245. class="phpdocumentor-element
  246. -method
  247. -public
  248. "
  249. >
  250. <h4 class="phpdocumentor-element__name" id="method___construct">
  251. __construct()
  252. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  253. </h4>
  254. <aside class="phpdocumentor-element-found-in">
  255. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  256. :
  257. <span class="phpdocumentor-element-found-in__line">39</span>
  258. </aside>
  259. <code class="phpdocumentor-code phpdocumentor-signature ">
  260. <span class="phpdocumentor-signature__visibility">public</span>
  261. <span class="phpdocumentor-signature__name">__construct</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">$coefficients</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$degree</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  262. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  263. <dl class="phpdocumentor-argument-list">
  264. <dt class="phpdocumentor-argument-list__entry">
  265. <span class="phpdocumentor-signature__argument__name">$coefficients</span>
  266. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  267. </dt>
  268. <dd class="phpdocumentor-argument-list__definition">
  269. <section class="phpdocumentor-description"><p>array coefficients as ints representing elements of GF(size), arranged
  270. from most significant (highest-power term) coefficient to the least significant</p>
  271. </section>
  272. </dd>
  273. <dt class="phpdocumentor-argument-list__entry">
  274. <span class="phpdocumentor-signature__argument__name">$degree</span>
  275. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  276. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  277. <dd class="phpdocumentor-argument-list__definition">
  278. </dd>
  279. </dl>
  280. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  281. Tags
  282. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  283. </h5>
  284. <dl class="phpdocumentor-tag-list">
  285. <dt class="phpdocumentor-tag-list__entry">
  286. <span class="phpdocumentor-tag__name">throws</span>
  287. </dt>
  288. <dd class="phpdocumentor-tag-list__definition">
  289. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  290. <section class="phpdocumentor-description"><p>if argument is null or empty, or if leading coefficient is 0 and this
  291. is not a constant polynomial (that is, it is not the monomial &quot;0&quot;)</p>
  292. </section>
  293. </dd>
  294. </dl>
  295. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  296. <span class="phpdocumentor-signature__response_type">mixed</span>
  297. &mdash;
  298. </article>
  299. <article
  300. class="phpdocumentor-element
  301. -method
  302. -public
  303. "
  304. >
  305. <h4 class="phpdocumentor-element__name" id="method_addOrSubtract">
  306. addOrSubtract()
  307. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_addOrSubtract" class="headerlink"><i class="fas fa-link"></i></a>
  308. </h4>
  309. <aside class="phpdocumentor-element-found-in">
  310. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  311. :
  312. <span class="phpdocumentor-element-found-in__line">231</span>
  313. </aside>
  314. <code class="phpdocumentor-code phpdocumentor-signature ">
  315. <span class="phpdocumentor-signature__visibility">public</span>
  316. <span class="phpdocumentor-signature__name">addOrSubtract</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">$other</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  317. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  318. <dl class="phpdocumentor-argument-list">
  319. <dt class="phpdocumentor-argument-list__entry">
  320. <span class="phpdocumentor-signature__argument__name">$other</span>
  321. : <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>
  322. </dt>
  323. <dd class="phpdocumentor-argument-list__definition">
  324. <section class="phpdocumentor-description"></section>
  325. </dd>
  326. </dl>
  327. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  328. <span class="phpdocumentor-signature__response_type">self</span>
  329. &mdash;
  330. </article>
  331. <article
  332. class="phpdocumentor-element
  333. -method
  334. -public
  335. "
  336. >
  337. <h4 class="phpdocumentor-element__name" id="method_divide">
  338. divide()
  339. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_divide" class="headerlink"><i class="fas fa-link"></i></a>
  340. </h4>
  341. <aside class="phpdocumentor-element-found-in">
  342. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  343. :
  344. <span class="phpdocumentor-element-found-in__line">143</span>
  345. </aside>
  346. <code class="phpdocumentor-code phpdocumentor-signature ">
  347. <span class="phpdocumentor-signature__visibility">public</span>
  348. <span class="phpdocumentor-signature__name">divide</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">$other</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>
  349. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  350. <dl class="phpdocumentor-argument-list">
  351. <dt class="phpdocumentor-argument-list__entry">
  352. <span class="phpdocumentor-signature__argument__name">$other</span>
  353. : <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>
  354. </dt>
  355. <dd class="phpdocumentor-argument-list__definition">
  356. <section class="phpdocumentor-description"></section>
  357. </dd>
  358. </dl>
  359. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  360. Tags
  361. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  362. </h5>
  363. <dl class="phpdocumentor-tag-list">
  364. <dt class="phpdocumentor-tag-list__entry">
  365. <span class="phpdocumentor-tag__name">throws</span>
  366. </dt>
  367. <dd class="phpdocumentor-tag-list__definition">
  368. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  369. </dd>
  370. </dl>
  371. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  372. <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>
  373. &mdash;
  374. <section class="phpdocumentor-description"><p>[quotient, remainder]</p>
  375. </section>
  376. </article>
  377. <article
  378. class="phpdocumentor-element
  379. -method
  380. -public
  381. "
  382. >
  383. <h4 class="phpdocumentor-element__name" id="method_evaluateAt">
  384. evaluateAt()
  385. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_evaluateAt" class="headerlink"><i class="fas fa-link"></i></a>
  386. </h4>
  387. <aside class="phpdocumentor-element-found-in">
  388. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  389. :
  390. <span class="phpdocumentor-element-found-in__line">102</span>
  391. </aside>
  392. <code class="phpdocumentor-code phpdocumentor-signature ">
  393. <span class="phpdocumentor-signature__visibility">public</span>
  394. <span class="phpdocumentor-signature__name">evaluateAt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$a</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  395. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  396. <dl class="phpdocumentor-argument-list">
  397. <dt class="phpdocumentor-argument-list__entry">
  398. <span class="phpdocumentor-signature__argument__name">$a</span>
  399. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  400. </dt>
  401. <dd class="phpdocumentor-argument-list__definition">
  402. <section class="phpdocumentor-description"></section>
  403. </dd>
  404. </dl>
  405. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  406. <span class="phpdocumentor-signature__response_type">int</span>
  407. &mdash;
  408. <section class="phpdocumentor-description"><p>evaluation of this polynomial at a given point</p>
  409. </section>
  410. </article>
  411. <article
  412. class="phpdocumentor-element
  413. -method
  414. -public
  415. "
  416. >
  417. <h4 class="phpdocumentor-element__name" id="method_getCoefficient">
  418. getCoefficient()
  419. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_getCoefficient" class="headerlink"><i class="fas fa-link"></i></a>
  420. </h4>
  421. <aside class="phpdocumentor-element-found-in">
  422. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  423. :
  424. <span class="phpdocumentor-element-found-in__line">74</span>
  425. </aside>
  426. <code class="phpdocumentor-code phpdocumentor-signature ">
  427. <span class="phpdocumentor-signature__visibility">public</span>
  428. <span class="phpdocumentor-signature__name">getCoefficient</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$degree</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  429. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  430. <dl class="phpdocumentor-argument-list">
  431. <dt class="phpdocumentor-argument-list__entry">
  432. <span class="phpdocumentor-signature__argument__name">$degree</span>
  433. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  434. </dt>
  435. <dd class="phpdocumentor-argument-list__definition">
  436. <section class="phpdocumentor-description"></section>
  437. </dd>
  438. </dl>
  439. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  440. <span class="phpdocumentor-signature__response_type">int</span>
  441. &mdash;
  442. <section class="phpdocumentor-description"><p>$coefficient of x^degree term in this polynomial</p>
  443. </section>
  444. </article>
  445. <article
  446. class="phpdocumentor-element
  447. -method
  448. -public
  449. "
  450. >
  451. <h4 class="phpdocumentor-element__name" id="method_getCoefficients">
  452. getCoefficients()
  453. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_getCoefficients" class="headerlink"><i class="fas fa-link"></i></a>
  454. </h4>
  455. <aside class="phpdocumentor-element-found-in">
  456. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  457. :
  458. <span class="phpdocumentor-element-found-in__line">81</span>
  459. </aside>
  460. <code class="phpdocumentor-code phpdocumentor-signature ">
  461. <span class="phpdocumentor-signature__visibility">public</span>
  462. <span class="phpdocumentor-signature__name">getCoefficients</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, int&gt;</span></code>
  463. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  464. <span class="phpdocumentor-signature__response_type">array&lt;string|int, int&gt;</span>
  465. &mdash;
  466. </article>
  467. <article
  468. class="phpdocumentor-element
  469. -method
  470. -public
  471. "
  472. >
  473. <h4 class="phpdocumentor-element__name" id="method_getDegree">
  474. getDegree()
  475. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_getDegree" class="headerlink"><i class="fas fa-link"></i></a>
  476. </h4>
  477. <aside class="phpdocumentor-element-found-in">
  478. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  479. :
  480. <span class="phpdocumentor-element-found-in__line">88</span>
  481. </aside>
  482. <code class="phpdocumentor-code phpdocumentor-signature ">
  483. <span class="phpdocumentor-signature__visibility">public</span>
  484. <span class="phpdocumentor-signature__name">getDegree</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  485. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  486. <span class="phpdocumentor-signature__response_type">int</span>
  487. &mdash;
  488. <section class="phpdocumentor-description"><p>$degree of this polynomial</p>
  489. </section>
  490. </article>
  491. <article
  492. class="phpdocumentor-element
  493. -method
  494. -public
  495. "
  496. >
  497. <h4 class="phpdocumentor-element__name" id="method_isZero">
  498. isZero()
  499. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_isZero" class="headerlink"><i class="fas fa-link"></i></a>
  500. </h4>
  501. <aside class="phpdocumentor-element-found-in">
  502. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  503. :
  504. <span class="phpdocumentor-element-found-in__line">95</span>
  505. </aside>
  506. <code class="phpdocumentor-code phpdocumentor-signature ">
  507. <span class="phpdocumentor-signature__visibility">public</span>
  508. <span class="phpdocumentor-signature__name">isZero</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  509. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  510. <span class="phpdocumentor-signature__response_type">bool</span>
  511. &mdash;
  512. <section class="phpdocumentor-description"><p>true if this polynomial is the monomial &quot;0&quot;</p>
  513. </section>
  514. </article>
  515. <article
  516. class="phpdocumentor-element
  517. -method
  518. -public
  519. "
  520. >
  521. <h4 class="phpdocumentor-element__name" id="method_mod">
  522. mod()
  523. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_mod" class="headerlink"><i class="fas fa-link"></i></a>
  524. </h4>
  525. <aside class="phpdocumentor-element-found-in">
  526. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  527. :
  528. <span class="phpdocumentor-element-found-in__line">213</span>
  529. </aside>
  530. <code class="phpdocumentor-code phpdocumentor-signature ">
  531. <span class="phpdocumentor-signature__visibility">public</span>
  532. <span class="phpdocumentor-signature__name">mod</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">$other</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  533. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  534. <dl class="phpdocumentor-argument-list">
  535. <dt class="phpdocumentor-argument-list__entry">
  536. <span class="phpdocumentor-signature__argument__name">$other</span>
  537. : <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>
  538. </dt>
  539. <dd class="phpdocumentor-argument-list__definition">
  540. <section class="phpdocumentor-description"></section>
  541. </dd>
  542. </dl>
  543. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  544. <span class="phpdocumentor-signature__response_type">self</span>
  545. &mdash;
  546. </article>
  547. <article
  548. class="phpdocumentor-element
  549. -method
  550. -public
  551. "
  552. >
  553. <h4 class="phpdocumentor-element__name" id="method_multiply">
  554. multiply()
  555. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_multiply" class="headerlink"><i class="fas fa-link"></i></a>
  556. </h4>
  557. <aside class="phpdocumentor-element-found-in">
  558. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  559. :
  560. <span class="phpdocumentor-element-found-in__line">122</span>
  561. </aside>
  562. <code class="phpdocumentor-code phpdocumentor-signature ">
  563. <span class="phpdocumentor-signature__visibility">public</span>
  564. <span class="phpdocumentor-signature__name">multiply</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">$other</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  565. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  566. <dl class="phpdocumentor-argument-list">
  567. <dt class="phpdocumentor-argument-list__entry">
  568. <span class="phpdocumentor-signature__argument__name">$other</span>
  569. : <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>
  570. </dt>
  571. <dd class="phpdocumentor-argument-list__definition">
  572. <section class="phpdocumentor-description"></section>
  573. </dd>
  574. </dl>
  575. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  576. <span class="phpdocumentor-signature__response_type">self</span>
  577. &mdash;
  578. </article>
  579. <article
  580. class="phpdocumentor-element
  581. -method
  582. -public
  583. "
  584. >
  585. <h4 class="phpdocumentor-element__name" id="method_multiplyByMonomial">
  586. multiplyByMonomial()
  587. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_multiplyByMonomial" class="headerlink"><i class="fas fa-link"></i></a>
  588. </h4>
  589. <aside class="phpdocumentor-element-found-in">
  590. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  591. :
  592. <span class="phpdocumentor-element-found-in__line">191</span>
  593. </aside>
  594. <code class="phpdocumentor-code phpdocumentor-signature ">
  595. <span class="phpdocumentor-signature__visibility">public</span>
  596. <span class="phpdocumentor-signature__name">multiplyByMonomial</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$degree</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">$coefficient</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  597. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  598. <dl class="phpdocumentor-argument-list">
  599. <dt class="phpdocumentor-argument-list__entry">
  600. <span class="phpdocumentor-signature__argument__name">$degree</span>
  601. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  602. </dt>
  603. <dd class="phpdocumentor-argument-list__definition">
  604. <section class="phpdocumentor-description"></section>
  605. </dd>
  606. <dt class="phpdocumentor-argument-list__entry">
  607. <span class="phpdocumentor-signature__argument__name">$coefficient</span>
  608. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  609. </dt>
  610. <dd class="phpdocumentor-argument-list__definition">
  611. <section class="phpdocumentor-description"></section>
  612. </dd>
  613. </dl>
  614. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  615. Tags
  616. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  617. </h5>
  618. <dl class="phpdocumentor-tag-list">
  619. <dt class="phpdocumentor-tag-list__entry">
  620. <span class="phpdocumentor-tag__name">throws</span>
  621. </dt>
  622. <dd class="phpdocumentor-tag-list__definition">
  623. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  624. </dd>
  625. </dl>
  626. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  627. <span class="phpdocumentor-signature__response_type">self</span>
  628. &mdash;
  629. </article>
  630. <article
  631. class="phpdocumentor-element
  632. -method
  633. -public
  634. "
  635. >
  636. <h4 class="phpdocumentor-element__name" id="method_multiplyInt">
  637. multiplyInt()
  638. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#method_multiplyInt" class="headerlink"><i class="fas fa-link"></i></a>
  639. </h4>
  640. <aside class="phpdocumentor-element-found-in">
  641. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/GenericGFPoly.php"><a href="files/src-common-genericgfpoly.html"><abbr title="src/Common/GenericGFPoly.php">GenericGFPoly.php</abbr></a></abbr>
  642. :
  643. <span class="phpdocumentor-element-found-in__line">169</span>
  644. </aside>
  645. <code class="phpdocumentor-code phpdocumentor-signature ">
  646. <span class="phpdocumentor-signature__visibility">public</span>
  647. <span class="phpdocumentor-signature__name">multiplyInt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$scalar</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  648. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  649. <dl class="phpdocumentor-argument-list">
  650. <dt class="phpdocumentor-argument-list__entry">
  651. <span class="phpdocumentor-signature__argument__name">$scalar</span>
  652. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  653. </dt>
  654. <dd class="phpdocumentor-argument-list__definition">
  655. <section class="phpdocumentor-description"></section>
  656. </dd>
  657. </dl>
  658. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  659. <span class="phpdocumentor-signature__response_type">self</span>
  660. &mdash;
  661. </article>
  662. </section>
  663. <script type="text/javascript">
  664. function loadExternalCodeSnippets(line) {
  665. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  666. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  667. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  668. var language = 'php';
  669. var code = document.createElement('code');
  670. code.className = 'language-' + language;
  671. pre.textContent = '';
  672. pre.setAttribute('data-line', line)
  673. code.textContent = 'Loading…';
  674. pre.appendChild(code);
  675. var xhr = new XMLHttpRequest();
  676. xhr.open('GET', src, true);
  677. xhr.onreadystatechange = function () {
  678. if (xhr.readyState == 4) {
  679. if (xhr.status < 400 && xhr.responseText) {
  680. code.textContent = xhr.responseText;
  681. Prism.highlightElement(code);
  682. }
  683. else if (xhr.status >= 400) {
  684. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  685. }
  686. else {
  687. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  688. }
  689. }
  690. };
  691. xhr.send(null);
  692. });
  693. }
  694. var modals = document.querySelectorAll("[data-modal]");
  695. modals.forEach(function (trigger) {
  696. trigger.addEventListener("click", function (event) {
  697. //event.preventDefault();
  698. const modal = document.getElementById(trigger.dataset.modal);
  699. modal.classList.add("phpdocumentor-modal__open");
  700. loadExternalCodeSnippets(trigger.dataset.line)
  701. const exits = modal.querySelectorAll("[data-exit-button]");
  702. exits.forEach(function (exit) {
  703. exit.addEventListener("click", function (event) {
  704. event.preventDefault();
  705. modal.classList.remove("phpdocumentor-modal__open");
  706. });
  707. });
  708. });
  709. });
  710. </script>
  711. </article>
  712. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  713. <section class="phpdocumentor-search-results__dialog">
  714. <header class="phpdocumentor-search-results__header">
  715. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  716. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  717. </header>
  718. <section class="phpdocumentor-search-results__body">
  719. <ul class="phpdocumentor-search-results__entries"></ul>
  720. </section>
  721. </section>
  722. </section>
  723. </div>
  724. </div>
  725. <a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  726. </main>
  727. <script>
  728. cssVars({});
  729. </script>
  730. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  731. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  732. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  733. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  734. </body>
  735. </html>