Decoherence

Functions for effecting decoherence channels upon density matrices. More...

Functions
void	mixDamping (Qureg qureg, int qubit, qreal prob)
void	mixDephasing (Qureg qureg, int qubit, qreal prob)
void	mixDepolarising (Qureg qureg, int qubit, qreal prob)
void	mixKrausMap (Qureg qureg, int *targets, int numTargets, KrausMap map)
void	mixKrausMap (Qureg qureg, std::vector< int > targets, KrausMap map)
void	mixPaulis (Qureg qureg, int qubit, qreal probX, qreal probY, qreal probZ)
void	mixQureg (Qureg qureg, Qureg other, qreal prob)
void	mixSuperOp (Qureg qureg, int *targets, int numTargets, SuperOp superop)
void	mixSuperOp (Qureg qureg, std::vector< int > targets, SuperOp superop)
void	mixTwoQubitDephasing (Qureg qureg, int qubit1, int qubit2, qreal prob)
void	mixTwoQubitDepolarising (Qureg qureg, int qubit1, int qubit2, qreal prob)

Detailed Description

Functions for effecting decoherence channels upon density matrices.

Function Documentation

mixDamping()

void mixDamping	(	Qureg	qureg,
		int	qubit,
		qreal	prob )

Note

Documentation for this function or struct is under construction!

Attention

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

Definition at line 91 of file decoherence.cpp.

                                                    {
    validate_quregFields(qureg, __func__);
    validate_target(qureg, qubit, __func__);
    validate_oneQubitDampingProb(prob, __func__);
 
    // permit but do not change non-decohering statevecs
    if (prob == 0) 
        return;
    
    validate_quregIsDensityMatrix(qureg, __func__);
 
    localiser_densmatr_oneQubitDamping(qureg, qubit, prob);
}

Referenced by TEST_CASE(), and TEST_CASE().

mixDephasing()

void mixDephasing	(	Qureg	qureg,
		int	qubit,
		qreal	prob )

Note

Documentation for this function or struct is under construction!

Attention

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

Definition at line 31 of file decoherence.cpp.

                                                      {
    validate_quregFields(qureg, __func__);
    validate_target(qureg, qubit, __func__);
    validate_oneQubitDepashingProb(prob, __func__);
 
    // permit but do not change non-decohering statevecs
    if (prob == 0) 
        return;
    
    validate_quregIsDensityMatrix(qureg, __func__);
 
    localiser_densmatr_oneQubitDephasing(qureg, qubit, prob);
}

Referenced by TEST_CASE(), and TEST_CASE().

mixDepolarising()

void mixDepolarising	(	Qureg	qureg,
		int	qubit,
		qreal	prob )

Note

Documentation for this function or struct is under construction!

Attention

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

Definition at line 61 of file decoherence.cpp.

                                                         {
    validate_quregFields(qureg, __func__);
    validate_target(qureg, qubit, __func__);
    validate_oneQubitDepolarisingProb(prob, __func__);
 
    // permit but do not change non-decohering statevecs
    if (prob == 0) 
        return;
    
    validate_quregIsDensityMatrix(qureg, __func__);
 
    localiser_densmatr_oneQubitDepolarising(qureg, qubit, prob);
}

Referenced by TEST_CASE(), and TEST_CASE().

mixKrausMap() [1/2]

void mixKrausMap	(	Qureg	qureg,
		int *	targets,
		int	numTargets,
		KrausMap	map )

Note

Documentation for this function or struct is under construction!

Attention

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

Definition at line 121 of file decoherence.cpp.

                                                                        {
    validate_quregFields(qureg, __func__);
    validate_quregIsDensityMatrix(qureg, __func__);
    validate_targets(qureg, qubits, numQubits, __func__);
    validate_mixedAmpsFitInNode(qureg, 2*numQubits, __func__); // superop acts on 2x
    validate_krausMapIsCPTP(map, __func__); // also checks fields and is-sync
    validate_krausMapMatchesTargets(map, numQubits, __func__);
 
    localiser_densmatr_krausMap(qureg, map, util_getVector(qubits, numQubits));
}

Referenced by mixKrausMap(), and TEST_CASE().

mixKrausMap() [2/2]

void mixKrausMap	(	Qureg	qureg,
		std::vector< int >	targets,
		KrausMap	map )

Warning

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

Note

Documentation for this function or struct is under construction!

Attention

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

Remarks

This function is only available in C++.

