<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="Source to the Rust file `src/lib.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>lib.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
</pre><pre class="rust ">
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">missing_debug_implementations</span>, <span class="ident">missing_docs</span>, <span class="ident">trivial_casts</span>, <span class="ident">trivial_numeric_casts</span>,
<span class="ident">unused_extern_crates</span>, <span class="ident">unused_import_braces</span>, <span class="ident">unused_qualifications</span>, <span class="ident">unused_results</span>)]</span>
<span class="doccomment">//! An Open Source, High Performance & Hardware Accelerated, Quantum Computer Simulator in Rust</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This crate is a library with the aim to provide fast and effecient simulation of algorithms</span>
<span class="doccomment">//! for quantum computers, while also being easy to use and abstracting away the management of the</span>
<span class="doccomment">//! OpenCL Devices</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The best place to start with this library is with the [user guide](https://qcgpu.github.io/qcgpu/book),</span>
<span class="doccomment">//! along with the docs (you're looking at them) and the [source code](https://github.com/QCGPU/QCGPU-rust)</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Features</span>
<span class="doccomment">//! * Simulation of arbitrary quantum algorithms</span>
<span class="doccomment">//! * Optional simulation of decoherence</span>
<span class="doccomment">//! * Optimized for maximally entangled states</span>
<span class="doccomment">//! * Accelerated with GPUs, FPGAs and other OpenCL devices</span>
<span class="doccomment">//! * Example implementations of Grover, Deutsch-Jozsa, Bernstein-Vazirani and Shors algorithm</span>
<span class="doccomment">//! * Implements Hadamard, Pauli and phase gates, with support for arbitrary gates</span>
<span class="doccomment">//! * Support for arbitrary controlled gates</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num_complex</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">ocl</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rand</span>;
<span class="kw">mod</span> <span class="ident">kernel</span>;
<span class="kw">mod</span> <span class="ident">state</span>;
<span class="kw">mod</span> <span class="ident">utilities</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">gates</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">state</span>::<span class="ident">State</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">gates</span>::<span class="ident">Gate</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">utilities</span>::{<span class="ident">gcd</span>, <span class="ident">get_width</span>};
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "qcgpu";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>