index.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `gates` mod in crate `qcgpu`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, gates">
  9. <title>qcgpu::gates - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
  14. <script src="../../storage.js"></script>
  15. </head>
  16. <body class="rustdoc mod">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'>Module gates</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>qcgpu</a></p><script>window.sidebarCurrent = {name: 'gates', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>qcgpu</a>::<wbr><a class="mod" href=''>gates</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../../src/qcgpu/gates.rs.html#1-177' title='goto source code'>[src]</a></span></h1>
  50. <div class='docblock'><p>Gates and Gate Generation</p>
  51. <p>Matrices are in row major format, and
  52. all gates use the <code>num_complex::Complex&lt;f32&gt;;</code>
  53. datatype.</p>
  54. </div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
  55. <table>
  56. <tr class=' module-item'>
  57. <td><a class="struct" href="struct.Gate.html"
  58. title='struct qcgpu::gates::Gate'>Gate</a></td>
  59. <td class='docblock-short'>
  60. <p>Representation of a gate</p>
  61. </td>
  62. </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
  63. <table>
  64. <tr class=' module-item'>
  65. <td><a class="fn" href="fn.h.html"
  66. title='fn qcgpu::gates::h'>h</a></td>
  67. <td class='docblock-short'>
  68. <p>Hadamard Gate</p>
  69. </td>
  70. </tr>
  71. <tr class=' module-item'>
  72. <td><a class="fn" href="fn.id.html"
  73. title='fn qcgpu::gates::id'>id</a></td>
  74. <td class='docblock-short'>
  75. <p>Identity gate</p>
  76. </td>
  77. </tr>
  78. <tr class=' module-item'>
  79. <td><a class="fn" href="fn.negh.html"
  80. title='fn qcgpu::gates::negh'>negh</a></td>
  81. <td class='docblock-short'>
  82. <p>Negative Hadamard Gate</p>
  83. </td>
  84. </tr>
  85. <tr class=' module-item'>
  86. <td><a class="fn" href="fn.r.html"
  87. title='fn qcgpu::gates::r'>r</a></td>
  88. <td class='docblock-short'>
  89. <p>The Phase Shift / R gate.
  90. Note that this function has an argument of <code>angle</code>, which corresponds to the
  91. rotation angle of the gate.</p>
  92. </td>
  93. </tr>
  94. <tr class=' module-item'>
  95. <td><a class="fn" href="fn.s.html"
  96. title='fn qcgpu::gates::s'>s</a></td>
  97. <td class='docblock-short'>
  98. <p>S / Phase Gate</p>
  99. </td>
  100. </tr>
  101. <tr class=' module-item'>
  102. <td><a class="fn" href="fn.t.html"
  103. title='fn qcgpu::gates::t'>t</a></td>
  104. <td class='docblock-short'>
  105. <p>T Gate</p>
  106. </td>
  107. </tr>
  108. <tr class=' module-item'>
  109. <td><a class="fn" href="fn.x.html"
  110. title='fn qcgpu::gates::x'>x</a></td>
  111. <td class='docblock-short'>
  112. <p>Pauli X / NOT Gate</p>
  113. </td>
  114. </tr>
  115. <tr class=' module-item'>
  116. <td><a class="fn" href="fn.y.html"
  117. title='fn qcgpu::gates::y'>y</a></td>
  118. <td class='docblock-short'>
  119. <p>Pauli Y Gate</p>
  120. </td>
  121. </tr>
  122. <tr class=' module-item'>
  123. <td><a class="fn" href="fn.z.html"
  124. title='fn qcgpu::gates::z'>z</a></td>
  125. <td class='docblock-short'>
  126. <p>Pauli Z Gate</p>
  127. </td>
  128. </tr></table></section>
  129. <section id='search' class="content hidden"></section>
  130. <section class="footer"></section>
  131. <aside id="help" class="hidden">
  132. <div>
  133. <h1 class="hidden">Help</h1>
  134. <div class="shortcuts">
  135. <h2>Keyboard Shortcuts</h2>
  136. <dl>
  137. <dt><kbd>?</kbd></dt>
  138. <dd>Show this help dialog</dd>
  139. <dt><kbd>S</kbd></dt>
  140. <dd>Focus the search field</dd>
  141. <dt><kbd>↑</kbd></dt>
  142. <dd>Move up in search results</dd>
  143. <dt><kbd>↓</kbd></dt>
  144. <dd>Move down in search results</dd>
  145. <dt><kbd>↹</kbd></dt>
  146. <dd>Switch tab</dd>
  147. <dt><kbd>&#9166;</kbd></dt>
  148. <dd>Go to active search result</dd>
  149. <dt><kbd>+</kbd></dt>
  150. <dd>Expand all sections</dd>
  151. <dt><kbd>-</kbd></dt>
  152. <dd>Collapse all sections</dd>
  153. </dl>
  154. </div>
  155. <div class="infos">
  156. <h2>Search Tricks</h2>
  157. <p>
  158. Prefix searches with a type followed by a colon (e.g.
  159. <code>fn:</code>) to restrict the search to a given type.
  160. </p>
  161. <p>
  162. Accepted types are: <code>fn</code>, <code>mod</code>,
  163. <code>struct</code>, <code>enum</code>,
  164. <code>trait</code>, <code>type</code>, <code>macro</code>,
  165. and <code>const</code>.
  166. </p>
  167. <p>
  168. Search functions by type signature (e.g.
  169. <code>vec -> usize</code> or <code>* -> vec</code>)
  170. </p>
  171. </div>
  172. </div>
  173. </aside>
  174. <script>
  175. window.rootPath = "../../";
  176. window.currentCrate = "qcgpu";
  177. </script>
  178. <script src="../../main.js"></script>
  179. <script defer src="../../search-index.js"></script>
  180. </body>
  181. </html>