AssertQubit operation

Warning

This documentation refers to the Classic QDK, which has been replaced by the Modern QDK.

Please see https://aka.ms/qdk.api for the API documentation for the Modern QDK.

Namespace: Microsoft.Quantum.Diagnostics

Package: Microsoft.Quantum.QSharp.Foundation

Asserts that the qubit q is in the expected eigenstate of the Pauli Z operator.

operation AssertQubit (expected : Result, q : Qubit) : Unit is Adj + Ctl

Input

expected : Result

Which state the qubit is expected to be in: Zero or One.

q : Qubit

The qubit whose state is asserted.

Output : Unit

Remarks

AssertQubitIsInStateWithinTolerance operation allows for asserting arbitrary qubit states rather than only $Z$ eigenstates.

Note that the Adjoint and Controlled versions of this operation will not check the condition.

See Also