Add generated tket C++ documentation.

docs/tket/api/BasicOptimisation_8hpp_source.html

@@ -172,16 +172,16 @@
 <div class="ttc" id="aTransform_8hpp_html"><div class="ttname"><a href="Transform_8hpp.html">Transform.hpp</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a24c7fb6f008a3cf65c553b858e8ace47"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a24c7fb6f008a3cf65c553b858e8ace47">tket::Transforms::remove_redundancies</a></div><div class="ttdeci">Transform remove_redundancies()</div><div class="ttdef"><b>Definition</b> <a href="RedundancyRemoval_8cpp_source.html#l00274">RedundancyRemoval.cpp:274</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a2ad65c0bed6e615eddffab07122b17a3"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a2ad65c0bed6e615eddffab07122b17a3">tket::Transforms::commute_through_multis</a></div><div class="ttdeci">Transform commute_through_multis()</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00040">BasicOptimisation.cpp:40</a></div></div>
-<div class="ttc" id="anamespacetket_1_1Transforms_html_a4c85817ac5250d6d3d816cc50c6f4a0d"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a4c85817ac5250d6d3d816cc50c6f4a0d">tket::Transforms::ZZPhase_to_Rz</a></div><div class="ttdeci">Transform ZZPhase_to_Rz()</div><div class="ttdoc">Converts any ZZPhase with angle in (-1, 1) to two pi Rz gates.</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00588">BasicOptimisation.cpp:588</a></div></div>
-<div class="ttc" id="anamespacetket_1_1Transforms_html_a8a51421110b7b660e1a27e91aec733be"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a8a51421110b7b660e1a27e91aec733be">tket::Transforms::round_angles</a></div><div class="ttdeci">Transform round_angles(unsigned n, bool only_zeros)</div><div class="ttdoc">Generate a transform that rounds all angles to the nearest .</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00658">BasicOptimisation.cpp:658</a></div></div>
+<div class="ttc" id="anamespacetket_1_1Transforms_html_a4c85817ac5250d6d3d816cc50c6f4a0d"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a4c85817ac5250d6d3d816cc50c6f4a0d">tket::Transforms::ZZPhase_to_Rz</a></div><div class="ttdeci">Transform ZZPhase_to_Rz()</div><div class="ttdoc">Converts any ZZPhase with angle in (-1, 1) to two pi Rz gates.</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00590">BasicOptimisation.cpp:590</a></div></div>
+<div class="ttc" id="anamespacetket_1_1Transforms_html_a8a51421110b7b660e1a27e91aec733be"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a8a51421110b7b660e1a27e91aec733be">tket::Transforms::round_angles</a></div><div class="ttdeci">Transform round_angles(unsigned n, bool only_zeros)</div><div class="ttdoc">Generate a transform that rounds all angles to the nearest .</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00660">BasicOptimisation.cpp:660</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a8d602ed5ee73002e620a6bdd0f39b754"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a8d602ed5ee73002e620a6bdd0f39b754">tket::Transforms::squash_1qb_to_pqp</a></div><div class="ttdeci">Transform squash_1qb_to_pqp(const OpType &amp;q, const OpType &amp;p, bool strict)</div><div class="ttdoc">general u_squash by converting any chains of p, q gates (p, q in {Rx,Ry,Rz}) to triples -p-q-p- or -q...</div><div class="ttdef"><b>Definition</b> <a href="PQPSquash_8cpp_source.html#l00190">PQPSquash.cpp:190</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a90e92f1a8fb65391bba982bb11f84fe9"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a90e92f1a8fb65391bba982bb11f84fe9">tket::Transforms::squash_1qb_to_Rz_PhasedX</a></div><div class="ttdeci">Transform squash_1qb_to_Rz_PhasedX(bool always_squash_symbols)</div><div class="ttdoc">Squash single qubit gates into PhasedX and Rz gates.</div><div class="ttdef"><b>Definition</b> <a href="RzPhasedXSquash_8cpp_source.html#l00096">RzPhasedXSquash.cpp:96</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_aa0883b0a9a6626492212506e41278569"><div class="ttname"><a href="namespacetket_1_1Transforms.html#aa0883b0a9a6626492212506e41278569">tket::Transforms::two_qubit_squash</a></div><div class="ttdeci">Transform two_qubit_squash(bool allow_swaps)</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00196">BasicOptimisation.cpp:196</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_aa8c11bf9ca03ea8c77172db128308b44"><div class="ttname"><a href="namespacetket_1_1Transforms.html#aa8c11bf9ca03ea8c77172db128308b44">tket::Transforms::redundancy_removal</a></div><div class="ttdeci">bool redundancy_removal(Circuit &amp;circuit)</div><div class="ttdef"><b>Definition</b> <a href="RedundancyRemoval_8cpp_source.html#l00267">RedundancyRemoval.cpp:267</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_aba553c4d1868e9e807791ee31ecf5b71"><div class="ttname"><a href="namespacetket_1_1Transforms.html#aba553c4d1868e9e807791ee31ecf5b71">tket::Transforms::squash_factory</a></div><div class="ttdeci">Transform squash_factory(const OpTypeSet &amp;singleqs, const std::function&lt; Circuit(const Expr &amp;, const Expr &amp;, const Expr &amp;)&gt; &amp;tk1_replacement, bool always_squash_symbols)</div><div class="ttdef"><b>Definition</b> <a href="StandardSquash_8cpp_source.html#l00094">StandardSquash.cpp:94</a></div></div>
-<div class="ttc" id="anamespacetket_1_1Transforms_html_abc5ed5a372aa369b67d538eb51075ee5"><div class="ttname"><a href="namespacetket_1_1Transforms.html#abc5ed5a372aa369b67d538eb51075ee5">tket::Transforms::commute_SQ_gates_through_SWAPS</a></div><div class="ttdeci">Transform commute_SQ_gates_through_SWAPS(const avg_node_errors_t &amp;node_errors)</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00453">BasicOptimisation.cpp:453</a></div></div>
-<div class="ttc" id="anamespacetket_1_1Transforms_html_adee710165c3b4aaac9e4521e9d74fbfa"><div class="ttname"><a href="namespacetket_1_1Transforms.html#adee710165c3b4aaac9e4521e9d74fbfa">tket::Transforms::absorb_Rz_NPhasedX</a></div><div class="ttdeci">Transform absorb_Rz_NPhasedX()</div><div class="ttdoc">Absorb Rz gates into NPhasedX where possible.</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00462">BasicOptimisation.cpp:462</a></div></div>
-<div class="ttc" id="anamespacetket_1_1Transforms_html_af27a84ae14a0ac564832ac765e7599ac"><div class="ttname"><a href="namespacetket_1_1Transforms.html#af27a84ae14a0ac564832ac765e7599ac">tket::Transforms::normalise_TK2</a></div><div class="ttdeci">Transform normalise_TK2()</div><div class="ttdoc">Normalises all TK2 gates so that NormalisedTK2Predicate is satisfied.</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00618">BasicOptimisation.cpp:618</a></div></div>
+<div class="ttc" id="anamespacetket_1_1Transforms_html_abc5ed5a372aa369b67d538eb51075ee5"><div class="ttname"><a href="namespacetket_1_1Transforms.html#abc5ed5a372aa369b67d538eb51075ee5">tket::Transforms::commute_SQ_gates_through_SWAPS</a></div><div class="ttdeci">Transform commute_SQ_gates_through_SWAPS(const avg_node_errors_t &amp;node_errors)</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00455">BasicOptimisation.cpp:455</a></div></div>
+<div class="ttc" id="anamespacetket_1_1Transforms_html_adee710165c3b4aaac9e4521e9d74fbfa"><div class="ttname"><a href="namespacetket_1_1Transforms.html#adee710165c3b4aaac9e4521e9d74fbfa">tket::Transforms::absorb_Rz_NPhasedX</a></div><div class="ttdeci">Transform absorb_Rz_NPhasedX()</div><div class="ttdoc">Absorb Rz gates into NPhasedX where possible.</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00464">BasicOptimisation.cpp:464</a></div></div>
+<div class="ttc" id="anamespacetket_1_1Transforms_html_af27a84ae14a0ac564832ac765e7599ac"><div class="ttname"><a href="namespacetket_1_1Transforms.html#af27a84ae14a0ac564832ac765e7599ac">tket::Transforms::normalise_TK2</a></div><div class="ttdeci">Transform normalise_TK2()</div><div class="ttdoc">Normalises all TK2 gates so that NormalisedTK2Predicate is satisfied.</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00620">BasicOptimisation.cpp:620</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_af45f1a2172f52f2bea73d710a2ed9ca6"><div class="ttname"><a href="namespacetket_1_1Transforms.html#af45f1a2172f52f2bea73d710a2ed9ca6">tket::Transforms::squash_1qb_to_tk1</a></div><div class="ttdeci">Transform squash_1qb_to_tk1()</div><div class="ttdoc">Squash all single-qubit gates to TK1.</div><div class="ttdef"><b>Definition</b> <a href="PQPSquash_8cpp_source.html#l00201">PQPSquash.cpp:201</a></div></div>
 <div class="ttc" id="anamespacetket_html"><div class="ttname"><a href="namespacetket.html">tket</a></div><div class="ttdoc">Defines tket::DeviceCharacterisation, used in NoiseAwarePlacement and in commute_SQ_gates_through_SWA...</div><div class="ttdef"><b>Definition</b> <a href="Path_8cpp_source.html#l00022">Path.cpp:22</a></div></div>
 <div class="ttc" id="anamespacetket_html_a13e81344da4794f2648eb9a7b286fcf3"><div class="ttname"><a href="namespacetket.html#a13e81344da4794f2648eb9a7b286fcf3">tket::OpType</a></div><div class="ttdeci">OpType</div><div class="ttdoc">Named operation types.</div><div class="ttdef"><b>Definition</b> <a href="OpType_8hpp_source.html#l00029">OpType.hpp:29</a></div></div>

