<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>QuEST: Data structures</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.css" rel="stylesheet" type="text/css"/>
<link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script>
<link href="jquery.smartmenus.bootstrap.css" rel="stylesheet">
<script type="text/javascript" src="jquery.smartmenus.js"></script>
<!-- SmartMenus jQuery Bootstrap Addon -->
<script type="text/javascript" src="jquery.smartmenus.bootstrap.js"></script>
<!-- SmartMenus jQuery plugin -->
</head>
<body>
<nav class="navbar navbar-default" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand"><img alt="Logo" src="logo.png"/></a>
<a class="navbar-brand"><b>QuEST</b> v3.1.0<br>The Quantum Exact Simulation Toolkit</a>
</div>
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel " style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Data structures</div> </div>
</div><!--header-->
<div class="contents">
<p>Precision-agnostic types and data structures for representing numbers, quantum states, and operators.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structComplex.html">Complex</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents one complex number. <a href="structComplex.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structComplexMatrix2.html">ComplexMatrix2</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a 2x2 matrix of complex numbers. <a href="structComplexMatrix2.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structComplexMatrix4.html">ComplexMatrix4</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a 4x4 matrix of complex numbers. <a href="structComplexMatrix4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structComplexMatrixN.html">ComplexMatrixN</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a general 2^N by 2^N matrix of complex numbers. <a href="structComplexMatrixN.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structQuESTEnv.html">QuESTEnv</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Information about the environment the program is running in. <a href="structQuESTEnv.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structQureg.html">Qureg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a system of qubits. <a href="structQureg.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structVector.html">Vector</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a 3-vector of real numbers. <a href="structVector.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga3cf635d2b2e57226c8d5a777f513367e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga3cf635d2b2e57226c8d5a777f513367e">fromComplex</a>(comp)   <a class="el" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a>(comp.real, comp.imag)</td></tr>
<tr class="separator:ga3cf635d2b2e57226c8d5a777f513367e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga927beeee2ba3b110f33ebb440c154ae2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga927beeee2ba3b110f33ebb440c154ae2">getStaticComplexMatrixN</a>(numQubits, re, im)</td></tr>
<tr class="memdesc:ga927beeee2ba3b110f33ebb440c154ae2"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> struct which lives in the stack and so does not need freeing, but cannot be returned beyond the calling scope. <a href="group__type.html#ga927beeee2ba3b110f33ebb440c154ae2">More...</a><br /></td></tr>
<tr class="separator:ga927beeee2ba3b110f33ebb440c154ae2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad863c5878a01051a2726ce94bf365428"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a></td></tr>
<tr class="separator:gad863c5878a01051a2726ce94bf365428"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7740e349b4f8bae6451547680f0ce2d6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a>   double</td></tr>
<tr class="separator:ga7740e349b4f8bae6451547680f0ce2d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga626676e623baa3de702c185736018b2c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga626676e623baa3de702c185736018b2c">QuEST_PREC</a>   2</td></tr>
<tr class="separator:ga626676e623baa3de702c185736018b2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab54c5a1ea720830a7ee394d03fb9f4e9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#gab54c5a1ea720830a7ee394d03fb9f4e9">toComplex</a>(scalar)   ((<a class="el" href="structComplex.html">Complex</a>) {.real = creal(scalar), .imag = cimag(scalar)})</td></tr>
<tr class="separator:gab54c5a1ea720830a7ee394d03fb9f4e9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga1c703cf89629e4e9c7023cd402d67028"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga1c703cf89629e4e9c7023cd402d67028">pauliOpType</a> { <a class="el" href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a63800f45b01ccc2608f754aee850bf4a">PAULI_I</a> =0,
<a class="el" href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a7abac7bb5b71e17382014c443244ad5c">PAULI_X</a> =1,
<a class="el" href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a2c64a9aaee27f6bcfef894d159e759bd">PAULI_Y</a> =2,
<a class="el" href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a085c85cff6ba79c52d8b1e61c42ddddf">PAULI_Z</a> =3
}</td></tr>
<tr class="memdesc:ga1c703cf89629e4e9c7023cd402d67028"><td class="mdescLeft"> </td><td class="mdescRight">Codes for specifying Pauli operators. <a href="group__type.html#ga1c703cf89629e4e9c7023cd402d67028">More...</a><br /></td></tr>
<tr class="separator:ga1c703cf89629e4e9c7023cd402d67028"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabd07eee133dcd4e6ae7c2d2ce4c42978"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structQureg.html">Qureg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#gabd07eee133dcd4e6ae7c2d2ce4c42978">createCloneQureg</a> (<a class="el" href="structQureg.html">Qureg</a> qureg, <a class="el" href="structQuESTEnv.html">QuESTEnv</a> env)</td></tr>
<tr class="memdesc:gabd07eee133dcd4e6ae7c2d2ce4c42978"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="structQureg.html" title="Represents a system of qubits.">Qureg</a> which is an exact clone of the passed qureg, which can be either a statevector or a density matrix. <a href="group__type.html#gabd07eee133dcd4e6ae7c2d2ce4c42978">More...</a><br /></td></tr>
<tr class="separator:gabd07eee133dcd4e6ae7c2d2ce4c42978"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga815103261fb22ea9690e1427571df00e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structComplexMatrixN.html">ComplexMatrixN</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga815103261fb22ea9690e1427571df00e">createComplexMatrixN</a> (int numQubits)</td></tr>
<tr class="memdesc:ga815103261fb22ea9690e1427571df00e"><td class="mdescLeft"> </td><td class="mdescRight">Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary functions. <a href="group__type.html#ga815103261fb22ea9690e1427571df00e">More...</a><br /></td></tr>
<tr class="separator:ga815103261fb22ea9690e1427571df00e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga93e55b6650b408abb30a1d4a8bce757c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structQureg.html">Qureg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga93e55b6650b408abb30a1d4a8bce757c">createDensityQureg</a> (int numQubits, <a class="el" href="structQuESTEnv.html">QuESTEnv</a> env)</td></tr>
<tr class="memdesc:ga93e55b6650b408abb30a1d4a8bce757c"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="structQureg.html" title="Represents a system of qubits.">Qureg</a> for qubits which are represented by a density matrix, and can be in mixed states. <a href="group__type.html#ga93e55b6650b408abb30a1d4a8bce757c">More...</a><br /></td></tr>
<tr class="separator:ga93e55b6650b408abb30a1d4a8bce757c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8ba2c3388dd64d9348c3b091852d36d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structQuESTEnv.html">QuESTEnv</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga8ba2c3388dd64d9348c3b091852d36d4">createQuESTEnv</a> (void)</td></tr>
<tr class="memdesc:ga8ba2c3388dd64d9348c3b091852d36d4"><td class="mdescLeft"> </td><td class="mdescRight">Create the QuEST execution environment. <a href="group__type.html#ga8ba2c3388dd64d9348c3b091852d36d4">More...</a><br /></td></tr>
<tr class="separator:ga8ba2c3388dd64d9348c3b091852d36d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3392816c0643414165c2f5caeec17df0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structQureg.html">Qureg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga3392816c0643414165c2f5caeec17df0">createQureg</a> (int numQubits, <a class="el" href="structQuESTEnv.html">QuESTEnv</a> env)</td></tr>
<tr class="memdesc:ga3392816c0643414165c2f5caeec17df0"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="structQureg.html" title="Represents a system of qubits.">Qureg</a> object representing a set of qubits which will remain in a pure state. <a href="group__type.html#ga3392816c0643414165c2f5caeec17df0">More...</a><br /></td></tr>
<tr class="separator:ga3392816c0643414165c2f5caeec17df0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9df2f3d86be4a6e9aad481665e5e6753"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga9df2f3d86be4a6e9aad481665e5e6753">destroyComplexMatrixN</a> (<a class="el" href="structComplexMatrixN.html">ComplexMatrixN</a> matr)</td></tr>
<tr class="memdesc:ga9df2f3d86be4a6e9aad481665e5e6753"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> instance created with <a class="el" href="group__type.html#ga815103261fb22ea9690e1427571df00e" title="Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary f...">createComplexMatrixN()</a> <a href="group__type.html#ga9df2f3d86be4a6e9aad481665e5e6753">More...</a><br /></td></tr>
<tr class="separator:ga9df2f3d86be4a6e9aad481665e5e6753"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeff624226629d7063a8a776958a4f991"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#gaeff624226629d7063a8a776958a4f991">destroyQuESTEnv</a> (<a class="el" href="structQuESTEnv.html">QuESTEnv</a> env)</td></tr>
<tr class="memdesc:gaeff624226629d7063a8a776958a4f991"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the QuEST environment. <a href="group__type.html#gaeff624226629d7063a8a776958a4f991">More...</a><br /></td></tr>
<tr class="separator:gaeff624226629d7063a8a776958a4f991"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e1e6ad3254892edc2ee08712ea9d692"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692">destroyQureg</a> (<a class="el" href="structQureg.html">Qureg</a> qureg, <a class="el" href="structQuESTEnv.html">QuESTEnv</a> env)</td></tr>
<tr class="memdesc:ga8e1e6ad3254892edc2ee08712ea9d692"><td class="mdescLeft"> </td><td class="mdescRight">Deallocate a <a class="el" href="structQureg.html" title="Represents a system of qubits.">Qureg</a> object representing a set of qubits. <a href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692">More...</a><br /></td></tr>
<tr class="separator:ga8e1e6ad3254892edc2ee08712ea9d692"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga429f1b90b3ef06c786dec8c7f0eda4ce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__type.html#ga429f1b90b3ef06c786dec8c7f0eda4ce">initComplexMatrixN</a> (<a class="el" href="structComplexMatrixN.html">ComplexMatrixN</a> m, <a class="el" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a> real[][1<< m.numQubits], <a class="el" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a> imag[][1<< m.numQubits])</td></tr>
<tr class="memdesc:ga429f1b90b3ef06c786dec8c7f0eda4ce"><td class="mdescLeft"> </td><td class="mdescRight">Initialises a <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> instance to have the passed <code>real</code> and <code>imag</code> values. <a href="group__type.html#ga429f1b90b3ef06c786dec8c7f0eda4ce">More...</a><br /></td></tr>
<tr class="separator:ga429f1b90b3ef06c786dec8c7f0eda4ce"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Precision-agnostic types and data structures for representing numbers, quantum states, and operators. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga3cf635d2b2e57226c8d5a777f513367e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3cf635d2b2e57226c8d5a777f513367e">◆ </a></span>fromComplex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fromComplex</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">comp</td><td>)</td>
<td>   <a class="el" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a>(comp.real, comp.imag)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a <a class="el" href="structComplex.html" title="Represents one complex number.">Complex</a> struct to a qcomp native type</p>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones </dd></dl>
</div>
</div>
<a id="ga927beeee2ba3b110f33ebb440c154ae2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga927beeee2ba3b110f33ebb440c154ae2">◆ </a></span>getStaticComplexMatrixN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define getStaticComplexMatrixN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">numQubits, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">re, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">im </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <a class="code" href="QuEST__common_8c.html#ad67cb67877c941189b0de2c2e67e2026">bindArraysToStackComplexMatrixN</a>( \</div>
<div class="line"> numQubits, \</div>
<div class="line"> (<a class="code" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a>[1<<numQubits][1<<numQubits]) UNPACK_ARR re, \</div>
<div class="line"> (<a class="code" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a>[1<<numQubits][1<<numQubits]) UNPACK_ARR im, \</div>
<div class="line"> (<span class="keywordtype">double</span>*[1<<numQubits]) {NULL}, (<span class="keywordtype">double</span>*[1<<numQubits]) {NULL} \</div>
<div class="line"> )</div>
</div><!-- fragment -->
<p>Creates a <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> struct which lives in the stack and so does not need freeing, but cannot be returned beyond the calling scope. </p>
<p>That is, the .real and .imag arrays of the returned <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> live in the stack as opposed to that returned by <a class="el" href="group__type.html#ga815103261fb22ea9690e1427571df00e" title="Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary f...">createComplexMatrixN()</a> (which live in the heap). Note the real and imag components must be wrapped in paranthesis, e.g. </p><pre class="fragment">ComplexMatrixN u = getStaticComplexMatrixN(1, ({{1,2},{3,4}}), ({{0}}));
</pre><p>Here is an example of an incorrect usage, since a 'local' <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> cannot leave the calling scope (otherwise inducing dangling pointers): </p><pre class="fragment">ComplexMatrixN getMyMatrix(void) {
return getStaticComplexMatrixN(1, ({{1,2},{3,4}}), ({{0}}));
}
</pre><p>This function is actually a single-line anonymous macro, so can be safely invoked within arguments to other functions, e.g. </p><pre class="fragment"> multiQubitUnitary(
qureg, (int[]) {0}, 1,
getStaticComplexMatrixN(1, ({{1,0},{0,1}}), ({{0}}))
);
</pre><p>The returned <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> can be accessed and modified in the same way as that returned by <a class="el" href="group__type.html#ga815103261fb22ea9690e1427571df00e" title="Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary f...">createComplexMatrixN()</a>, e.g. </p><pre class="fragment"> ComplexMatrixN u = getStaticComplexMatrixN(3, ({{0}}), ({{0}}));
for (int i=0; i<8; i++)
for (int j=0; j<8; j++)
u.real[i][j] = .1;
</pre><p>Note that the first argument <code>numQubits</code> must be a literal.</p>
<p>This macro is only callable in C, since it invokes the function <a class="el" href="QuEST__common_8c.html#ad67cb67877c941189b0de2c2e67e2026">bindArraysToStackComplexMatrixN()</a> which is only callable in C.</p>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST_8h_source.html#l03284">3284</a> of file <a class="el" href="QuEST_8h_source.html">QuEST.h</a>.</p>
</div>
</div>
<a id="gad863c5878a01051a2726ce94bf365428"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad863c5878a01051a2726ce94bf365428">◆ </a></span>qcomp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define qcomp</td>
</tr>
</table>
</div><div class="memdoc">
<p>A precision-agnostic operator-overloaded complex number type. <br />
This is a complex analog of <a class="el" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a> and is of single, double or quad precision depending on the value of <a class="el" href="group__type.html#ga626676e623baa3de702c185736018b2c">QuEST_PREC</a>. It resolves to the native complex type provided by <complex.h> for both C99 and C++11, so can be used with operators. It can be constructed with <code><a class="el" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp(real, imag)</a></code>.</p>
<p>For example, in C, </p><div class="fragment"><div class="line"><a class="code" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a> x = 2 + 3i;</div>
<div class="line">x -= 3.2*x; </div>
</div><!-- fragment --><p> and in C++, </p><div class="fragment"><div class="line"><a class="code" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a> x = <a class="code" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a>(2, 3);</div>
<div class="line">x -= 3*x; </div>
</div><!-- fragment --><p>Assuming <code>QuEST_PREC=4</code>, qcomp will be 'complex long double' in C and 'complex<long double>' in C++.</p>
<p>Can be converted to/from <a class="el" href="structComplex.html">Complex</a>, the struct accepted by the QuEST interface, using <a class="el" href="group__type.html#gab54c5a1ea720830a7ee394d03fb9f4e9">toComplex</a> and <a class="el" href="group__type.html#ga3cf635d2b2e57226c8d5a777f513367e">fromComplex</a>.</p>
<dl class="section author"><dt>Authors</dt><dd>Randy Meyers and Dr. Thomas Plum (created C & C++ agnosticism) </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones (created precision agnosticism) </dd></dl>
</div>
</div>
<a id="ga7740e349b4f8bae6451547680f0ce2d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7740e349b4f8bae6451547680f0ce2d6">◆ </a></span>qreal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define qreal   double</td>
</tr>
</table>
</div><div class="memdoc">
<p>A precision-agnostic floating point number, as determined by <a class="el" href="group__type.html#ga626676e623baa3de702c185736018b2c">QuEST_PREC</a>. Is a single, double or quad precision float when <a class="el" href="group__type.html#ga626676e623baa3de702c185736018b2c">QuEST_PREC</a> is 1, 2 or 4 respectively.</p>
<dl class="section author"><dt>Author</dt><dd>Ania Brown </dd>
<dd>
Tyson Jones (doc) </dd></dl>
</div>
</div>
<a id="ga626676e623baa3de702c185736018b2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga626676e623baa3de702c185736018b2c">◆ </a></span>QuEST_PREC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QuEST_PREC   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the precision of <a class="el" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a> and <a class="el" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a>, and generally that of the state-vectors stored by QuEST. <code>QuEST_PREC</code> can be 1, 2 or 4 for single, double and quad precision - requires 4, 8 and 16 bytes per real & imag component per amplitude of the statevector respectively. This should be passed as a macro to the preprocessor during compilation, which overwrites the value explicitly defined in <a class="el" href="QuEST__precision_8h.html">QuEST_precision.h</a>. Note that quad precision is not compatible with most GPUs.</p>
<dl class="section author"><dt>Author</dt><dd>Ania Brown </dd>
<dd>
Tyson Jones (doc) </dd></dl>
</div>
</div>
<a id="gab54c5a1ea720830a7ee394d03fb9f4e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab54c5a1ea720830a7ee394d03fb9f4e9">◆ </a></span>toComplex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define toComplex</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">scalar</td><td>)</td>
<td>   ((<a class="el" href="structComplex.html">Complex</a>) {.real = creal(scalar), .imag = cimag(scalar)})</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="structComplex.html" title="Represents one complex number.">Complex</a> struct, which can be passed to the QuEST API, from a qcomp</p>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga1c703cf89629e4e9c7023cd402d67028"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c703cf89629e4e9c7023cd402d67028">◆ </a></span>pauliOpType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__type.html#ga1c703cf89629e4e9c7023cd402d67028">pauliOpType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Codes for specifying Pauli operators. </p>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga1c703cf89629e4e9c7023cd402d67028a63800f45b01ccc2608f754aee850bf4a"></a>PAULI_I </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga1c703cf89629e4e9c7023cd402d67028a7abac7bb5b71e17382014c443244ad5c"></a>PAULI_X </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga1c703cf89629e4e9c7023cd402d67028a2c64a9aaee27f6bcfef894d159e759bd"></a>PAULI_Y </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga1c703cf89629e4e9c7023cd402d67028a085c85cff6ba79c52d8b1e61c42ddddf"></a>PAULI_Z </td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="QuEST_8h_source.html#l00096">96</a> of file <a class="el" href="QuEST_8h_source.html">QuEST.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> {<a class="code" href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a63800f45b01ccc2608f754aee850bf4a">PAULI_I</a>=0, <a class="code" href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a7abac7bb5b71e17382014c443244ad5c">PAULI_X</a>=1, <a class="code" href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a2c64a9aaee27f6bcfef894d159e759bd">PAULI_Y</a>=2, <a class="code" href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a085c85cff6ba79c52d8b1e61c42ddddf">PAULI_Z</a>=3};</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gabd07eee133dcd4e6ae7c2d2ce4c42978"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabd07eee133dcd4e6ae7c2d2ce4c42978">◆ </a></span>createCloneQureg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structQureg.html">Qureg</a> createCloneQureg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structQureg.html">Qureg</a> </td>
<td class="paramname"><em>qureg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structQuESTEnv.html">QuESTEnv</a> </td>
<td class="paramname"><em>env</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="structQureg.html" title="Represents a system of qubits.">Qureg</a> which is an exact clone of the passed qureg, which can be either a statevector or a density matrix. </p>
<p>That is, it will have the same dimensions as the passed qureg and begin in an identical quantum state. This must be destroyed by the user later with <a class="el" href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692" title="Deallocate a Qureg object representing a set of qubits.">destroyQureg()</a></p>
<dl class="section return"><dt>Returns</dt><dd>an object representing the set of qubits </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">qureg</td><td>an existing qureg to be cloned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">env</td><td>object representing the execution environment (local, multinode etc) </td></tr>
</table>
</dd>
</dl>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST_8c_source.html#l00062">62</a> of file <a class="el" href="QuEST_8c_source.html">QuEST.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="structQureg.html">Qureg</a> newQureg;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="QuEST__internal_8h.html#a365bbb1b80cb00405c8bf1a4fa1ea8e5">statevec_createQureg</a>(&newQureg, qureg.<a class="code" href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">numQubitsInStateVec</a>, env);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  newQureg.<a class="code" href="structQureg.html#acf78445e9435d09f44f0cc832c6aee79">isDensityMatrix</a> = qureg.<a class="code" href="structQureg.html#acf78445e9435d09f44f0cc832c6aee79">isDensityMatrix</a>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  newQureg.<a class="code" href="structQureg.html#ad08dff5316b8937f4b2a1417591543dc">numQubitsRepresented</a> = qureg.<a class="code" href="structQureg.html#ad08dff5316b8937f4b2a1417591543dc">numQubitsRepresented</a>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  newQureg.<a class="code" href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">numQubitsInStateVec</a> = qureg.<a class="code" href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">numQubitsInStateVec</a>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="QuEST__qasm_8c.html#aa5f05644a6cea13e00f828658bcf7a68">qasm_setup</a>(&newQureg);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="QuEST__internal_8h.html#aa4b77089145184d990848cd66993aa8b">statevec_cloneQureg</a>(newQureg, qureg);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> newQureg;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="QuEST_8h_source.html#l00163">Qureg::isDensityMatrix</a>, <a class="el" href="QuEST_8h_source.html#l00167">Qureg::numQubitsInStateVec</a>, <a class="el" href="QuEST_8h_source.html#l00165">Qureg::numQubitsRepresented</a>, <a class="el" href="QuEST__qasm_8c_source.html#l00060">qasm_setup()</a>, <a class="el" href="QuEST__cpu_8c_source.html#l01474">statevec_cloneQureg()</a>, and <a class="el" href="QuEST__cpu_8c_source.html#l01278">statevec_createQureg()</a>.</p>
<p class="reference">Referenced by <a class="el" href="test__data__structures_8cpp_source.html#l00057">TEST_CASE()</a>.</p>
</div>
</div>
<a id="ga815103261fb22ea9690e1427571df00e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga815103261fb22ea9690e1427571df00e">◆ </a></span>createComplexMatrixN()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structComplexMatrixN.html">ComplexMatrixN</a> createComplexMatrixN </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>numQubits</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary functions. </p>
<p>The matrix will have dimensions (2^<code>numQubits</code>) by (2^<code>numQubits</code>), and all elements of .real and .imag are initialised to zero. The <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> must eventually be freed using <a class="el" href="group__type.html#ga9df2f3d86be4a6e9aad481665e5e6753" title="Destroy a ComplexMatrixN instance created with createComplexMatrixN()">destroyComplexMatrixN()</a>. Like <a class="el" href="structComplexMatrix2.html" title="Represents a 2x2 matrix of complex numbers.">ComplexMatrix2</a> and <a class="el" href="structComplexMatrix4.html" title="Represents a 4x4 matrix of complex numbers.">ComplexMatrix4</a>, the returned <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> is safe to return from functions.</p>
<p>One can instead use <a class="el" href="group__type.html#ga927beeee2ba3b110f33ebb440c154ae2" title="Creates a ComplexMatrixN struct which lives in the stack and so does not need freeing,...">getStaticComplexMatrixN()</a> to create a <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> struct in the stack (which doesn't need to be later destroyed).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">numQubits</td><td>the number of qubits of which the returned <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> will correspond </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a dynamic <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> struct, that is one where the .real and .imag fields are arrays kept in the heap and must be later destroyed. </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST_8c_source.html#l01000">1000</a> of file <a class="el" href="QuEST_8c_source.html">QuEST.c</a>.</p>
<div class="fragment"><div class="line"><a name="l01000"></a><span class="lineno"> 1000</span>  {</div>
<div class="line"><a name="l01001"></a><span class="lineno"> 1001</span>  <a class="code" href="QuEST__validation_8c.html#a7c8491926b4c7b4bf8e8123f4464a08e">validateNumQubitsInMatrix</a>(numQubits, __func__);</div>
<div class="line"><a name="l01002"></a><span class="lineno"> 1002</span>  </div>
<div class="line"><a name="l01003"></a><span class="lineno"> 1003</span>  <span class="keywordtype">int</span> numRows = 1 << numQubits;</div>
<div class="line"><a name="l01004"></a><span class="lineno"> 1004</span>  </div>
<div class="line"><a name="l01005"></a><span class="lineno"> 1005</span>  <a class="code" href="structComplexMatrixN.html">ComplexMatrixN</a> m = {</div>
<div class="line"><a name="l01006"></a><span class="lineno"> 1006</span>  .<a class="code" href="structComplexMatrixN.html#a606f7afbc3f65a596bdca21cb43be6a8">numQubits</a> = numQubits,</div>
<div class="line"><a name="l01007"></a><span class="lineno"> 1007</span>  .real = malloc(numRows * <span class="keyword">sizeof</span> *m.<a class="code" href="structComplexMatrixN.html#a446e8a077597e4f76049d547df0c9738">real</a>),</div>
<div class="line"><a name="l01008"></a><span class="lineno"> 1008</span>  .imag = malloc(numRows * <span class="keyword">sizeof</span> *m.<a class="code" href="structComplexMatrixN.html#afde13e469a3b4f179f45e53d1ec0a7cf">imag</a>)};</div>
<div class="line"><a name="l01009"></a><span class="lineno"> 1009</span>  </div>
<div class="line"><a name="l01010"></a><span class="lineno"> 1010</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> n=0; n < 1<<numQubits; n++) {</div>
<div class="line"><a name="l01011"></a><span class="lineno"> 1011</span>  m.<a class="code" href="structComplexMatrixN.html#a446e8a077597e4f76049d547df0c9738">real</a>[n] = calloc(numRows, <span class="keyword">sizeof</span> **m.<a class="code" href="structComplexMatrixN.html#a446e8a077597e4f76049d547df0c9738">real</a>);</div>
<div class="line"><a name="l01012"></a><span class="lineno"> 1012</span>  m.<a class="code" href="structComplexMatrixN.html#afde13e469a3b4f179f45e53d1ec0a7cf">imag</a>[n] = calloc(numRows, <span class="keyword">sizeof</span> **m.<a class="code" href="structComplexMatrixN.html#afde13e469a3b4f179f45e53d1ec0a7cf">imag</a>);</div>
<div class="line"><a name="l01013"></a><span class="lineno"> 1013</span>  }</div>
<div class="line"><a name="l01014"></a><span class="lineno"> 1014</span>  </div>
<div class="line"><a name="l01015"></a><span class="lineno"> 1015</span>  <span class="comment">// error if the ComplexMatrixN was not successfully malloc'ds</span></div>
<div class="line"><a name="l01016"></a><span class="lineno"> 1016</span>  <a class="code" href="QuEST__validation_8c.html#a6a3d99bc780707a90120a78a6e203792">validateMatrixInit</a>(m, __func__);</div>
<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span>  </div>
<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span>  <span class="keywordflow">return</span> m;</div>
<div class="line"><a name="l01019"></a><span class="lineno"> 1019</span>  }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="QuEST_8h_source.html#l00140">ComplexMatrixN::imag</a>, <a class="el" href="QuEST_8h_source.html#l00138">ComplexMatrixN::numQubits</a>, <a class="el" href="QuEST_8h_source.html#l00139">ComplexMatrixN::real</a>, <a class="el" href="QuEST__validation_8c_source.html#l00393">validateMatrixInit()</a>, and <a class="el" href="QuEST__validation_8c_source.html#l00287">validateNumQubitsInMatrix()</a>.</p>
<p class="reference">Referenced by <a class="el" href="QuEST__common_8c_source.html#l00642">densmatr_mixMultiQubitKrausMap()</a>, and <a class="el" href="test__data__structures_8cpp_source.html#l00103">TEST_CASE()</a>.</p>
</div>
</div>
<a id="ga93e55b6650b408abb30a1d4a8bce757c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga93e55b6650b408abb30a1d4a8bce757c">◆ </a></span>createDensityQureg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structQureg.html">Qureg</a> createDensityQureg </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>numQubits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structQuESTEnv.html">QuESTEnv</a> </td>
<td class="paramname"><em>env</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="structQureg.html" title="Represents a system of qubits.">Qureg</a> for qubits which are represented by a density matrix, and can be in mixed states. </p>
<p>Allocates space for a density matrix of probability amplitudes, including space for temporary values to be copied from one other chunk if running the distributed version. Define properties related to the size of the set of qubits. initZeroState is automatically called allocation, so that the density qureg begins in the zero state |0><0|.</p>
<dl class="section return"><dt>Returns</dt><dd>an object representing the set of qubits </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">numQubits</td><td>number of qubits in the system </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">env</td><td>object representing the execution environment (local, multinode etc) </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">exitWithError</td><td>if <code>numQubits</code> <= 0 </td></tr>
</table>
</dd>
</dl>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST_8c_source.html#l00048">48</a> of file <a class="el" href="QuEST_8c_source.html">QuEST.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="QuEST__validation_8c.html#a45428d4a49b8798a8d25a7155f622238">validateNumQubitsInQureg</a>(2*numQubits, env.<a class="code" href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">numRanks</a>, __func__);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="structQureg.html">Qureg</a> qureg;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="QuEST__internal_8h.html#a365bbb1b80cb00405c8bf1a4fa1ea8e5">statevec_createQureg</a>(&qureg, 2*numQubits, env);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  qureg.<a class="code" href="structQureg.html#acf78445e9435d09f44f0cc832c6aee79">isDensityMatrix</a> = 1;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  qureg.<a class="code" href="structQureg.html#ad08dff5316b8937f4b2a1417591543dc">numQubitsRepresented</a> = numQubits;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  qureg.<a class="code" href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">numQubitsInStateVec</a> = 2*numQubits;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="QuEST__qasm_8c.html#aa5f05644a6cea13e00f828658bcf7a68">qasm_setup</a>(&qureg);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="group__init.html#ga2f049055d4a51d0ea4d1a43b5234dedb">initZeroState</a>(qureg); <span class="comment">// safe call to public function</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">return</span> qureg;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="QuEST_8c_source.html#l00111">initZeroState()</a>, <a class="el" href="QuEST_8h_source.html#l00163">Qureg::isDensityMatrix</a>, <a class="el" href="QuEST_8h_source.html#l00167">Qureg::numQubitsInStateVec</a>, <a class="el" href="QuEST_8h_source.html#l00165">Qureg::numQubitsRepresented</a>, <a class="el" href="QuEST_8h_source.html#l00202">QuESTEnv::numRanks</a>, <a class="el" href="QuEST__qasm_8c_source.html#l00060">qasm_setup()</a>, <a class="el" href="QuEST__cpu_8c_source.html#l01278">statevec_createQureg()</a>, and <a class="el" href="QuEST__validation_8c_source.html#l00275">validateNumQubitsInQureg()</a>.</p>
<p class="reference">Referenced by <a class="el" href="test__calculations_8cpp_source.html#l00015">TEST_CASE()</a>.</p>
</div>
</div>
<a id="ga8ba2c3388dd64d9348c3b091852d36d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8ba2c3388dd64d9348c3b091852d36d4">◆ </a></span>createQuESTEnv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structQuESTEnv.html">QuESTEnv</a> createQuESTEnv </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create the QuEST execution environment. </p>
<p>This should be called only once, and the environment should be freed with destroyQuESTEnv at the end of the user's code. If something needs to be done to set up the execution environment, such as initializing MPI when running in distributed mode, it is handled here.</p>
<dl class="section return"><dt>Returns</dt><dd>object representing the execution environment. A single instance is used for each program </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Ania Brown </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST__cpu__distributed_8c_source.html#l00129">129</a> of file <a class="el" href="QuEST__cpu__distributed_8c_source.html">QuEST_cpu_distributed.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  {</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <a class="code" href="structQuESTEnv.html">QuESTEnv</a> env;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="comment">// init MPI environment</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">int</span> rank, numRanks, initialized;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  MPI_Initialized(&initialized);</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">if</span> (!initialized){</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  MPI_Init(NULL, NULL);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  MPI_Comm_size(MPI_COMM_WORLD, &numRanks);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  MPI_Comm_rank(MPI_COMM_WORLD, &rank);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  env.<a class="code" href="structQuESTEnv.html#aa648bb336cf8598467cb62db00b9cee8">rank</a>=rank;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  env.<a class="code" href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">numRanks</a>=numRanks;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  printf(<span class="stringliteral">"ERROR: Trying to initialize QuESTEnv multiple times. Ignoring...\n"</span>);</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">// ensure env is initialised anyway, so the compiler is happy</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  MPI_Comm_size(MPI_COMM_WORLD, &numRanks);</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  MPI_Comm_rank(MPI_COMM_WORLD, &rank);</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  env.<a class="code" href="structQuESTEnv.html#aa648bb336cf8598467cb62db00b9cee8">rank</a>=rank;</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  env.<a class="code" href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">numRanks</a>=numRanks;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  }</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <a class="code" href="QuEST__validation_8c.html#ad893327ebd2123508493d445868bfcd7">validateNumRanks</a>(env.<a class="code" href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">numRanks</a>, __func__);</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  </div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <a class="code" href="group__debug.html#gaa8437ef3bf135231e2916e64dde1c94e">seedQuESTDefault</a>();</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  </div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordflow">return</span> env;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="QuEST__gpu_8cu_source.html#l00336">GPUExists()</a>, <a class="el" href="QuEST_8h_source.html#l00202">QuESTEnv::numRanks</a>, <a class="el" href="QuEST_8h_source.html#l00201">QuESTEnv::rank</a>, <a class="el" href="QuEST__cpu__distributed_8c_source.html#l01321">seedQuESTDefault()</a>, and <a class="el" href="QuEST__validation_8c_source.html#l00261">validateNumRanks()</a>.</p>
<p class="reference">Referenced by <a class="el" href="main_8cpp_source.html#l00034">main()</a>.</p>
</div>
</div>
<a id="ga3392816c0643414165c2f5caeec17df0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3392816c0643414165c2f5caeec17df0">◆ </a></span>createQureg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structQureg.html">Qureg</a> createQureg </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>numQubits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structQuESTEnv.html">QuESTEnv</a> </td>
<td class="paramname"><em>env</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="structQureg.html" title="Represents a system of qubits.">Qureg</a> object representing a set of qubits which will remain in a pure state. </p>
<p>Allocate space for state vector of probability amplitudes, including space for temporary values to be copied from one other chunk if running the distributed version. Define properties related to the size of the set of qubits. The qubits are initialised in the zero state (i.e. initZeroState is automatically called)</p>
<dl class="section return"><dt>Returns</dt><dd>an object representing the set of qubits </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">numQubits</td><td>number of qubits in the system </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">env</td><td>object representing the execution environment (local, multinode etc) </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">exitWithError</td><td>if <code>numQubits</code> <= 0 </td></tr>
</table>
</dd>
</dl>
<dl class="section author"><dt>Author</dt><dd>Ania Brown </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST_8c_source.html#l00034">34</a> of file <a class="el" href="QuEST_8c_source.html">QuEST.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="QuEST__validation_8c.html#a45428d4a49b8798a8d25a7155f622238">validateNumQubitsInQureg</a>(numQubits, env.<a class="code" href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">numRanks</a>, __func__);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="structQureg.html">Qureg</a> qureg;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="QuEST__internal_8h.html#a365bbb1b80cb00405c8bf1a4fa1ea8e5">statevec_createQureg</a>(&qureg, numQubits, env);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  qureg.<a class="code" href="structQureg.html#acf78445e9435d09f44f0cc832c6aee79">isDensityMatrix</a> = 0;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  qureg.<a class="code" href="structQureg.html#ad08dff5316b8937f4b2a1417591543dc">numQubitsRepresented</a> = numQubits;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  qureg.<a class="code" href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">numQubitsInStateVec</a> = numQubits;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="QuEST__qasm_8c.html#aa5f05644a6cea13e00f828658bcf7a68">qasm_setup</a>(&qureg);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="group__init.html#ga2f049055d4a51d0ea4d1a43b5234dedb">initZeroState</a>(qureg); <span class="comment">// safe call to public function</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> qureg;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="QuEST_8c_source.html#l00111">initZeroState()</a>, <a class="el" href="QuEST_8h_source.html#l00163">Qureg::isDensityMatrix</a>, <a class="el" href="QuEST_8h_source.html#l00167">Qureg::numQubitsInStateVec</a>, <a class="el" href="QuEST_8h_source.html#l00165">Qureg::numQubitsRepresented</a>, <a class="el" href="QuEST_8h_source.html#l00202">QuESTEnv::numRanks</a>, <a class="el" href="QuEST__qasm_8c_source.html#l00060">qasm_setup()</a>, <a class="el" href="QuEST__cpu_8c_source.html#l01278">statevec_createQureg()</a>, and <a class="el" href="QuEST__validation_8c_source.html#l00275">validateNumQubitsInQureg()</a>.</p>
<p class="reference">Referenced by <a class="el" href="test__calculations_8cpp_source.html#l00015">TEST_CASE()</a>.</p>
</div>
</div>
<a id="ga9df2f3d86be4a6e9aad481665e5e6753"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9df2f3d86be4a6e9aad481665e5e6753">◆ </a></span>destroyComplexMatrixN()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void destroyComplexMatrixN </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structComplexMatrixN.html">ComplexMatrixN</a> </td>
<td class="paramname"><em>matr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> instance created with <a class="el" href="group__type.html#ga815103261fb22ea9690e1427571df00e" title="Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary f...">createComplexMatrixN()</a> </p>
<p>It is invalid to attempt to destroy a matrix created with <a class="el" href="group__type.html#ga927beeee2ba3b110f33ebb440c154ae2" title="Creates a ComplexMatrixN struct which lives in the stack and so does not need freeing,...">getStaticComplexMatrixN()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">matr</td><td>the dynamic matrix (created with <a class="el" href="group__type.html#ga815103261fb22ea9690e1427571df00e" title="Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary f...">createComplexMatrixN()</a>) to deallocate </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">exitWithError</td><td>if <code>matr</code> was not yet allocated. </td></tr>
<tr><td class="paramname">malloc_error</td><td>if <code>matr</code> was static (created with <a class="el" href="group__type.html#ga927beeee2ba3b110f33ebb440c154ae2" title="Creates a ComplexMatrixN struct which lives in the stack and so does not need freeing,...">getStaticComplexMatrixN()</a>) </td></tr>
</table>
</dd>
</dl>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST_8c_source.html#l01021">1021</a> of file <a class="el" href="QuEST_8c_source.html">QuEST.c</a>.</p>
<div class="fragment"><div class="line"><a name="l01021"></a><span class="lineno"> 1021</span>  {</div>
<div class="line"><a name="l01022"></a><span class="lineno"> 1022</span>  <span class="comment">/* this checks m.real/imag != NULL, which is only ever set when the mallocs </span></div>
<div class="line"><a name="l01023"></a><span class="lineno"> 1023</span> <span class="comment"> * in createComplexMatrixN fail, which already prompts an error. Hence </span></div>
<div class="line"><a name="l01024"></a><span class="lineno"> 1024</span> <span class="comment"> * this check if useless </span></div>
<div class="line"><a name="l01025"></a><span class="lineno"> 1025</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01026"></a><span class="lineno"> 1026</span>  <a class="code" href="QuEST__validation_8c.html#a6a3d99bc780707a90120a78a6e203792">validateMatrixInit</a>(m, __func__);</div>
<div class="line"><a name="l01027"></a><span class="lineno"> 1027</span>  </div>
<div class="line"><a name="l01028"></a><span class="lineno"> 1028</span>  <span class="keywordtype">int</span> numRows = 1 << m.numQubits;</div>
<div class="line"><a name="l01029"></a><span class="lineno"> 1029</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> r=0; r < numRows; r++) {</div>
<div class="line"><a name="l01030"></a><span class="lineno"> 1030</span>  free(m.real[r]);</div>
<div class="line"><a name="l01031"></a><span class="lineno"> 1031</span>  free(m.imag[r]);</div>
<div class="line"><a name="l01032"></a><span class="lineno"> 1032</span>  }</div>
<div class="line"><a name="l01033"></a><span class="lineno"> 1033</span>  free(m.real);</div>
<div class="line"><a name="l01034"></a><span class="lineno"> 1034</span>  free(m.imag);</div>
<div class="line"><a name="l01035"></a><span class="lineno"> 1035</span> }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="QuEST_8h_source.html#l00140">ComplexMatrixN::imag</a>, <a class="el" href="QuEST_8h_source.html#l00138">ComplexMatrixN::numQubits</a>, <a class="el" href="QuEST_8h_source.html#l00139">ComplexMatrixN::real</a>, and <a class="el" href="QuEST__validation_8c_source.html#l00393">validateMatrixInit()</a>.</p>
<p class="reference">Referenced by <a class="el" href="QuEST__common_8c_source.html#l00642">densmatr_mixMultiQubitKrausMap()</a>, and <a class="el" href="test__data__structures_8cpp_source.html#l00103">TEST_CASE()</a>.</p>
</div>
</div>
<a id="gaeff624226629d7063a8a776958a4f991"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeff624226629d7063a8a776958a4f991">◆ </a></span>destroyQuESTEnv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void destroyQuESTEnv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structQuESTEnv.html">QuESTEnv</a> </td>
<td class="paramname"><em>env</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the QuEST environment. </p>
<p>If something needs to be done to clean up the execution environment, such as finalizing MPI when running in distributed mode, it is handled here</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">env</td><td>object representing the execution environment. A single instance is used for each program </td></tr>
</table>
</dd>
</dl>
<dl class="section author"><dt>Author</dt><dd>Ania Brown </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST__cpu__distributed_8c_source.html#l00172">172</a> of file <a class="el" href="QuEST__cpu__distributed_8c_source.html">QuEST_cpu_distributed.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  {</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keywordtype">int</span> finalized;</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  MPI_Finalized(&finalized);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordflow">if</span> (!finalized) MPI_Finalize();</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordflow">else</span> printf(<span class="stringliteral">"ERROR: Trying to close QuESTEnv multiple times. Ignoring\n"</span>);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> }</div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="main_8cpp_source.html#l00034">main()</a>.</p>
</div>
</div>
<a id="ga8e1e6ad3254892edc2ee08712ea9d692"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e1e6ad3254892edc2ee08712ea9d692">◆ </a></span>destroyQureg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void destroyQureg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structQureg.html">Qureg</a> </td>
<td class="paramname"><em>qureg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structQuESTEnv.html">QuESTEnv</a> </td>
<td class="paramname"><em>env</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deallocate a <a class="el" href="structQureg.html" title="Represents a system of qubits.">Qureg</a> object representing a set of qubits. </p>
<p>Free memory allocated to state vector of probability amplitudes, including temporary vector for values copied from another chunk if running the distributed version.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">qureg</td><td>object to be deallocated </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">env</td><td>object representing the execution environment (local, multinode etc) </td></tr>
</table>
</dd>
</dl>
<dl class="section author"><dt>Author</dt><dd>Ania Brown </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST_8c_source.html#l00075">75</a> of file <a class="el" href="QuEST_8c_source.html">QuEST.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="QuEST__internal_8h.html#a2a52ad9f9ad9b2fd6a76f6d433b3b217">statevec_destroyQureg</a>(qureg, env);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="QuEST__qasm_8c.html#ae5ef90741274785eb1ebbbe828b7df8a">qasm_free</a>(qureg);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="QuEST__qasm_8c_source.html#l00500">qasm_free()</a>, and <a class="el" href="QuEST__cpu_8c_source.html#l01316">statevec_destroyQureg()</a>.</p>
<p class="reference">Referenced by <a class="el" href="test__calculations_8cpp_source.html#l00015">TEST_CASE()</a>.</p>
</div>
</div>
<a id="ga429f1b90b3ef06c786dec8c7f0eda4ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga429f1b90b3ef06c786dec8c7f0eda4ce">◆ </a></span>initComplexMatrixN()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void initComplexMatrixN </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structComplexMatrixN.html">ComplexMatrixN</a> </td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a> </td>
<td class="paramname"><em>real</em>[][1<< m.numQubits], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a> </td>
<td class="paramname"><em>imag</em>[][1<< m.numQubits] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialises a <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a> instance to have the passed <code>real</code> and <code>imag</code> values. </p>
<p>This allows succint population of any-sized <a class="el" href="structComplexMatrixN.html" title="Represents a general 2^N by 2^N matrix of complex numbers.">ComplexMatrixN</a>, e.g. through 2D arrays: </p><pre class="fragment">ComplexMatrixN m = createComplexMatrixN(3);
initComplexMatrixN(m,
(qreal[8][8]) {{1,2,3,4,5,6,7,8}, {0}},
(qreal[8][8]) {{0}});
</pre><p><code>m</code> can be created by either <a class="el" href="group__type.html#ga815103261fb22ea9690e1427571df00e" title="Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary f...">createComplexMatrixN()</a> or <a class="el" href="group__type.html#ga927beeee2ba3b110f33ebb440c154ae2" title="Creates a ComplexMatrixN struct which lives in the stack and so does not need freeing,...">getStaticComplexMatrixN()</a>.</p>
<p>This function is only callable in C, since C++ signatures cannot contain variable-length 2D arrays</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">m</td><td>the matrix to initialise </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">real</td><td>matrix of real values; can be 2D array of array of pointers </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">imag</td><td>matrix of imaginary values; can be 2D array of array of pointers </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">exitWithError</td><td>if <code>m</code> has not been allocated (e.g. with <a class="el" href="group__type.html#ga815103261fb22ea9690e1427571df00e" title="Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary f...">createComplexMatrixN()</a>) </td></tr>
</table>
</dd>
</dl>
<dl class="section author"><dt>Author</dt><dd>Tyson Jones </dd></dl>
<p class="definition">Definition at line <a class="el" href="QuEST_8c_source.html#l01037">1037</a> of file <a class="el" href="QuEST_8c_source.html">QuEST.c</a>.</p>
<div class="fragment"><div class="line"><a name="l01037"></a><span class="lineno"> 1037</span>  {</div>
<div class="line"><a name="l01038"></a><span class="lineno"> 1038</span>  <a class="code" href="QuEST__validation_8c.html#a6a3d99bc780707a90120a78a6e203792">validateMatrixInit</a>(m, __func__);</div>
<div class="line"><a name="l01039"></a><span class="lineno"> 1039</span>  </div>
<div class="line"><a name="l01040"></a><span class="lineno"> 1040</span>  <span class="keywordtype">int</span> dim = 1 << m.<a class="code" href="structComplexMatrixN.html#a606f7afbc3f65a596bdca21cb43be6a8">numQubits</a>;</div>
<div class="line"><a name="l01041"></a><span class="lineno"> 1041</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i=0; i<dim; i++)</div>
<div class="line"><a name="l01042"></a><span class="lineno"> 1042</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j=0; j<dim; j++) {</div>
<div class="line"><a name="l01043"></a><span class="lineno"> 1043</span>  m.<a class="code" href="structComplexMatrixN.html#a446e8a077597e4f76049d547df0c9738">real</a>[i][j] = re[i][j];</div>
<div class="line"><a name="l01044"></a><span class="lineno"> 1044</span>  m.<a class="code" href="structComplexMatrixN.html#afde13e469a3b4f179f45e53d1ec0a7cf">imag</a>[i][j] = im[i][j];</div>
<div class="line"><a name="l01045"></a><span class="lineno"> 1045</span>  }</div>
<div class="line"><a name="l01046"></a><span class="lineno"> 1046</span> }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="QuEST_8h_source.html#l00140">ComplexMatrixN::imag</a>, <a class="el" href="QuEST_8h_source.html#l00138">ComplexMatrixN::numQubits</a>, <a class="el" href="QuEST_8h_source.html#l00139">ComplexMatrixN::real</a>, and <a class="el" href="QuEST__validation_8c_source.html#l00393">validateMatrixInit()</a>.</p>
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="agroup__type_html_gga1c703cf89629e4e9c7023cd402d67028a085c85cff6ba79c52d8b1e61c42ddddf"><div class="ttname"><a href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a085c85cff6ba79c52d8b1e61c42ddddf">PAULI_Z</a></div><div class="ttdeci">@ PAULI_Z</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00096">QuEST.h:96</a></div></div>
<div class="ttc" id="astructQuESTEnv_html_aa648bb336cf8598467cb62db00b9cee8"><div class="ttname"><a href="structQuESTEnv.html#aa648bb336cf8598467cb62db00b9cee8">QuESTEnv::rank</a></div><div class="ttdeci">int rank</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00201">QuEST.h:201</a></div></div>
<div class="ttc" id="aQuEST__qasm_8c_html_ae5ef90741274785eb1ebbbe828b7df8a"><div class="ttname"><a href="QuEST__qasm_8c.html#ae5ef90741274785eb1ebbbe828b7df8a">qasm_free</a></div><div class="ttdeci">void qasm_free(Qureg qureg)</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__qasm_8c_source.html#l00500">QuEST_qasm.c:500</a></div></div>
<div class="ttc" id="agroup__type_html_gga1c703cf89629e4e9c7023cd402d67028a63800f45b01ccc2608f754aee850bf4a"><div class="ttname"><a href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a63800f45b01ccc2608f754aee850bf4a">PAULI_I</a></div><div class="ttdeci">@ PAULI_I</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00096">QuEST.h:96</a></div></div>
<div class="ttc" id="aQuEST__validation_8c_html_a45428d4a49b8798a8d25a7155f622238"><div class="ttname"><a href="QuEST__validation_8c.html#a45428d4a49b8798a8d25a7155f622238">validateNumQubitsInQureg</a></div><div class="ttdeci">void validateNumQubitsInQureg(int numQubits, int numRanks, const char *caller)</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__validation_8c_source.html#l00275">QuEST_validation.c:275</a></div></div>
<div class="ttc" id="aQuEST__internal_8h_html_a2a52ad9f9ad9b2fd6a76f6d433b3b217"><div class="ttname"><a href="QuEST__internal_8h.html#a2a52ad9f9ad9b2fd6a76f6d433b3b217">statevec_destroyQureg</a></div><div class="ttdeci">void statevec_destroyQureg(Qureg qureg, QuESTEnv env)</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__cpu_8c_source.html#l01316">QuEST_cpu.c:1316</a></div></div>
<div class="ttc" id="astructQuESTEnv_html"><div class="ttname"><a href="structQuESTEnv.html">QuESTEnv</a></div><div class="ttdoc">Information about the environment the program is running in.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00199">QuEST.h:199</a></div></div>
<div class="ttc" id="aQuEST__common_8c_html_ad67cb67877c941189b0de2c2e67e2026"><div class="ttname"><a href="QuEST__common_8c.html#ad67cb67877c941189b0de2c2e67e2026">bindArraysToStackComplexMatrixN</a></div><div class="ttdeci">ComplexMatrixN bindArraysToStackComplexMatrixN(int numQubits, qreal re[][1<< numQubits], qreal im[][1<< numQubits], qreal **reStorage, qreal **imStorage)</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__common_8c_source.html#l00606">QuEST_common.c:606</a></div></div>
<div class="ttc" id="astructComplexMatrixN_html"><div class="ttname"><a href="structComplexMatrixN.html">ComplexMatrixN</a></div><div class="ttdoc">Represents a general 2^N by 2^N matrix of complex numbers.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00136">QuEST.h:136</a></div></div>
<div class="ttc" id="agroup__type_html_ga7740e349b4f8bae6451547680f0ce2d6"><div class="ttname"><a href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a></div><div class="ttdeci">#define qreal</div></div>
<div class="ttc" id="aQuEST__validation_8c_html_a6a3d99bc780707a90120a78a6e203792"><div class="ttname"><a href="QuEST__validation_8c.html#a6a3d99bc780707a90120a78a6e203792">validateMatrixInit</a></div><div class="ttdeci">void validateMatrixInit(ComplexMatrixN matr, const char *caller)</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__validation_8c_source.html#l00393">QuEST_validation.c:393</a></div></div>
<div class="ttc" id="agroup__type_html_gga1c703cf89629e4e9c7023cd402d67028a7abac7bb5b71e17382014c443244ad5c"><div class="ttname"><a href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a7abac7bb5b71e17382014c443244ad5c">PAULI_X</a></div><div class="ttdeci">@ PAULI_X</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00096">QuEST.h:96</a></div></div>
<div class="ttc" id="astructQureg_html_a0a86e8a50ea8c998b4a0a6640c5a1218"><div class="ttname"><a href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">Qureg::numQubitsInStateVec</a></div><div class="ttdeci">int numQubitsInStateVec</div><div class="ttdoc">Number of qubits in the state-vector - this is double the number represented for mixed states.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00167">QuEST.h:167</a></div></div>
<div class="ttc" id="agroup__type_html_gad863c5878a01051a2726ce94bf365428"><div class="ttname"><a href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a></div><div class="ttdeci">#define qcomp</div></div>
<div class="ttc" id="aQuEST__internal_8h_html_aa4b77089145184d990848cd66993aa8b"><div class="ttname"><a href="QuEST__internal_8h.html#aa4b77089145184d990848cd66993aa8b">statevec_cloneQureg</a></div><div class="ttdeci">void statevec_cloneQureg(Qureg targetQureg, Qureg copyQureg)</div><div class="ttdoc">works for both statevectors and density matrices</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__cpu_8c_source.html#l01474">QuEST_cpu.c:1474</a></div></div>
<div class="ttc" id="astructQuESTEnv_html_af22aacd7c9905accae28484785c193b4"><div class="ttname"><a href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">QuESTEnv::numRanks</a></div><div class="ttdeci">int numRanks</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00202">QuEST.h:202</a></div></div>
<div class="ttc" id="agroup__type_html_gga1c703cf89629e4e9c7023cd402d67028a2c64a9aaee27f6bcfef894d159e759bd"><div class="ttname"><a href="group__type.html#gga1c703cf89629e4e9c7023cd402d67028a2c64a9aaee27f6bcfef894d159e759bd">PAULI_Y</a></div><div class="ttdeci">@ PAULI_Y</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00096">QuEST.h:96</a></div></div>
<div class="ttc" id="astructComplexMatrixN_html_a446e8a077597e4f76049d547df0c9738"><div class="ttname"><a href="structComplexMatrixN.html#a446e8a077597e4f76049d547df0c9738">ComplexMatrixN::real</a></div><div class="ttdeci">qreal ** real</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00139">QuEST.h:139</a></div></div>
<div class="ttc" id="astructQureg_html"><div class="ttname"><a href="structQureg.html">Qureg</a></div><div class="ttdoc">Represents a system of qubits.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00160">QuEST.h:160</a></div></div>
<div class="ttc" id="aQuEST__validation_8c_html_a7c8491926b4c7b4bf8e8123f4464a08e"><div class="ttname"><a href="QuEST__validation_8c.html#a7c8491926b4c7b4bf8e8123f4464a08e">validateNumQubitsInMatrix</a></div><div class="ttdeci">void validateNumQubitsInMatrix(int numQubits, const char *caller)</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__validation_8c_source.html#l00287">QuEST_validation.c:287</a></div></div>
<div class="ttc" id="astructComplexMatrixN_html_afde13e469a3b4f179f45e53d1ec0a7cf"><div class="ttname"><a href="structComplexMatrixN.html#afde13e469a3b4f179f45e53d1ec0a7cf">ComplexMatrixN::imag</a></div><div class="ttdeci">qreal ** imag</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00140">QuEST.h:140</a></div></div>
<div class="ttc" id="agroup__debug_html_gaa8437ef3bf135231e2916e64dde1c94e"><div class="ttname"><a href="group__debug.html#gaa8437ef3bf135231e2916e64dde1c94e">seedQuESTDefault</a></div><div class="ttdeci">void seedQuESTDefault()</div><div class="ttdoc">Seed the Mersenne Twister used for random number generation in the QuEST environment with an example ...</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__cpu__distributed_8c_source.html#l01321">QuEST_cpu_distributed.c:1321</a></div></div>
<div class="ttc" id="astructQureg_html_acf78445e9435d09f44f0cc832c6aee79"><div class="ttname"><a href="structQureg.html#acf78445e9435d09f44f0cc832c6aee79">Qureg::isDensityMatrix</a></div><div class="ttdeci">int isDensityMatrix</div><div class="ttdoc">Whether this instance is a density-state representation.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00163">QuEST.h:163</a></div></div>
<div class="ttc" id="astructComplexMatrixN_html_a606f7afbc3f65a596bdca21cb43be6a8"><div class="ttname"><a href="structComplexMatrixN.html#a606f7afbc3f65a596bdca21cb43be6a8">ComplexMatrixN::numQubits</a></div><div class="ttdeci">int numQubits</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00138">QuEST.h:138</a></div></div>
<div class="ttc" id="astructQureg_html_ad08dff5316b8937f4b2a1417591543dc"><div class="ttname"><a href="structQureg.html#ad08dff5316b8937f4b2a1417591543dc">Qureg::numQubitsRepresented</a></div><div class="ttdeci">int numQubitsRepresented</div><div class="ttdoc">The number of qubits represented in either the state-vector or density matrix.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00165">QuEST.h:165</a></div></div>
<div class="ttc" id="aQuEST__validation_8c_html_ad893327ebd2123508493d445868bfcd7"><div class="ttname"><a href="QuEST__validation_8c.html#ad893327ebd2123508493d445868bfcd7">validateNumRanks</a></div><div class="ttdeci">void validateNumRanks(int numRanks, const char *caller)</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__validation_8c_source.html#l00261">QuEST_validation.c:261</a></div></div>
<div class="ttc" id="agroup__init_html_ga2f049055d4a51d0ea4d1a43b5234dedb"><div class="ttname"><a href="group__init.html#ga2f049055d4a51d0ea4d1a43b5234dedb">initZeroState</a></div><div class="ttdeci">void initZeroState(Qureg qureg)</div><div class="ttdoc">Initialise a set of qubits to the classical zero state .</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8c_source.html#l00111">QuEST.c:111</a></div></div>
<div class="ttc" id="aQuEST__qasm_8c_html_aa5f05644a6cea13e00f828658bcf7a68"><div class="ttname"><a href="QuEST__qasm_8c.html#aa5f05644a6cea13e00f828658bcf7a68">qasm_setup</a></div><div class="ttdeci">void qasm_setup(Qureg *qureg)</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__qasm_8c_source.html#l00060">QuEST_qasm.c:60</a></div></div>
<div class="ttc" id="aQuEST__internal_8h_html_a365bbb1b80cb00405c8bf1a4fa1ea8e5"><div class="ttname"><a href="QuEST__internal_8h.html#a365bbb1b80cb00405c8bf1a4fa1ea8e5">statevec_createQureg</a></div><div class="ttdeci">void statevec_createQureg(Qureg *qureg, int numQubits, QuESTEnv env)</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__cpu_8c_source.html#l01278">QuEST_cpu.c:1278</a></div></div>
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
</body>
<script type="text/javascript" src="boot.js"></script>
</html>
