chillerlan-QRCode-Common-GenericGFPoly.html 45 KB

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