<!-- 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: test_data_structures.cpp Source File</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_70834f0dcd10de01d2e35ab402a2238e.html">tysonjones</a></li><li class="navelem"><a class="el" href="dir_1957401ef452be7528010ba0f4832a45.html">Desktop</a></li><li class="navelem"><a class="el" href="dir_dee4414d5d72b49a9429e079789ffd08.html">GithubRepos</a></li><li class="navelem"><a class="el" href="dir_a89b43d59316bb5045aa22bb53a67d29.html">QuEST</a></li><li class="navelem"><a class="el" href="dir_e791dcdec8c5d319683d04485e4067ac.html">tests</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">test_data_structures.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="test__data__structures_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  </div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#include "catch.hpp"</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include "<a class="code" href="QuEST_8h.html">QuEST.h</a>"</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="utilities_8hpp.html">utilities.hpp</a>"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/* allows concise use of Contains in catch's REQUIRE_THROWS_WITH */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">using</span> Catch::Matchers::Contains;</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c"> 15</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"fromComplex"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <a class="code" href="structComplex.html">Complex</a> a = {.<a class="code" href="structComplex.html#ab5b2e2eca02131fc74b289a83636cbe3">real</a>=.5, .imag=-.2};</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <a class="code" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a> b = <a class="code" href="group__type.html#ga3cf635d2b2e57226c8d5a777f513367e">fromComplex</a>(a);</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  REQUIRE( a.<a class="code" href="structComplex.html#ab5b2e2eca02131fc74b289a83636cbe3">real</a> == real(b) );</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  REQUIRE( a.<a class="code" href="structComplex.html#a84f5439aad0ef495efdd3b4c1c02d27e">imag</a> == imag(b) );</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> }</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="group__unittest.html#ga52ecd483c4f7634460972b70983de21c"> 30</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"getStaticComplexMatrixN"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="comment">/* use of this function is illegal in C++ */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  SUCCEED( );</div>
<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>  </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>  </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="group__unittest.html#gabab3cf31bd73b8334ef6d2e7d2b2ea67"> 42</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"toComplex"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="group__type.html#gad863c5878a01051a2726ce94bf365428">qcomp</a> a = .5 - .2i;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="structComplex.html">Complex</a> b = <a class="code" href="group__type.html#gab54c5a1ea720830a7ee394d03fb9f4e9">toComplex</a>(a);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  REQUIRE( real(a) == b.<a class="code" href="structComplex.html#ab5b2e2eca02131fc74b289a83636cbe3">real</a> );</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  REQUIRE( imag(a) == b.<a class="code" href="structComplex.html#a84f5439aad0ef495efdd3b4c1c02d27e">imag</a> );</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> }</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>  </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__unittest.html#ga6d178e69b7654ae26e9f6365fd8208e8"> 57</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"createCloneQureg"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  SECTION( <span class="stringliteral">"state-vector"</span> ) {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="structQureg.html">Qureg</a> a = <a class="code" href="group__type.html#ga3392816c0643414165c2f5caeec17df0">createQureg</a>(<a class="code" href="utilities_8hpp.html#a2f52338126bb8cdf7fcf68eaf01c546a">NUM_QUBITS</a>, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>); </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="structQureg.html">Qureg</a> b = <a class="code" href="group__type.html#gabd07eee133dcd4e6ae7c2d2ce4c42978">createCloneQureg</a>(a, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</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>  <span class="comment">// check properties are the same</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  REQUIRE( b.<a class="code" href="structQureg.html#acf78445e9435d09f44f0cc832c6aee79">isDensityMatrix</a> == a.<a class="code" href="structQureg.html#acf78445e9435d09f44f0cc832c6aee79">isDensityMatrix</a> );</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  REQUIRE( b.<a class="code" href="structQureg.html#ad08dff5316b8937f4b2a1417591543dc">numQubitsRepresented</a> == a.<a class="code" href="structQureg.html#ad08dff5316b8937f4b2a1417591543dc">numQubitsRepresented</a> );</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  REQUIRE( b.<a class="code" href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">numQubitsInStateVec</a> == a.<a class="code" href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">numQubitsInStateVec</a> );</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  REQUIRE( b.<a class="code" href="structQureg.html#ab0ea0358482b62f43fdd781469607d97">numAmpsPerChunk</a> == a.<a class="code" href="structQureg.html#ab0ea0358482b62f43fdd781469607d97">numAmpsPerChunk</a> );</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  REQUIRE( b.<a class="code" href="structQureg.html#adef4935cac95763c29164cf99b144ed4">numAmpsTotal</a> == a.<a class="code" href="structQureg.html#adef4935cac95763c29164cf99b144ed4">numAmpsTotal</a> );</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// check state-vector is the same (works for GPU and distributed)</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  REQUIRE( <a class="code" href="group__testutilities.html#ga45cc399adad2e2a67b0124851189fae5">areEqual</a>(a, b) ); </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692">destroyQureg</a>(a, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692">destroyQureg</a>(b, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  SECTION( <span class="stringliteral">"density-matrix"</span> ) {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="structQureg.html">Qureg</a> a = <a class="code" href="group__type.html#ga93e55b6650b408abb30a1d4a8bce757c">createDensityQureg</a>(<a class="code" href="utilities_8hpp.html#a2f52338126bb8cdf7fcf68eaf01c546a">NUM_QUBITS</a>, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="structQureg.html">Qureg</a> b = <a class="code" href="group__type.html#gabd07eee133dcd4e6ae7c2d2ce4c42978">createCloneQureg</a>(a, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// check properties are the same</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  REQUIRE( b.<a class="code" href="structQureg.html#acf78445e9435d09f44f0cc832c6aee79">isDensityMatrix</a> == a.<a class="code" href="structQureg.html#acf78445e9435d09f44f0cc832c6aee79">isDensityMatrix</a> );</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  REQUIRE( b.<a class="code" href="structQureg.html#ad08dff5316b8937f4b2a1417591543dc">numQubitsRepresented</a> == a.<a class="code" href="structQureg.html#ad08dff5316b8937f4b2a1417591543dc">numQubitsRepresented</a> );</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  REQUIRE( b.<a class="code" href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">numQubitsInStateVec</a> == a.<a class="code" href="structQureg.html#a0a86e8a50ea8c998b4a0a6640c5a1218">numQubitsInStateVec</a> );</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  REQUIRE( b.<a class="code" href="structQureg.html#ab0ea0358482b62f43fdd781469607d97">numAmpsPerChunk</a> == a.<a class="code" href="structQureg.html#ab0ea0358482b62f43fdd781469607d97">numAmpsPerChunk</a> );</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  REQUIRE( b.<a class="code" href="structQureg.html#adef4935cac95763c29164cf99b144ed4">numAmpsTotal</a> == a.<a class="code" href="structQureg.html#adef4935cac95763c29164cf99b144ed4">numAmpsTotal</a> );</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">// check state-vector is the same (works for GPU and distributed)</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  REQUIRE( <a class="code" href="group__testutilities.html#ga45cc399adad2e2a67b0124851189fae5">areEqual</a>(a, b) ); </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692">destroyQureg</a>(a, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692">destroyQureg</a>(b, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="group__unittest.html#gaf929e0eed564772adcd99d2b1cab3818"> 103</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"createComplexMatrixN"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  SECTION( <span class="stringliteral">"correctness"</span> ) {</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">int</span> numQb = GENERATE( range(1,10+1) );</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="structComplexMatrixN.html">ComplexMatrixN</a> m = <a class="code" href="group__type.html#ga815103261fb22ea9690e1427571df00e">createComplexMatrixN</a>(numQb);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// ensure elems are created and initialised to 0</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  REQUIRE( <a class="code" href="group__testutilities.html#ga45cc399adad2e2a67b0124851189fae5">areEqual</a>(<a class="code" href="group__testutilities.html#ga253946523907014c4f198d2bb38d4913">toQMatrix</a>(m), <a class="code" href="group__testutilities.html#ga6ccbb15b0f234e926be96a153181b63a">getZeroMatrix</a>(1<<numQb)) );</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="group__type.html#ga9df2f3d86be4a6e9aad481665e5e6753">destroyComplexMatrixN</a>(m);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  }</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  SECTION( <span class="stringliteral">"input validation"</span> ) {</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  SECTION( <span class="stringliteral">"number of qubits"</span> ) {</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">int</span> numQb = GENERATE( -1, 0 );</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  REQUIRE_THROWS_WITH( <a class="code" href="group__type.html#ga815103261fb22ea9690e1427571df00e">createComplexMatrixN</a>(numQb), Contains(<span class="stringliteral">"Invalid number of qubits"</span>) );</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  }</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> }</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div>
<div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="group__unittest.html#gaf8887d313b85b6d9c90771e27fc0f9ff"> 131</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"createDensityQureg"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</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">// must be at least one amplitude per node</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">int</span> minNumQb = <a class="code" href="group__testutilities.html#ga267884197cf7f1d428021cb12a57360c">calcLog2</a>(<a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>.<a class="code" href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">numRanks</a>) - 1; <span class="comment">// density matrix has 2*numQb in state-vec</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">if</span> (minNumQb <= 0)</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  minNumQb = 1;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  SECTION( <span class="stringliteral">"correctness"</span> ) {</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="comment">// try 10 valid number of qubits</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">int</span> numQb = GENERATE_COPY( range(minNumQb, minNumQb+10) );</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="structQureg.html">Qureg</a> reg = <a class="code" href="group__type.html#ga93e55b6650b408abb30a1d4a8bce757c">createDensityQureg</a>(numQb, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</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="comment">// ensure elems (CPU and/or GPU) are created, and reg begins in |0><0|</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <a class="code" href="group__testutilities.html#gabbc686f5f40eff22e08a2b2012ac4e41">QMatrix</a> ref = <a class="code" href="group__testutilities.html#ga6ccbb15b0f234e926be96a153181b63a">getZeroMatrix</a>(1<<numQb);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  ref[0][0] = 1; <span class="comment">// |0><0|</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  REQUIRE( <a class="code" href="group__testutilities.html#ga45cc399adad2e2a67b0124851189fae5">areEqual</a>(reg, ref) );</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692">destroyQureg</a>(reg, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  }</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  SECTION( <span class="stringliteral">"input validation"</span>) {</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  SECTION( <span class="stringliteral">"number of qubits"</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>  <span class="keywordtype">int</span> numQb = GENERATE( -1, 0 );</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  REQUIRE_THROWS_WITH( <a class="code" href="group__type.html#ga93e55b6650b408abb30a1d4a8bce757c">createDensityQureg</a>(numQb, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>), Contains(<span class="stringliteral">"Invalid number of qubits"</span>) );</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  }</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  SECTION( <span class="stringliteral">"number of amplitudes"</span> ) {</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="comment">// use local QuESTEnv to safely modify</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <a class="code" href="structQuESTEnv.html">QuESTEnv</a> env = <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="comment">// too many amplitudes to store in type</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordtype">int</span> maxQb = (int) <a class="code" href="group__testutilities.html#ga267884197cf7f1d428021cb12a57360c">calcLog2</a>(SIZE_MAX) - 1;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  REQUIRE_THROWS_WITH( <a class="code" href="group__type.html#ga93e55b6650b408abb30a1d4a8bce757c">createDensityQureg</a>(maxQb+1, env), Contains(<span class="stringliteral">"Too many qubits"</span>) && Contains(<span class="stringliteral">"size_t type"</span>) );</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="comment">/* n-qubit density matrix contains 2^(2n) amplitudes </span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * so can be spread between at most 2^(2n) ranks</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordtype">int</span> minQb = GENERATE( range(3,10) );</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  env.<a class="code" href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">numRanks</a> = (int) pow(2, 2*minQb);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keywordtype">int</span> numQb = GENERATE_COPY( range(1,minQb) );</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  REQUIRE_THROWS_WITH( <a class="code" href="group__type.html#ga93e55b6650b408abb30a1d4a8bce757c">createDensityQureg</a>(numQb, env), Contains(<span class="stringliteral">"Too few qubits"</span>) );</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  }</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  SECTION( <span class="stringliteral">"available memory"</span> ) {</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="comment">/* there is no reliable way to force the malloc statements to</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * fail, and hence trigger the matrixInit validation */</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  SUCCEED( );</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  }</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  }</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> }</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  </div>
<div class="line"><a name="l00190"></a><span class="lineno"><a class="line" href="group__unittest.html#ga18b791c2fe5a2c484c51879ef16fba22"> 190</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"createQuESTEnv"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="comment">/* there is no meaningful way to test this */</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  SUCCEED( );</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> }</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  </div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  </div>
<div class="line"><a name="l00202"></a><span class="lineno"><a class="line" href="group__unittest.html#ga9aec4500e0046f8b085bb800f79db544"> 202</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"createQureg"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  </div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="comment">// must be at least one amplitude per node</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keywordtype">int</span> minNumQb = <a class="code" href="group__testutilities.html#ga267884197cf7f1d428021cb12a57360c">calcLog2</a>(<a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>.<a class="code" href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">numRanks</a>);</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keywordflow">if</span> (minNumQb == 0)</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  minNumQb = 1;</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  </div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  SECTION( <span class="stringliteral">"correctness"</span> ) {</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  </div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="comment">// try 10 valid number of qubits</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keywordtype">int</span> numQb = GENERATE_COPY( range(minNumQb, minNumQb+10) );</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <a class="code" href="structQureg.html">Qureg</a> reg = <a class="code" href="group__type.html#ga3392816c0643414165c2f5caeec17df0">createQureg</a>(numQb, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  </div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="comment">// ensure elems (CPU and/or GPU) are created, and reg begins in |0></span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <a class="code" href="group__testutilities.html#gac9263a65c96a458b810b20baa81c5b94">QVector</a> ref = <a class="code" href="group__testutilities.html#gac9263a65c96a458b810b20baa81c5b94">QVector</a>(1<<numQb);</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  ref[0] = 1; <span class="comment">// |0></span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  REQUIRE( <a class="code" href="group__testutilities.html#ga45cc399adad2e2a67b0124851189fae5">areEqual</a>(reg, ref) );</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  </div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <a class="code" href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692">destroyQureg</a>(reg, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>);</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  }</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  SECTION( <span class="stringliteral">"input validation"</span>) {</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  </div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  SECTION( <span class="stringliteral">"number of qubits"</span> ) {</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  </div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keywordtype">int</span> numQb = GENERATE( -1, 0 );</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  REQUIRE_THROWS_WITH( <a class="code" href="group__type.html#ga3392816c0643414165c2f5caeec17df0">createQureg</a>(numQb, <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>), Contains(<span class="stringliteral">"Invalid number of qubits"</span>) );</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  }</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  SECTION( <span class="stringliteral">"number of amplitudes"</span> ) {</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  </div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="comment">// use local QuESTEnv to safely modify</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <a class="code" href="structQuESTEnv.html">QuESTEnv</a> env = <a class="code" href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a>;</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  </div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="comment">// too many amplitudes to store in type</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keywordtype">int</span> maxQb = (int) <a class="code" href="group__testutilities.html#ga267884197cf7f1d428021cb12a57360c">calcLog2</a>(SIZE_MAX);</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  REQUIRE_THROWS_WITH( <a class="code" href="group__type.html#ga3392816c0643414165c2f5caeec17df0">createQureg</a>(maxQb+1, env), Contains(<span class="stringliteral">"Too many qubits"</span>) && Contains(<span class="stringliteral">"size_t type"</span>) );</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  </div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="comment">// too few amplitudes to distribute</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keywordtype">int</span> minQb = GENERATE( range(2,10) );</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  env.<a class="code" href="structQuESTEnv.html#af22aacd7c9905accae28484785c193b4">numRanks</a> = (int) pow(2, minQb);</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keywordtype">int</span> numQb = GENERATE_COPY( range(1,minQb) );</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  REQUIRE_THROWS_WITH( <a class="code" href="group__type.html#ga3392816c0643414165c2f5caeec17df0">createQureg</a>(numQb, env), Contains(<span class="stringliteral">"Too few qubits"</span>) );</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  }</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  SECTION( <span class="stringliteral">"available memory"</span> ) {</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  </div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="comment">/* there is no reliable way to force the malloc statements to</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * fail, and hence trigger the matrixInit validation */</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  SUCCEED( );</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  }</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  }</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> }</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  </div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  </div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  </div>
<div class="line"><a name="l00259"></a><span class="lineno"><a class="line" href="group__unittest.html#gaa4304249b102cdc1471be54a8765442f"> 259</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"destroyComplexMatrixN"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  </div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  SECTION( <span class="stringliteral">"correctness"</span> ) {</div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  </div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="comment">/* there is no meaningful way to test this */</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  SUCCEED( );</div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  }</div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  SECTION( <span class="stringliteral">"input validation"</span> ) {</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  </div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  SECTION( <span class="stringliteral">"matrix not created"</span> ) {</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  </div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="comment">/* this is an artificial test case since nothing in the QuEST API </span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> * automatically sets un-initialised ComplexMatrixN fields to </span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * the NULL pointer.</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <a class="code" href="structComplexMatrixN.html">ComplexMatrixN</a> m;</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  m.<a class="code" href="structComplexMatrixN.html#a446e8a077597e4f76049d547df0c9738">real</a> = NULL;</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  </div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <span class="comment">/* the error message is also somewhat unrelated, but oh well </span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  REQUIRE_THROWS_WITH( <a class="code" href="group__type.html#ga9df2f3d86be4a6e9aad481665e5e6753">destroyComplexMatrixN</a>(m), Contains(<span class="stringliteral">"The ComplexMatrixN was not successfully created"</span>) );</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  }</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  }</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> }</div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  </div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  </div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  </div>
<div class="line"><a name="l00290"></a><span class="lineno"><a class="line" href="group__unittest.html#gab5ca964a4d64491f3c32e7fda334a5e1"> 290</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"destroyQuESTEnv"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  </div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  <span class="comment">/* there is no meaningful way to test this */</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  SUCCEED( );</div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> }</div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  </div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  </div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  </div>
<div class="line"><a name="l00302"></a><span class="lineno"><a class="line" href="group__unittest.html#ga6e2d6773435b9191791ef1e6fb844337"> 302</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"destroyQureg"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  </div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  <span class="comment">/* there is no meaningful way to test this.</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> * We e.g. cannot check that the pointers are NULL because </span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * they are not updated; this function passes the struct by value,</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> * not by reference. We also cannot reliably monitor the </span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * memory used in the heap at runtime.</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  SUCCEED( );</div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> }</div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  </div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  </div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  </div>
<div class="line"><a name="l00319"></a><span class="lineno"><a class="line" href="group__unittest.html#ga9e5aba81a2f4e762ce05a1c7abd9349a"> 319</a></span> <a class="code" href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a>( <span class="stringliteral">"initComplexMatrixN"</span>, <span class="stringliteral">"[data_structures]"</span> ) {</div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  </div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  <span class="comment">/* use of this function is illegal in C++ */</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  SUCCEED( );</div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> }</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="amain_8cpp_html_a718130cc1fc36cde991aff3d4c85c47d"><div class="ttname"><a href="main_8cpp.html#a718130cc1fc36cde991aff3d4c85c47d">QUEST_ENV</a></div><div class="ttdeci">QuESTEnv QUEST_ENV</div><div class="ttdoc">The global QuESTEnv instance, to be created and destroyed once in this main(), so that the MPI enviro...</div><div class="ttdef"><b>Definition:</b> <a href="main_8cpp_source.html#l00020">main.cpp:20</a></div></div>
<div class="ttc" id="agroup__type_html_ga3cf635d2b2e57226c8d5a777f513367e"><div class="ttname"><a href="group__type.html#ga3cf635d2b2e57226c8d5a777f513367e">fromComplex</a></div><div class="ttdeci">#define fromComplex(comp)</div></div>
<div class="ttc" id="agroup__type_html_ga9df2f3d86be4a6e9aad481665e5e6753"><div class="ttname"><a href="group__type.html#ga9df2f3d86be4a6e9aad481665e5e6753">destroyComplexMatrixN</a></div><div class="ttdeci">void destroyComplexMatrixN(ComplexMatrixN m)</div><div class="ttdoc">Destroy a ComplexMatrixN instance created with createComplexMatrixN()</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8c_source.html#l01021">QuEST.c:1021</a></div></div>
<div class="ttc" id="agroup__unittest_html_ga2f0067941939643bc87b445995fc873c"><div class="ttname"><a href="group__unittest.html#ga2f0067941939643bc87b445995fc873c">TEST_CASE</a></div><div class="ttdeci">TEST_CASE("fromComplex", "[data_structures]")</div><div class="ttdef"><b>Definition:</b> <a href="test__data__structures_8cpp_source.html#l00015">test_data_structures.cpp:15</a></div></div>
<div class="ttc" id="agroup__type_html_ga815103261fb22ea9690e1427571df00e"><div class="ttname"><a href="group__type.html#ga815103261fb22ea9690e1427571df00e">createComplexMatrixN</a></div><div class="ttdeci">ComplexMatrixN createComplexMatrixN(int numQubits)</div><div class="ttdoc">Create (dynamically) a square complex matrix which can be passed to the multi-qubit general unitary f...</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8c_source.html#l01000">QuEST.c:1000</a></div></div>
<div class="ttc" id="autilities_8hpp_html_a2f52338126bb8cdf7fcf68eaf01c546a"><div class="ttname"><a href="utilities_8hpp.html#a2f52338126bb8cdf7fcf68eaf01c546a">NUM_QUBITS</a></div><div class="ttdeci">#define NUM_QUBITS</div><div class="ttdoc">The default number of qubits in the registers created for unit testing (both statevectors and density...</div><div class="ttdef"><b>Definition:</b> <a href="utilities_8hpp_source.html#l00036">utilities.hpp:36</a></div></div>
<div class="ttc" id="aQuEST_8h_html"><div class="ttname"><a href="QuEST_8h.html">QuEST.h</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="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__testutilities_html_ga253946523907014c4f198d2bb38d4913"><div class="ttname"><a href="group__testutilities.html#ga253946523907014c4f198d2bb38d4913">toQMatrix</a></div><div class="ttdeci">QMatrix toQMatrix(ComplexMatrix2 src)</div><div class="ttdoc">Returns a copy of the given 2-by-2 matrix.</div><div class="ttdef"><b>Definition:</b> <a href="utilities_8cpp_source.html#l00835">utilities.cpp:835</a></div></div>
<div class="ttc" id="agroup__testutilities_html_ga267884197cf7f1d428021cb12a57360c"><div class="ttname"><a href="group__testutilities.html#ga267884197cf7f1d428021cb12a57360c">calcLog2</a></div><div class="ttdeci">unsigned int calcLog2(long unsigned int num)</div><div class="ttdoc">returns log2 of numbers which must be gauranteed to be 2^n</div><div class="ttdef"><b>Definition:</b> <a href="QuEST__validation_8c_source.html#l00254">QuEST_validation.c:254</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__testutilities_html_gac9263a65c96a458b810b20baa81c5b94"><div class="ttname"><a href="group__testutilities.html#gac9263a65c96a458b810b20baa81c5b94">QVector</a></div><div class="ttdeci">std::vector< qcomp > QVector</div><div class="ttdoc">A complex vector, which can be zero-initialised with QVector(numAmps).</div><div class="ttdef"><b>Definition:</b> <a href="utilities_8hpp_source.html#l00060">utilities.hpp:60</a></div></div>
<div class="ttc" id="astructQureg_html_ab0ea0358482b62f43fdd781469607d97"><div class="ttname"><a href="structQureg.html#ab0ea0358482b62f43fdd781469607d97">Qureg::numAmpsPerChunk</a></div><div class="ttdeci">long long int numAmpsPerChunk</div><div class="ttdoc">Number of probability amplitudes held in stateVec by this process In the non-MPI version,...</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00170">QuEST.h:170</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="agroup__type_html_gab54c5a1ea720830a7ee394d03fb9f4e9"><div class="ttname"><a href="group__type.html#gab54c5a1ea720830a7ee394d03fb9f4e9">toComplex</a></div><div class="ttdeci">#define toComplex(scalar)</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_ga8e1e6ad3254892edc2ee08712ea9d692"><div class="ttname"><a href="group__type.html#ga8e1e6ad3254892edc2ee08712ea9d692">destroyQureg</a></div><div class="ttdeci">void destroyQureg(Qureg qureg, QuESTEnv env)</div><div class="ttdoc">Deallocate a Qureg object representing a set of qubits.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8c_source.html#l00075">QuEST.c:75</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="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="agroup__type_html_gabd07eee133dcd4e6ae7c2d2ce4c42978"><div class="ttname"><a href="group__type.html#gabd07eee133dcd4e6ae7c2d2ce4c42978">createCloneQureg</a></div><div class="ttdeci">Qureg createCloneQureg(Qureg qureg, QuESTEnv env)</div><div class="ttdoc">Create a new Qureg which is an exact clone of the passed qureg, which can be either a statevector or ...</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8c_source.html#l00062">QuEST.c:62</a></div></div>
<div class="ttc" id="agroup__testutilities_html_gabbc686f5f40eff22e08a2b2012ac4e41"><div class="ttname"><a href="group__testutilities.html#gabbc686f5f40eff22e08a2b2012ac4e41">QMatrix</a></div><div class="ttdeci">std::vector< std::vector< qcomp > > QMatrix</div><div class="ttdoc">A complex square matrix.</div><div class="ttdef"><b>Definition:</b> <a href="utilities_8hpp_source.html#l00049">utilities.hpp:49</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="astructQureg_html_adef4935cac95763c29164cf99b144ed4"><div class="ttname"><a href="structQureg.html#adef4935cac95763c29164cf99b144ed4">Qureg::numAmpsTotal</a></div><div class="ttdeci">long long int numAmpsTotal</div><div class="ttdoc">Total number of amplitudes, which are possibly distributed among machines.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00172">QuEST.h:172</a></div></div>
<div class="ttc" id="astructComplex_html_ab5b2e2eca02131fc74b289a83636cbe3"><div class="ttname"><a href="structComplex.html#ab5b2e2eca02131fc74b289a83636cbe3">Complex::real</a></div><div class="ttdeci">qreal real</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00105">QuEST.h:105</a></div></div>
<div class="ttc" id="agroup__type_html_ga3392816c0643414165c2f5caeec17df0"><div class="ttname"><a href="group__type.html#ga3392816c0643414165c2f5caeec17df0">createQureg</a></div><div class="ttdeci">Qureg createQureg(int numQubits, QuESTEnv env)</div><div class="ttdoc">Create a Qureg object representing a set of qubits which will remain in a pure state.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8c_source.html#l00034">QuEST.c:34</a></div></div>
<div class="ttc" id="astructComplex_html_a84f5439aad0ef495efdd3b4c1c02d27e"><div class="ttname"><a href="structComplex.html#a84f5439aad0ef495efdd3b4c1c02d27e">Complex::imag</a></div><div class="ttdeci">qreal imag</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00106">QuEST.h:106</a></div></div>
<div class="ttc" id="agroup__testutilities_html_ga6ccbb15b0f234e926be96a153181b63a"><div class="ttname"><a href="group__testutilities.html#ga6ccbb15b0f234e926be96a153181b63a">getZeroMatrix</a></div><div class="ttdeci">QMatrix getZeroMatrix(size_t dim)</div><div class="ttdoc">Returns a dim-by-dim square complex matrix, initialised to all zeroes.</div><div class="ttdef"><b>Definition:</b> <a href="utilities_8cpp_source.html#l00143">utilities.cpp:143</a></div></div>
<div class="ttc" id="astructComplex_html"><div class="ttname"><a href="structComplex.html">Complex</a></div><div class="ttdoc">Represents one complex number.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8h_source.html#l00103">QuEST.h:103</a></div></div>
<div class="ttc" id="agroup__testutilities_html_ga45cc399adad2e2a67b0124851189fae5"><div class="ttname"><a href="group__testutilities.html#ga45cc399adad2e2a67b0124851189fae5">areEqual</a></div><div class="ttdeci">bool areEqual(QVector a, QVector b)</div><div class="ttdoc">Returns true if the absolute value of the difference between every amplitude in vectors a and b is le...</div><div class="ttdef"><b>Definition:</b> <a href="utilities_8cpp_source.html#l00387">utilities.cpp:387</a></div></div>
<div class="ttc" id="agroup__type_html_ga93e55b6650b408abb30a1d4a8bce757c"><div class="ttname"><a href="group__type.html#ga93e55b6650b408abb30a1d4a8bce757c">createDensityQureg</a></div><div class="ttdeci">Qureg createDensityQureg(int numQubits, QuESTEnv env)</div><div class="ttdoc">Create a Qureg for qubits which are represented by a density matrix, and can be in mixed states.</div><div class="ttdef"><b>Definition:</b> <a href="QuEST_8c_source.html#l00048">QuEST.c:48</a></div></div>
<div class="ttc" id="autilities_8hpp_html"><div class="ttname"><a href="utilities_8hpp.html">utilities.hpp</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>