docs/tket/api/Decomposition_8cpp_source.html

@@ -2278,7 +2278,7 @@
 <div class="ttc" id="anamespacetket_1_1Transforms_html_ad77803001c3ed2fa876774decf8244aa"><div class="ttname"><a href="namespacetket_1_1Transforms.html#ad77803001c3ed2fa876774decf8244aa">tket::Transforms::cnx_pairwise_decomposition</a></div><div class="ttdeci">Transform cnx_pairwise_decomposition()</div><div class="ttdef"><b>Definition</b> <a href="Decomposition_8cpp_source.html#l01905">Decomposition.cpp:1905</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_ad790e55412d4391a7f0f065385c105d0"><div class="ttname"><a href="namespacetket_1_1Transforms.html#ad790e55412d4391a7f0f065385c105d0">tket::Transforms::decompose_tk1_to_rzrx</a></div><div class="ttdeci">Transform decompose_tk1_to_rzrx()</div><div class="ttdef"><b>Definition</b> <a href="Decomposition_8cpp_source.html#l00412">Decomposition.cpp:412</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_adb83df7b894b56b844223af7c4841329"><div class="ttname"><a href="namespacetket_1_1Transforms.html#adb83df7b894b56b844223af7c4841329">tket::Transforms::decompose_ZY</a></div><div class="ttdeci">Transform decompose_ZY()</div><div class="ttdef"><b>Definition</b> <a href="Decomposition_8cpp_source.html#l00408">Decomposition.cpp:408</a></div></div>
