index.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  1. <!DOCTYPE HTML>
  2. <html lang="en" class="sidebar-visible">
  3. <head>
  4. <!-- Book generated using mdBook -->
  5. <meta charset="UTF-8">
  6. <title>QCGPU - QCGPU User Guide</title>
  7. <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
  8. <meta name="description" content="The user guide / prose documentation for QCGPU">
  9. <meta name="viewport" content="width=device-width, initial-scale=1">
  10. <meta name="theme-color" content="#ffffff" />
  11. <link rel="stylesheet" href="book.css">
  12. <link href="https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" rel="stylesheet" type="text/css">
  13. <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500" rel="stylesheet" type="text/css">
  14. <link rel="shortcut icon" href="favicon.png">
  15. <!-- Font Awesome -->
  16. <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
  17. <link rel="stylesheet" href="highlight.css">
  18. <link rel="stylesheet" href="tomorrow-night.css">
  19. <link rel="stylesheet" href="ayu-highlight.css">
  20. <!-- Custom theme -->
  21. <!-- MathJax -->
  22. <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  23. <!-- Fetch Clipboard.js from CDN but have a local fallback -->
  24. <script src="https://cdn.jsdelivr.net/clipboard.js/1.6.1/clipboard.min.js"></script>
  25. <script>
  26. if (typeof Clipboard == 'undefined') {
  27. document.write(unescape("%3Cscript src='clipboard.min.js'%3E%3C/script%3E"));
  28. }
  29. </script>
  30. <noscript>
  31. <style type="text/css">
  32. .javascript-only {
  33. display: none;
  34. }
  35. </style>
  36. </noscript>
  37. </head>
  38. <body class="light">
  39. <!-- Work around some values being stored in localStorage wrapped in quotes -->
  40. <script type="text/javascript">
  41. try {
  42. var theme = localStorage.getItem('mdbook-theme');
  43. var sidebar = localStorage.getItem('mdbook-sidebar');
  44. if (theme.startsWith('"') && theme.endsWith('"')) {
  45. localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
  46. }
  47. if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
  48. localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
  49. }
  50. } catch (e) { }
  51. </script>
  52. <!-- Set the theme before any content is loaded, prevents flash -->
  53. <script type="text/javascript">
  54. var theme;
  55. try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
  56. if (theme === null || theme === undefined) { theme = 'light'; }
  57. document.body.className = theme;
  58. document.querySelector('html').className = theme;
  59. </script>
  60. <!-- Hide / unhide sidebar before it is displayed -->
  61. <script type="text/javascript">
  62. var html = document.querySelector('html');
  63. var sidebar = 'hidden';
  64. if (document.body.clientWidth >= 1080) {
  65. try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
  66. sidebar = sidebar || 'visible';
  67. }
  68. html.classList.remove('sidebar-visible');
  69. html.classList.add("sidebar-" + sidebar);
  70. </script>
  71. <nav id="sidebar" class="sidebar" aria-label="Table of contents">
  72. <ol class="chapter"><li><a href="qcgpu.html" class="active"><strong aria-hidden="true">1.</strong> QCGPU</a></li><li><ol class="section"><li><a href="getting-started.html"><strong aria-hidden="true">1.1.</strong> Getting Started</a></li></ol></li><li><a href="user-guide/user-guide.html"><strong aria-hidden="true">2.</strong> User Guide</a></li><li><ol class="section"><li><a href="user-guide/registers.html"><strong aria-hidden="true">2.1.</strong> Quantum Registers</a></li><li><a href="user-guide/gates.html"><strong aria-hidden="true">2.2.</strong> Quantum Gates</a></li><li><a href="user-guide/operations.html"><strong aria-hidden="true">2.3.</strong> Quantum Operations</a></li><li><a href="user-guide/examples.html"><strong aria-hidden="true">2.4.</strong> Examples</a></li><li><a href="user-guide/decoherence.html"><strong aria-hidden="true">2.5.</strong> Decoherence</a></li></ol></li><li><a href="algorithms/algorithms.html"><strong aria-hidden="true">3.</strong> Algorithms</a></li><li><ol class="section"><li><a href="algorithms/bernstein-vazirani.html"><strong aria-hidden="true">3.1.</strong> Bernstein-Vazirani</a></li><li><a href="algorithms/deutsch-jozsa.html"><strong aria-hidden="true">3.2.</strong> Deutsch-Jozsa</a></li><li><a href="algorithms/grover.html"><strong aria-hidden="true">3.3.</strong> Grovers</a></li><li><a href="algorithms/shor.html"><strong aria-hidden="true">3.4.</strong> Shors</a></li><li><a href="algorithms/super-dense.html"><strong aria-hidden="true">3.5.</strong> Super Dense Coding</a></li></ol></li></ol>
  73. </nav>
  74. <div id="page-wrapper" class="page-wrapper">
  75. <div class="page">
  76. <div id="menu-bar" class="menu-bar">
  77. <div id="menu-bar-sticky-container">
  78. <div class="left-buttons javascript-only">
  79. <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
  80. <i class="fa fa-bars"></i>
  81. </button>
  82. <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
  83. <i class="fa fa-paint-brush"></i>
  84. </button>
  85. <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
  86. <li role="none"><button role="menuitem" class="theme" id="light">Light <span class="default">(default)</span></button></li>
  87. <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
  88. <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
  89. <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
  90. <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
  91. </ul>
  92. <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
  93. <i class="fa fa-search"></i>
  94. </button>
  95. </div>
  96. <h1 class="menu-title">QCGPU User Guide</h1>
  97. <div class="right-buttons">
  98. <a href="print.html" title="Print this book" aria-label="Print this book">
  99. <i id="print-button" class="fa fa-print"></i>
  100. </a>
  101. </div>
  102. </div>
  103. </div>
  104. <div id="searchbar-outer" class="searchbar-outer">
  105. <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
  106. </div>
  107. <div id="searchresults-outer" class="searchresults-outer">
  108. <div class="searchresults-header" id="searchresults-header"></div>
  109. <ul id="searchresults">
  110. </ul>
  111. </div>
  112. <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
  113. <script type="text/javascript">
  114. document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
  115. document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
  116. Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
  117. link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
  118. });
  119. </script>
  120. <div id="content" class="content">
  121. <main>
  122. <a class="header" href="qcgpu.html#qcgpu" id="qcgpu"><h1>QCGPU</h1></a>
  123. <p><strong>QCGPU</strong> is a high performance, hardware accelerated quantum computer simulator written with <a href="https://rust-lang.org/">Rust</a> and <a href="https://www.khronos.org/opencl/">OpenCL</a>.</p>
  124. <p>QCGPU is free and open source. The source code is available on <a href="https://github.com/qcgpu/qcgpu-rust">GitHub</a>. Please report any places where the documentation is unclear, or where examples could be added or improved by creating an <a href="https://github.com/qcgpu/qcgpu-rust/issues">issue</a>.</p>
  125. <a class="header" href="qcgpu.html#help-wanted" id="help-wanted"><h2>Help Wanted</h2></a>
  126. <p>Please request any functionality you would like, need or appreciate by creating an <a href="https://github.com/qcgpu/qcgpu-rust/issues">issue</a>. If you would like to add functionality or fix issues, please create a <a href="https://github.com/qcgpu/qcgpu-rust/pulls">pull request</a> and I will get back to you (usually within the day).</p>
  127. <p>Any other feedback, suggestions or even tiny bits of criticism are welcome. When in doubt, file an <a href="https://github.com/qcgpu/qcgpu-rust/issues">issue</a>!</p>
  128. <a class="header" href="qcgpu.html#api-docs" id="api-docs"><h2>API Docs</h2></a>
  129. <p>Alongside this guide, you may also want the <a href="https://qcgpu.github.com/qcgpu/documentation">documentation</a>.</p>
  130. <a class="header" href="qcgpu.html#license" id="license"><h2>License</h2></a>
  131. <p>QCGPU is licensed under the <a href="https://github.com/qcgpu/qcgpu-rust/blob/master/LICENSE">MIT</a> License.</p>
  132. </main>
  133. <nav class="nav-wrapper" aria-label="Page navigation">
  134. <!-- Mobile navigation buttons -->
  135. <a rel="next" href="getting-started.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
  136. <i class="fa fa-angle-right"></i>
  137. </a>
  138. <div style="clear: both"></div>
  139. </nav>
  140. </div>
  141. </div>
  142. <nav class="nav-wide-wrapper" aria-label="Page navigation">
  143. <a href="getting-started.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
  144. <i class="fa fa-angle-right"></i>
  145. </a>
  146. </nav>
  147. </div>
  148. <!-- Local fallback for Font Awesome -->
  149. <script>
  150. if (getComputedStyle(document.querySelector(".fa")).fontFamily !== "FontAwesome") {
  151. var link = document.createElement('link');
  152. link.rel = 'stylesheet';
  153. link.type = 'text/css';
  154. link.href = '_FontAwesome/css/font-awesome.css';
  155. document.head.insertBefore(link, document.head.firstChild)
  156. }
  157. </script>
  158. <script src="searchindex.js" type="text/javascript" charset="utf-8"></script>
  159. <script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
  160. <script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
  161. <script src="searcher.js" type="text/javascript" charset="utf-8"></script>
  162. <script src="highlight.js"></script>
  163. <script src="book.js"></script>
  164. <!-- Custom JS script -->
  165. </body>
  166. </html>