Skip to content

added calcAmpSum frontend #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions quest/include/calculations.h
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,44 @@ Qureg calcReducedDensityMatrix(Qureg qureg, int* retainQubits, int numRetainQubi
*/


/** @ingroup example_prs
*
* Calculates the sum of every amplitude in the state.
*
* @formulae
* Let @f$ n @f$ qubits be the number of qubits in @p qureg.
*
* - When @p qureg is a statevector @f$ \svpsi @f$, this function returns
* @f[
\sum\limits_i^{2^n} \langle i \svpsi \in \mathbb{C}.
* @f]
* - When @p qureg is a density matrix @f$ \dmrho @f$, this function returns
* @f[
\sum\limits_i^{2^n} \sum\limits_j^{2^n} \bra{i} \dmrho \ket{j} \in \mathbb{C}.
* @f]
*
* @myexample
* ```
Qureg qureg = createQureg(4);
initRandomPureState(qureg);

qcomp ampSum = calcAmpSum(qureg);
reportScalar("ampSum", ampSum);
* ```
*
* @see
* - calcRealAmpSum()

* @param[in] qureg the state with the processed amplitudes.
* @returns The the sum of all contained amplitudes.
* @throws @validationerror
* - if @p qureg is uninitialised.
* - if @p qureg contains an odd number of qubits.
* @author Tyson Jones
*/
qcomp calcAmpSum(Qureg qureg);


/// @ingroup calc_comparisons
/// @notdoced
/// @notvalidated
Expand Down
9 changes: 9 additions & 0 deletions quest/include/wrappers.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,15 @@
#ifndef __cplusplus


extern void _wrap_calcAmpSum(Qureg qureg, qcomp* out);

qcomp calcAmpSum(Qureg qureg) {

qcomp out;
_wrap_calcAmpSum(qureg, &out);
return out;
}


extern void _wrap_calcInnerProduct(Qureg bra, Qureg ket, qcomp* out);

Expand Down
11 changes: 11 additions & 0 deletions quest/src/api/calculations.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,17 @@ extern Qureg validateAndCreateCustomQureg(
*/


qcomp calcAmpSum(Qureg qureg) {
validate_quregFields(qureg, __func__);

return localiser_statevec_calcAmpSum(qureg);
}
extern "C" void _wrap_calcAmpSum(Qureg qureg, qcomp* out) {

*out = calcAmpSum(qureg);
}


qcomp calcInnerProduct(Qureg quregA, Qureg quregB) {
validate_quregFields(quregA, __func__);
validate_quregFields(quregB, __func__);
Expand Down
24 changes: 24 additions & 0 deletions tests/unit/calculations.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,30 @@ TEST_CASE( "calcRealAmpSum", TEST_CATEGORY ) {



TEST_CASE( "calcAmpSum", TEST_CATEGORY ) {

SECTION( LABEL_CORRECTNESS ) {

TEST_ALL_QUREGS(
qureg, calcAmpSum(qureg),
refer, getTotal(refer)
);
}

SECTION( LABEL_VALIDATION ) {

SECTION( "qureg uninitialised" ) {

Qureg qureg;
qureg.numQubits = -123;

REQUIRE_THROWS_WITH( calcRealAmpSum(qureg), ContainsSubstring("invalid Qureg") );
}
}
}



TEST_CASE( "calcExpecPauliStr", TEST_CATEGORY ) {

SECTION( LABEL_CORRECTNESS ) {
Expand Down