-<div class="ttc" id="anamespacetket_1_1Transforms_html_adee710165c3b4aaac9e4521e9d74fbfa"><div class="ttname"><a href="namespacetket_1_1Transforms.html#adee710165c3b4aaac9e4521e9d74fbfa">tket::Transforms::absorb_Rz_NPhasedX</a></div><div class="ttdeci">Transform absorb_Rz_NPhasedX()</div><div class="ttdoc">Absorb Rz gates into NPhasedX where possible.</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00462">BasicOptimisation.cpp:462</a></div></div>
+<div class="ttc" id="anamespacetket_1_1Transforms_html_adee710165c3b4aaac9e4521e9d74fbfa"><div class="ttname"><a href="namespacetket_1_1Transforms.html#adee710165c3b4aaac9e4521e9d74fbfa">tket::Transforms::absorb_Rz_NPhasedX</a></div><div class="ttdeci">Transform absorb_Rz_NPhasedX()</div><div class="ttdoc">Absorb Rz gates into NPhasedX where possible.</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00464">BasicOptimisation.cpp:464</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_aedc2a6c73363553bc6a3fcc7d4fe1e1d"><div class="ttname"><a href="namespacetket_1_1Transforms.html#aedc2a6c73363553bc6a3fcc7d4fe1e1d">tket::Transforms::decompose_BRIDGE_to_CX</a></div><div class="ttdeci">Transform decompose_BRIDGE_to_CX()</div><div class="ttdef"><b>Definition</b> <a href="Decomposition_8cpp_source.html#l01453">Decomposition.cpp:1453</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_aefaeaababb6b384030bc96a88da4d967"><div class="ttname"><a href="namespacetket_1_1Transforms.html#aefaeaababb6b384030bc96a88da4d967">tket::Transforms::decompose_ZX_to_cliffords</a></div><div class="ttdeci">Transform decompose_ZX_to_cliffords()</div><div class="ttdef"><b>Definition</b> <a href="Decomposition_8cpp_source.html#l01200">Decomposition.cpp:1200</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_afed169155f9056acecc68b587fe34b04"><div class="ttname"><a href="namespacetket_1_1Transforms.html#afed169155f9056acecc68b587fe34b04">tket::Transforms::decompose_MolmerSorensen</a></div><div class="ttdeci">Transform decompose_MolmerSorensen()</div><div class="ttdef"><b>Definition</b> <a href="Decomposition_8cpp_source.html#l00507">Decomposition.cpp:507</a></div></div>

