<!-- 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: PauliHamil Struct Reference</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.4.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="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">PauliHamil Struct Reference<div class="ingroups"><a class="el" href="group__type.html">Data structures</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A Pauli Hamiltonian, expressed as a real-weighted sum of pauli products, and which can hence represent any Hermitian operator.
<a href="structPauliHamil.html#details">More...</a></p>
<p><code>#include <<a class="el" href="QuEST_8h_source.html">QuEST.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:acb49fff0e3160ea1904c9ca34408b4e1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPauliHamil.html#acb49fff0e3160ea1904c9ca34408b4e1">numQubits</a></td></tr>
<tr class="memdesc:acb49fff0e3160ea1904c9ca34408b4e1"><td class="mdescLeft"> </td><td class="mdescRight">The number of qubits informing the Hilbert dimension of the Hamiltonian. <a href="structPauliHamil.html#acb49fff0e3160ea1904c9ca34408b4e1">More...</a><br /></td></tr>
<tr class="separator:acb49fff0e3160ea1904c9ca34408b4e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a737e46b40ef8990cf004d22eb9dbe2e4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPauliHamil.html#a737e46b40ef8990cf004d22eb9dbe2e4">numSumTerms</a></td></tr>
<tr class="memdesc:a737e46b40ef8990cf004d22eb9dbe2e4"><td class="mdescLeft"> </td><td class="mdescRight">The number of terms in the weighted sum, or the number of Pauli products. <a href="structPauliHamil.html#a737e46b40ef8990cf004d22eb9dbe2e4">More...</a><br /></td></tr>
<tr class="separator:a737e46b40ef8990cf004d22eb9dbe2e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b8d38c403553c07ceddcd40c46ce6c8"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__type.html#ga1c703cf89629e4e9c7023cd402d67028">pauliOpType</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPauliHamil.html#a4b8d38c403553c07ceddcd40c46ce6c8">pauliCodes</a></td></tr>
<tr class="memdesc:a4b8d38c403553c07ceddcd40c46ce6c8"><td class="mdescLeft"> </td><td class="mdescRight">The Pauli operators acting on each qubit, flattened over every operator. <a href="structPauliHamil.html#a4b8d38c403553c07ceddcd40c46ce6c8">More...</a><br /></td></tr>
<tr class="separator:a4b8d38c403553c07ceddcd40c46ce6c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1c6c9f6299cf83bbba88123216c3cac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPauliHamil.html#ac1c6c9f6299cf83bbba88123216c3cac">termCoeffs</a></td></tr>
<tr class="memdesc:ac1c6c9f6299cf83bbba88123216c3cac"><td class="mdescLeft"> </td><td class="mdescRight">The real coefficient of each Pauli product. This is an array of length <a class="el" href="structPauliHamil.html#a737e46b40ef8990cf004d22eb9dbe2e4" title="The number of terms in the weighted sum, or the number of Pauli products.">PauliHamil.numSumTerms</a>;. <a href="structPauliHamil.html#ac1c6c9f6299cf83bbba88123216c3cac">More...</a><br /></td></tr>
<tr class="separator:ac1c6c9f6299cf83bbba88123216c3cac"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A Pauli Hamiltonian, expressed as a real-weighted sum of pauli products, and which can hence represent any Hermitian operator. </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#l00277">277</a> of file <a class="el" href="QuEST_8h_source.html">QuEST.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="acb49fff0e3160ea1904c9ca34408b4e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb49fff0e3160ea1904c9ca34408b4e1">◆ </a></span>numQubits</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PauliHamil::numQubits</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of qubits informing the Hilbert dimension of the Hamiltonian. </p>
<p class="definition">Definition at line <a class="el" href="QuEST_8h_source.html#l00287">287</a> of file <a class="el" href="QuEST_8h_source.html">QuEST.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="QuEST__cpu_8c_source.html#l01377">agnostic_initDiagonalOpFromPauliHamil()</a>, <a class="el" href="QuEST__common_8c_source.html#l00765">applyExponentiatedPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01558">createDiagonalOpFromPauliHamilFile()</a>, <a class="el" href="QuEST_8c_source.html#l01398">createPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01550">initDiagonalOpFromPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01504">initPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01598">reportPauliHamil()</a>, <a class="el" href="utilities_8cpp_source.html#l01241">setRandomDiagPauliHamil()</a>, <a class="el" href="utilities_8cpp_source.html#l01237">setRandomPauliSum()</a>, <a class="el" href="test__data__structures_8cpp_source.html#l00420">TEST_CASE()</a>, <a class="el" href="utilities_8cpp_source.html#l01282">toQMatrix()</a>, <a class="el" href="QuEST__validation_8c_source.html#l00718">validateDiagPauliHamil()</a>, <a class="el" href="QuEST__validation_8c_source.html#l00727">validateDiagPauliHamilFromFile()</a>, <a class="el" href="QuEST__validation_8c_source.html#l00660">validateMatchingQuregPauliHamilDims()</a>, and <a class="el" href="QuEST__validation_8c_source.html#l00655">validatePauliHamil()</a>.</p>
</div>
</div>
<a id="a737e46b40ef8990cf004d22eb9dbe2e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a737e46b40ef8990cf004d22eb9dbe2e4">◆ </a></span>numSumTerms</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PauliHamil::numSumTerms</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of terms in the weighted sum, or the number of Pauli products. </p>
<p class="definition">Definition at line <a class="el" href="QuEST_8h_source.html#l00285">285</a> of file <a class="el" href="QuEST_8h_source.html">QuEST.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="QuEST__cpu_8c_source.html#l01377">agnostic_initDiagonalOpFromPauliHamil()</a>, <a class="el" href="QuEST__common_8c_source.html#l00765">applyExponentiatedPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01059">applyPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01219">calcExpecPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01398">createPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01550">initDiagonalOpFromPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01504">initPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01598">reportPauliHamil()</a>, <a class="el" href="utilities_8cpp_source.html#l01241">setRandomDiagPauliHamil()</a>, <a class="el" href="utilities_8cpp_source.html#l01237">setRandomPauliSum()</a>, <a class="el" href="test__data__structures_8cpp_source.html#l00420">TEST_CASE()</a>, <a class="el" href="utilities_8cpp_source.html#l01282">toQMatrix()</a>, <a class="el" href="QuEST__validation_8c_source.html#l00718">validateDiagPauliHamil()</a>, <a class="el" href="QuEST__validation_8c_source.html#l00727">validateDiagPauliHamilFromFile()</a>, and <a class="el" href="QuEST__validation_8c_source.html#l00655">validatePauliHamil()</a>.</p>
</div>
</div>
<a id="a4b8d38c403553c07ceddcd40c46ce6c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b8d38c403553c07ceddcd40c46ce6c8">◆ </a></span>pauliCodes</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>* PauliHamil::pauliCodes</td>
</tr>
</table>
</div><div class="memdoc">
<p>The Pauli operators acting on each qubit, flattened over every operator. </p>
<p>This is a flat array of length <a class="el" href="structPauliHamil.html#a737e46b40ef8990cf004d22eb9dbe2e4" title="The number of terms in the weighted sum, or the number of Pauli products.">PauliHamil.numSumTerms</a> * <a class="el" href="structPauliHamil.html#acb49fff0e3160ea1904c9ca34408b4e1" title="The number of qubits informing the Hilbert dimension of the Hamiltonian.">PauliHamil.numQubits</a>. </p>
<p class="definition">Definition at line <a class="el" href="QuEST_8h_source.html#l00281">281</a> of file <a class="el" href="QuEST_8h_source.html">QuEST.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="QuEST__cpu_8c_source.html#l01377">agnostic_initDiagonalOpFromPauliHamil()</a>, <a class="el" href="QuEST__common_8c_source.html#l00765">applyExponentiatedPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01059">applyPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01219">calcExpecPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01398">createPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01420">createPauliHamilFromFile()</a>, <a class="el" href="QuEST_8c_source.html#l01414">destroyPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01504">initPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01598">reportPauliHamil()</a>, <a class="el" href="utilities_8cpp_source.html#l01241">setRandomDiagPauliHamil()</a>, <a class="el" href="utilities_8cpp_source.html#l01237">setRandomPauliSum()</a>, <a class="el" href="test__calculations_8cpp_source.html#l00189">TEST_CASE()</a>, <a class="el" href="utilities_8cpp_source.html#l01282">toQMatrix()</a>, <a class="el" href="QuEST__validation_8c_source.html#l00718">validateDiagPauliHamil()</a>, <a class="el" href="QuEST__validation_8c_source.html#l00727">validateDiagPauliHamilFromFile()</a>, and <a class="el" href="QuEST__validation_8c_source.html#l00655">validatePauliHamil()</a>.</p>
</div>
</div>
<a id="ac1c6c9f6299cf83bbba88123216c3cac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1c6c9f6299cf83bbba88123216c3cac">◆ </a></span>termCoeffs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__type.html#ga7740e349b4f8bae6451547680f0ce2d6">qreal</a>* PauliHamil::termCoeffs</td>
</tr>
</table>
</div><div class="memdoc">
<p>The real coefficient of each Pauli product. This is an array of length <a class="el" href="structPauliHamil.html#a737e46b40ef8990cf004d22eb9dbe2e4" title="The number of terms in the weighted sum, or the number of Pauli products.">PauliHamil.numSumTerms</a>;. </p>
<p class="definition">Definition at line <a class="el" href="QuEST_8h_source.html#l00283">283</a> of file <a class="el" href="QuEST_8h_source.html">QuEST.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="QuEST__cpu_8c_source.html#l01377">agnostic_initDiagonalOpFromPauliHamil()</a>, <a class="el" href="QuEST__common_8c_source.html#l00765">applyExponentiatedPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01059">applyPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01219">calcExpecPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01398">createPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01420">createPauliHamilFromFile()</a>, <a class="el" href="QuEST_8c_source.html#l01414">destroyPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01504">initPauliHamil()</a>, <a class="el" href="QuEST_8c_source.html#l01598">reportPauliHamil()</a>, <a class="el" href="utilities_8cpp_source.html#l01241">setRandomDiagPauliHamil()</a>, <a class="el" href="utilities_8cpp_source.html#l01237">setRandomPauliSum()</a>, <a class="el" href="test__data__structures_8cpp_source.html#l00255">TEST_CASE()</a>, and <a class="el" href="utilities_8cpp_source.html#l01282">toQMatrix()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="QuEST_8h_source.html">QuEST.h</a></li>
</ul>
</div><!-- contents -->
<!-- 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>