Getters

Functions for obtaining amplitudes from statevectors or density matrices. More...

Functions
qcomp	getDensityQuregAmp (Qureg qureg, qindex row, qindex column)
void	getDensityQuregAmps (qcomp **outAmps, Qureg qureg, qindex startRow, qindex startCol, qindex numRows, qindex numCols)
std::vector< std::vector< qcomp > >	getDensityQuregAmps (Qureg qureg, qindex startRow, qindex startCol, qindex numRows, qindex numCols)
qcomp	getQuregAmp (Qureg qureg, qindex index)
void	getQuregAmps (qcomp *outAmps, Qureg qureg, qindex startInd, qindex numAmps)
std::vector< qcomp >	getQuregAmps (Qureg qureg, qindex startInd, qindex numAmps)

Detailed Description

Functions for obtaining amplitudes from statevectors or density matrices.

Function Documentation

getDensityQuregAmp()

qcomp getDensityQuregAmp	(	Qureg	qureg,
		qindex	row,
		qindex	column )

Note

Documentation for this function or struct is under construction!

Definition at line 497 of file qureg.cpp.

                                                                 {
    validate_quregFields(qureg, __func__);
    validate_quregIsDensityMatrix(qureg, __func__);
    validate_basisStateRowCol(qureg, row, column, __func__);
 
    qindex ind = util_getGlobalFlatIndex(qureg, row, column);
    qcomp amp = localiser_statevec_getAmp(qureg, ind);
    return amp;
}

Referenced by TEST_CASE().

getDensityQuregAmps() [1/2]

void getDensityQuregAmps	(	qcomp **	outAmps,
		Qureg	qureg,
		qindex	startRow,
		qindex	startCol,
		qindex	numRows,
		qindex	numCols )

Note

Documentation for this function or struct is under construction!

Definition at line 457 of file qureg.cpp.

                                                                                                                         {
    validate_quregFields(qureg, __func__);
    validate_quregIsDensityMatrix(qureg, __func__);
    validate_basisStateRowCols(qureg, startRow, startCol, numRows, numCols, __func__);
 
    localiser_densmatr_getAmps(outAmps, qureg, startRow, startCol, numRows, numCols);
}

Referenced by getDensityQuregAmps(), and TEST_CASE().

getDensityQuregAmps() [2/2]

std::vector< std::vector< qcomp > > getDensityQuregAmps	(	Qureg	qureg,
		qindex	startRow,
		qindex	startCol,
		qindex	numRows,
		qindex	numCols )

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Attention

This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 531 of file qureg.cpp.

                                                                                                                         {
 
    // allocate the output matrix, and validate successful
    vector<vector<qcomp>> out;
    qindex numElems = numRows * numCols; // never overflows (else Qureg alloc would fail)
    auto callback1 = [&]() { validate_tempAllocSucceeded(false, numElems, sizeof(qcomp), __func__); };
    util_tryAllocMatrix(out, numRows, numCols, callback1);
 
    // we must pass nested pointers to core C function, requiring another temp array, also validated
    vector<qcomp*> ptrs;
    auto callback2 = [&]() { validate_tempAllocSucceeded(false, numRows, sizeof(qcomp*), __func__); };
    util_tryAllocVector(ptrs, numRows, callback2);
 
    // embed out pointers
    for (qindex i=0; i<numRows; i++)
        ptrs[i] = out[i].data();
 
    // modify out through its ptrs
    getDensityQuregAmps(ptrs.data(), qureg, startRow, startCol, numRows, numCols);
    return out;
}

getQuregAmp()

qcomp getQuregAmp	(	Qureg	qureg,
		qindex	index )

Note

Documentation for this function or struct is under construction!

Definition at line 484 of file qureg.cpp.

                                             {
    validate_quregFields(qureg, __func__);
    validate_quregIsStateVector(qureg, __func__);
    validate_basisStateIndex(qureg, index, __func__);
 
    return localiser_statevec_getAmp(qureg, index);
}

Referenced by TEST_CASE().

getQuregAmps() [1/2]

void getQuregAmps	(	qcomp *	outAmps,
		Qureg	qureg,
		qindex	startInd,
		qindex	numAmps )

Note

Documentation for this function or struct is under construction!

Definition at line 448 of file qureg.cpp.

                                                                                {
    validate_quregFields(qureg, __func__);
    validate_quregIsStateVector(qureg, __func__);
    validate_basisStateIndices(qureg, startInd, numAmps, __func__);
 
    localiser_statevec_getAmps(outAmps, qureg, startInd, numAmps);
}

Referenced by getQuregAmps(), and TEST_CASE().

getQuregAmps() [2/2]

std::vector< qcomp > getQuregAmps	(	Qureg	qureg,
		qindex	startInd,
		qindex	numAmps )

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Attention

This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 518 of file qureg.cpp.

                                                                         {
 
    // allocate the output vector, and validate successful
    vector<qcomp> out;
    auto callback = [&]() { validate_tempAllocSucceeded(false, numAmps, sizeof(qcomp), __func__); };
    util_tryAllocVector(out, numAmps, callback);
 
    // performs main validation
    getQuregAmps(out.data(), qureg, startInd, numAmps);
    return out;
}