docs/tket/api/PassGenerators_8cpp_source.html

@@ -1476,7 +1476,7 @@
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a7f618e54969ee0fdc1a3fa4a82b3d604"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a7f618e54969ee0fdc1a3fa4a82b3d604">tket::Transforms::CreateAllQubits</a></div><div class="ttdeci">CreateAllQubits</div><div class="ttdoc">Automatically create all qubits in zero state when simplifying?</div><div class="ttdef"><b>Definition</b> <a href="ContextualReduction_8hpp_source.html#l00028">ContextualReduction.hpp:28</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a7f618e54969ee0fdc1a3fa4a82b3d604a93cba07454f06a4a960172bbd6e2a435"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a7f618e54969ee0fdc1a3fa4a82b3d604a93cba07454f06a4a960172bbd6e2a435">tket::Transforms::CreateAllQubits::Yes</a></div><div class="ttdeci">@ Yes</div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a7f618e54969ee0fdc1a3fa4a82b3d604abafd7322c6e97d25b6299b5d6fe8920b"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a7f618e54969ee0fdc1a3fa4a82b3d604abafd7322c6e97d25b6299b5d6fe8920b">tket::Transforms::CreateAllQubits::No</a></div><div class="ttdeci">@ No</div></div>
-<div class="ttc" id="anamespacetket_1_1Transforms_html_a8a51421110b7b660e1a27e91aec733be"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a8a51421110b7b660e1a27e91aec733be">tket::Transforms::round_angles</a></div><div class="ttdeci">Transform round_angles(unsigned n, bool only_zeros)</div><div class="ttdoc">Generate a transform that rounds all angles to the nearest .</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00658">BasicOptimisation.cpp:658</a></div></div>
+<div class="ttc" id="anamespacetket_1_1Transforms_html_a8a51421110b7b660e1a27e91aec733be"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a8a51421110b7b660e1a27e91aec733be">tket::Transforms::round_angles</a></div><div class="ttdeci">Transform round_angles(unsigned n, bool only_zeros)</div><div class="ttdoc">Generate a transform that rounds all angles to the nearest .</div><div class="ttdef"><b>Definition</b> <a href="BasicOptimisation_8cpp_source.html#l00660">BasicOptimisation.cpp:660</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a8d602ed5ee73002e620a6bdd0f39b754"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a8d602ed5ee73002e620a6bdd0f39b754">tket::Transforms::squash_1qb_to_pqp</a></div><div class="ttdeci">Transform squash_1qb_to_pqp(const OpType &amp;q, const OpType &amp;p, bool strict)</div><div class="ttdoc">general u_squash by converting any chains of p, q gates (p, q in {Rx,Ry,Rz}) to triples -p-q-p- or -q...</div><div class="ttdef"><b>Definition</b> <a href="PQPSquash_8cpp_source.html#l00190">PQPSquash.cpp:190</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a90e92f1a8fb65391bba982bb11f84fe9"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a90e92f1a8fb65391bba982bb11f84fe9">tket::Transforms::squash_1qb_to_Rz_PhasedX</a></div><div class="ttdeci">Transform squash_1qb_to_Rz_PhasedX(bool always_squash_symbols)</div><div class="ttdoc">Squash single qubit gates into PhasedX and Rz gates.</div><div class="ttdef"><b>Definition</b> <a href="RzPhasedXSquash_8cpp_source.html#l00096">RzPhasedXSquash.cpp:96</a></div></div>
 <div class="ttc" id="anamespacetket_1_1Transforms_html_a91db90f9f54d874169f619bb3510510d"><div class="ttname"><a href="namespacetket_1_1Transforms.html#a91db90f9f54d874169f619bb3510510d">tket::Transforms::special_UCC_synthesis</a></div><div class="ttdeci">Transform special_UCC_synthesis(PauliSynthStrat strat, CXConfigType cx_config)</div><div class="ttdef"><b>Definition</b> <a href="PauliOptimisation_8cpp_source.html#l00226">PauliOptimisation.cpp:226</a></div></div>