Definition at line 171 of file decoherence.cpp.

                                                                 {
    mixKrausMap(qureg, targets.data(), targets.size(), map);
}

mixPaulis()

void mixPaulis	(	Qureg	qureg,
		int	qubit,
		qreal	probX,
		qreal	probY,
		qreal	probZ )

Note

Documentation for this function or struct is under construction!

Attention

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

Definition at line 106 of file decoherence.cpp.

                                                                              {
    validate_quregFields(qureg, __func__);
    validate_target(qureg, qubit, __func__);
    validate_oneQubitPauliChannelProbs(probX, probY, probZ, __func__);
 
    // permit but do not change non-decohering statevecs
    if (probX == 0 && probY == 0 && probZ == 0)
        return;
 
    validate_quregIsDensityMatrix(qureg, __func__);
 
    localiser_densmatr_oneQubitPauliChannel(qureg, qubit, probX, probY, probZ);
}

Referenced by TEST_CASE().

mixQureg()

void mixQureg	(	Qureg	qureg,
		Qureg	other,
		qreal	prob )

Note

Documentation for this function or struct is under construction!

Attention

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

Definition at line 133 of file decoherence.cpp.

                                                           {
    validate_quregFields(outQureg, __func__);
    validate_quregFields(inQureg, __func__);
    validate_probability(inProb, __func__);
    validate_quregsCanBeMixed(outQureg, inQureg, __func__); // checks outQureg is densmatr
 
    qreal outProb = 1 - inProb;
    localiser_densmatr_mixQureg(outProb, outQureg, inProb, inQureg);
}

Referenced by TEST_CASE().

mixSuperOp() [1/2]

void mixSuperOp	(	Qureg	qureg,
		int *	targets,
		int	numTargets,
		SuperOp	superop )

Note

Documentation for this function or struct is under construction!

Attention

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

Definition at line 144 of file decoherence.cpp.

                                                                            {
    validate_quregFields(qureg, __func__);
    validate_targets(qureg, targets, numTargets, __func__);
    validate_superOpFields(superop, __func__);
    validate_superOpIsSynced(superop, __func__);
    validate_superOpDimMatchesTargs(superop, numTargets, __func__);
    validate_mixedAmpsFitInNode(qureg, 2*numTargets, __func__); // superop acts on 2x
 
    localiser_densmatr_superoperator(qureg, superop, util_getVector(targets, numTargets));
}

Referenced by mixSuperOp(), and TEST_CASE().

mixSuperOp() [2/2]

void mixSuperOp	(	Qureg	qureg,
		std::vector< int >	targets,
		SuperOp	superop )

Warning

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

Note

Documentation for this function or struct is under construction!

Attention

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

Remarks

This function is only available in C++.

Definition at line 175 of file decoherence.cpp.

                                                                   {
    mixSuperOp(qureg, targets.data(), targets.size(), superop);
}

mixTwoQubitDephasing()

void mixTwoQubitDephasing	(	Qureg	qureg,
		int	qubit1,
		int	qubit2,
		qreal	prob )

Note

Documentation for this function or struct is under construction!

Attention

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

Definition at line 46 of file decoherence.cpp.

                                                                           {
    validate_quregFields(qureg, __func__);
    validate_twoTargets(qureg, qubit1, qubit2, __func__);
    validate_twoQubitDepashingProb(prob, __func__);
 
    // permit but do not change non-decohering statevecs
    if (prob == 0) 
        return;
    
    validate_quregIsDensityMatrix(qureg, __func__);
 
    localiser_densmatr_twoQubitDephasing(qureg, qubit1, qubit2, prob);
}

Referenced by TEST_CASE(), and TEST_CASE().

mixTwoQubitDepolarising()

void mixTwoQubitDepolarising	(	Qureg	qureg,
		int	qubit1,
		int	qubit2,
		qreal	prob )

Note

Documentation for this function or struct is under construction!

Attention

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

Definition at line 76 of file decoherence.cpp.

                                                                              {
    validate_quregFields(qureg, __func__);
    validate_twoTargets(qureg, qubit1, qubit2, __func__);
    validate_twoQubitDepolarisingProb(prob, __func__);
 
    // permit but do not change non-decohering statevecs
    if (prob == 0) 
        return;
    
    validate_quregIsDensityMatrix(qureg, __func__);
 
    localiser_densmatr_twoQubitDepolarising(qureg, qubit1, qubit2, prob);
}

Referenced by TEST_CASE(), and TEST_CASE().