classiq 0.54.0__py3-none-any.whl → 0.56.0__py3-none-any.whl

classiq/qmod/builtins/functions/qsvt.py

@@ -34,9 +34,6 @@ def qsvt_step(
         u: A block encoded unitary matrix.
         qvar: The quantum variable to which U is applied, which resides in the entire block encoding space.
         aux: A zero auxilliary qubit, used for the projector-controlled-phase rotations. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
-
-    Further reading in Classiq Library:
-        [QSVT function usage example](https://docs.classiq.io/latest/explore/functions/qmod_library_reference/classiq_open_library/qsvt/qsvt/)
     """
     u(qvar)
     projector_controlled_phase(phase1, proj_cnot_2, qvar, aux)
@@ -80,9 +77,6 @@ def qsvt(
         u: A block encoded unitary matrix.
         qvar: The quantum variable to which U is applied, which resides in the entire block encoding space.
         aux: A zero auxilliary qubit, used for the projector-controlled-phase rotations. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
-
-    Further reading in Classiq Library:
-        [QSVT function usage example](https://docs.classiq.io/latest/explore/functions/qmod_library_reference/classiq_open_library/qsvt/qsvt/)
     """
     H(aux)
 
@@ -138,9 +132,6 @@ def projector_controlled_phase(
         proj_cnot: Projector-controlled-not unitary that sets an auxilliary qubit to |1> when the state is in the projection.
         qvar: The quantum variable to which the rotation applies, which resides in the entire block encoding space.
         aux: A zero auxilliary qubit, used for the projector-controlled-phase rotation. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
-
-    Further reading in Classiq Library:
-        [QSVT function usage example](https://docs.classiq.io/latest/explore/functions/qmod_library_reference/classiq_open_library/qsvt/qsvt/)
     """
     proj_cnot(qvar, aux)
     RZ(phase, aux)
@@ -167,9 +158,6 @@ def qsvt_inversion(
         u: A block encoded unitary matrix.
         qvar: The quantum variable to which U is applied, which resides in the entire block encoding space.
         aux: A zero auxilliary qubit, used for the projector-controlled-phase rotations. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
-
-    For usage example, see:
-        [QSVT matrix inversion example](https://docs.classiq.io/latest/explore/algorithms/qsvt/qsvt_matrix_inversion/qsvt_matrix_inversion)
     """
     qsvt(
         phase_seq,

classiq/qmod/builtins/functions/standard_gates.py

@@ -18,12 +18,8 @@ def H(target: QBit) -> None:
     H = \\frac{1}{\\sqrt{2}} \\begin{bmatrix} 1 & 1 \\\\ 1 & -1 \\end{bmatrix}
     $$
 
-    More information on quantum logic gates can be found on [Wikipedia](https://en.wikipedia.org/wiki/Quantum_logic_gate).
-
     Args:
         target: The qubit to apply the Hadamard gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -41,12 +37,8 @@ def X(target: QBit) -> None:
     X = \\begin{bmatrix} 0 & 1 \\\\ 1 & 0 \\end{bmatrix}
     $$
 
-    More information on quantum logic gates can be found on [Wikipedia](https://en.wikipedia.org/wiki/Quantum_logic_gate).
-
     Args:
         target: The qubit to apply the Pauli-X gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -64,12 +56,8 @@ def Y(target: QBit) -> None:
     Y = \\begin{bmatrix} 0 & -i \\\\ i & 0 \\end{bmatrix}
     $$
 
-    More information on quantum logic gates can be found on [Wikipedia](https://en.wikipedia.org/wiki/Quantum_logic_gate).
-
     Args:
         target: The qubit to apply the Pauli-Y gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -87,12 +75,8 @@ def Z(target: QBit) -> None:
     Z = \\begin{bmatrix} 1 & 0 \\\\ 0 & -1 \\end{bmatrix}
     $$
 
-    More information on quantum logic gates can be found on [Wikipedia](https://en.wikipedia.org/wiki/Quantum_logic_gate).
-
     Args:
         target: The qubit to apply the Pauli-Z gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -110,12 +94,8 @@ def I(target: QBit) -> None:
     I = \\begin{bmatrix} 1 & 0 \\\\ 0 & 1 \\end{bmatrix}
     $$
 
-    More information on quantum logic gates can be found on [Wikipedia](https://en.wikipedia.org/wiki/Quantum_logic_gate).
-
     Args:
         target: The qubit to apply the identity gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -135,8 +115,6 @@ def S(target: QBit) -> None:
 
     Args:
         target: The qubit to apply the S gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -156,8 +134,6 @@ def T(target: QBit) -> None:
 
     Args:
         target: The qubit to apply the T gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -177,8 +153,6 @@ def SDG(target: QBit) -> None:
 
     Args:
         target: The qubit to apply the S-dagger gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -198,8 +172,6 @@ def TDG(target: QBit) -> None:
 
     Args:
         target: The qubit to apply the T-dagger gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -217,13 +189,9 @@ def PHASE(theta: CReal, target: QBit) -> None:
     PHASE(\\theta) = \\begin{bmatrix} 1 & 0 \\\\ 0 & e^{i\\theta} \\end{bmatrix}
     $$
 
-    More information on quantum logic gates can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_quantum_logic_gates#Relative_phase_gates).
-
     Args:
         theta: The phase angle in radians.
         target: The qubit to apply the phase gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -242,13 +210,9 @@ def RX(theta: CReal, target: QBit) -> None:
      = \\begin{bmatrix} cos(\\frac{\\theta}{2}) & -i sin(\\frac{\\theta}{2}) \\\\ -i sin(\\frac{\\theta}{2}) & cos(\\frac{\\theta}{2}) \\end{bmatrix}
     $$
 
-    More information on quantum logic gates can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_quantum_logic_gates#Rotation_operator_gates).
-
     Args:
         theta: The rotation angle in radians.
         target: The qubit to apply the Pauli-X rotation gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -267,13 +231,9 @@ def RY(theta: CReal, target: QBit) -> None:
      = \\begin{bmatrix} cos(\\frac{\\theta}{2}) & -sin(\\frac{\\theta}{2}) \\\\ -sin(\\frac{\\theta}{2}) & cos(\\frac{\\theta}{2}) \\end{bmatrix}
     $$
 
-    More information on quantum logic gates can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_quantum_logic_gates#Rotation_operator_gates).
-
     Args:
         theta: The rotation angle in radians.
         target: The qubit to apply the Pauli-Y rotation gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -292,13 +252,9 @@ def RZ(theta: CReal, target: QBit) -> None:
      = \\begin{bmatrix} e^{-i\\frac{\\theta}{2}} & 0 \\\\ 0 & e^{i\\frac{\\theta}{2}} \\end{bmatrix}
     $$
 
-    More information on quantum logic gates can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_quantum_logic_gates#Rotation_operator_gates).
-
     Args:
         theta: The rotation angle in radians.
         target: The qubit to apply the Pauli-Z rotation gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -317,14 +273,10 @@ def R(theta: CReal, phi: CReal, target: QBit) -> None:
      = \\begin{bmatrix} cos(\\frac{\\theta}{2}) & -i e^{-i\\phi} sin(\\frac{\\theta}{2}) \\\\ -i e^{i\\phi} sin(\\frac{\\theta}{2}) & cos(\\frac{\\theta}{2}) \\end{bmatrix}
     $$
 
-    More information on this gate can be found in the [Qiskit documentation](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.RGate).
-
     Args:
         theta: The rotation angle in radians.
         phi: The phase angle in radians.
         target: The qubit to apply the general single-qubit rotation gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -343,13 +295,9 @@ def RXX(theta: CReal, target: QArray[QBit, Literal[2]]) -> None:
      = \\begin{bmatrix} cos(\\frac{\\theta}{2}) & 0 & 0 & -i sin(\\frac{\\theta}{2}) \\\\ 0 & cos(\\frac{\\theta}{2}) & -i sin(\\frac{\\theta}{2}) & 0 \\\\ 0 & -i sin(\\frac{\\theta}{2}) & cos(\\frac{\\theta}{2}) & 0 \\\\ -i sin(\\frac{\\theta}{2}) & 0 & 0 & cos(\\frac{\\theta}{2}) \\end{bmatrix}
     $$
 
-    For more information on quantum logic gates, see [Wikipedia](https://en.wikipedia.org/wiki/List_of_quantum_logic_gates#Two-qubit_interaction_gates).
-
     Args:
         theta: The rotation angle in radians.
         target: The pair of qubits to apply the XX rotation gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -368,13 +316,9 @@ def RYY(theta: CReal, target: QArray[QBit, Literal[2]]) -> None:
      = \\begin{bmatrix} cos(\\frac{\\theta}{2}) & 0 & 0 & -sin(\\frac{\\theta}{2}) \\\\ 0 & cos(\\frac{\\theta}{2}) & sin(\\frac{\\theta}{2}) & 0 \\\\ 0 & sin(\\frac{\\theta}{2}) & cos(\\frac{\\theta}{2}) & 0 \\\\ -sin(\\frac{\\theta}{2}) & 0 & 0 & cos(\\frac{\\theta}{2}) \\end{bmatrix}
     $$
 
-    For more information on quantum logic gates, see [Wikipedia](https://en.wikipedia.org/wiki/List_of_quantum_logic_gates#Two-qubit_interaction_gates).
-
     Args:
         theta: The rotation angle in radians.
         target: The pair of qubits to apply the YY rotation gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -393,13 +337,9 @@ def RZZ(theta: CReal, target: QArray[QBit, Literal[2]]) -> None:
      = \\begin{bmatrix} e^{-i\\frac{\\theta}{2}} & 0 & 0 & 0 \\\\ 0 & e^{i\\frac{\\theta}{2}} & 0 & 0 \\\\ 0 & 0 & e^{i\\frac{\\theta}{2}} & 0 \\\\ 0 & 0 & 0 & e^{-i\\frac{\\theta}{2}} \\end{bmatrix}
     $$
 
-    For more information on quantum logic gates, see [Wikipedia](https://en.wikipedia.org/wiki/List_of_quantum_logic_gates#Two-qubit_interaction_gates).
-
     Args:
         theta: The rotation angle in radians.
         target: The pair of qubits to apply the ZZ rotation gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -425,8 +365,6 @@ def CH(ctrl: QBit, target: QBit) -> None:
     Args:
         ctrl: The control qubit.
         target: The qubit to apply the Hadamard gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -452,8 +390,6 @@ def CX(ctrl: QBit, target: QBit) -> None:
     Args:
         ctrl: The control qubit.
         target: The qubit to apply the Pauli-X gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -479,8 +415,6 @@ def CY(ctrl: QBit, target: QBit) -> None:
     Args:
         ctrl: The control qubit.
         target: The qubit to apply the Pauli-Y gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -506,8 +440,6 @@ def CZ(ctrl: QBit, target: QBit) -> None:
     Args:
         ctrl: The control qubit.
         target: The qubit to apply the Pauli-Z gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -534,8 +466,6 @@ def CRX(theta: CReal, ctrl: QBit, target: QBit) -> None:
         theta: The rotation angle in radians.
         ctrl: The control qubit.
         target: The qubit to apply the RX gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -562,8 +492,6 @@ def CRY(theta: CReal, ctrl: QBit, target: QBit) -> None:
         theta (CReal): The rotation angle in radians.
         ctrl (QBit): The control qubit.
         target (QBit): The qubit to apply the RY gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -590,8 +518,6 @@ def CRZ(theta: CReal, ctrl: QBit, target: QBit) -> None:
         theta (CReal): The rotation angle in radians.
         ctrl (QBit): The control qubit.
         target (QBit): The qubit to apply the RZ gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -618,8 +544,6 @@ def CPHASE(theta: CReal, ctrl: QBit, target: QBit) -> None:
         theta (CReal): The rotation angle in radians.
         ctrl (QBit): The control qubit.
         target (QBit): The qubit to apply the PHASE gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -645,8 +569,6 @@ def SWAP(qbit0: QBit, qbit1: QBit) -> None:
     Args:
         qbit0 (QBit): The first qubit.
         qbit1 (QBit): The second qubit.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -669,8 +591,6 @@ def IDENTITY(target: QArray[QBit]) -> None:
 
     Args:
         target (QArray[QBit]): The qubits to apply the IDENTITY gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -692,16 +612,12 @@ def U(theta: CReal, phi: CReal, lam: CReal, gam: CReal, target: QBit) -> None:
     \\end{bmatrix}
     $$
 
-    More information on this gate can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_quantum_logic_gates#Other_named_gates).
-
     Args:
         theta (CReal): The first Euler angle in radians.
         phi (CReal): The second Euler angle in radians.
         lam (CReal): The third Euler angle in radians.
         gam (CReal): The global phase angle in radians.
         target (QBit): The qubit to apply the general single-qubit unitary gate to.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass
 
@@ -728,12 +644,8 @@ def CCX(ctrl: QArray[QBit, Literal[2]], target: QBit) -> None:
     \\end{bmatrix}
     $$
 
-    More information can be found on [Wikipedia](https://en.wikipedia.org/wiki/Toffoli_gate).
-
     Args:
         ctrl (QArray[QBit, Literal[2]]): The control qubits.
         target (QBit): The qubit to apply the conditioned Pauli-X gate on.
-
-    Link: [Reference Manual](https://docs.classiq.io/latest/reference-manual/qmod/library-reference/core-library-functions/standard_gates/standard_gates/)
     """
     pass

classiq/qmod/builtins/functions/state_preparation.py

@@ -37,12 +37,11 @@ def allocate(
 
     Args:
         num_qubits: The number of qubits to allocate. Must be a positive integer.
-        out: The quantum variable that will receive the allocated qubits. Must be uninitialized before allocation. For more information on quantum variable initialization, see [here](https://docs.classiq.io/latest/reference-manual/qmod/language-reference/quantum-variables/).
+        out: The quantum variable that will receive the allocated qubits. Must be uninitialized before allocation.
 
     Notes:
         1. If the output variable has been declared with a specific number of qubits, the number of qubits allocated must match the declared number.
         2. The synthesis engine automatically handles the allocation, either by drawing new qubits from the available pool or by reusing existing ones.
-
     """
     pass
 
@@ -65,9 +64,6 @@ def allocate_num(
         num_qubits: The number of qubits to allocate.
         is_signed: Whether the number is signed or unsigned.
         fraction_digits: The number of fractional digits.
-
-    Further reading is available on the [reference manual](https://docs.classiq.io/latest/reference-manual/qmod/language-reference/quantum-types#allocate-num)
-
     """
     allocate(num_qubits, out)
 
@@ -80,7 +76,7 @@ def free(in_: Input[QArray[QBit]]) -> None:
     Releases the qubits allocated to a quantum variable, allowing them to be reused.
 
     Args:
-        in_: The quantum variable that will be freed. Must be initialized before. For more information on quantum variable initialization, see [here](https://docs.classiq.io/latest/reference-manual/qmod/language-reference/quantum-variables/).
+        in_: The quantum variable that will be freed. Must be initialized before.
 
     Note:
         This operation does not uncompute the qubits. It is the responsibility of the user to ensure that the qubits are at the zero state before freeing them.
@@ -108,12 +104,11 @@ def prepare_state(
     Args:
         probabilities: The probability distribution to initialize the quantum variable. Must be a valid probability distribution, i.e., a list of non-negative real numbers that sum to 1. Must have a valid length (a power of 2).
         bound: An error bound, expressed as the $L^{2}$ norm between the expected and actual distributions. A larger bound can reduce the circuit size at the expense of accuracy. Must be a positive real number.
-        out: The quantum variable that will receive the initialized state. Must be uninitialized. For more information on quantum variable initialization, see [here](https://docs.classiq.io/latest/reference-manual/qmod/language-reference/quantum-variables/).
+        out: The quantum variable that will receive the initialized state. Must be uninitialized.
 
     Notes:
         1. If the output variable has been declared with a specific number of qubits, the number of qubits formed by the distribution must match the declared number.
         2. The synthesis engine automatically handles the allocation, either by drawing new qubits from the available pool or by reusing existing ones.
-
     """
     pass
 
@@ -138,12 +133,11 @@ def prepare_amplitudes(
     Args:
         amplitudes: The amplitudes to initialize the quantum variable. Must be a valid real quantum state vector, i.e., the sum of squares should be 1. Must have a valid length (a power of 2).
         bound: An error bound, expressed as the $L^{2}$ norm between the expected and actual distributions. A larger bound can reduce the circuit size at the expense of accuracy. Must be a positive real number.
-        out: The quantum variable that will receive the initialized state. Must be uninitialized. For more information on quantum variable initialization, see [here](https://docs.classiq.io/latest/reference-manual/qmod/language-reference/quantum-variables/).
+        out: The quantum variable that will receive the initialized state. Must be uninitialized.
 
     Notes:
         1. If the output variable has been declared with a specific number of qubits, the number of qubits formed by the distribution must match the declared number.
         2. The synthesis engine automatically handles the allocation, either by drawing new qubits from the available pool or by reusing existing ones.
-
     """
     pass
 
@@ -237,7 +231,7 @@ def prepare_uniform_trimmed_state(m: CInt, q: QArray[QBit]) -> None:
 
     Args:
         m: The number of states to load in the superposition.
-        q: The quantum variable that will receive the initialized state. Must be uninitialized. For more information on quantum variable initialization, see [here](https://docs.classiq.io/latest/reference-manual/qmod/language-reference/quantum-variables/).
+        q: The quantum variable that will receive the initialized state. Must be uninitialized.
 
     Notes:
         1. If the output variable has been declared with a specific number of qubits, it must match the number of allocated qubits.
@@ -283,7 +277,7 @@ def prepare_uniform_interval_state(start: CInt, end: CInt, q: QArray[QBit]) -> N
     Args:
         start: The lower bound of the interval to load (inclusive).
         end: The upper bound of the interval to load (exclusive).
-        q: The quantum variable that will receive the initialized state. Must be uninitialized. For more information on quantum variable initialization, see [here](https://docs.classiq.io/latest/reference-manual/qmod/language-reference/quantum-variables/).
+        q: The quantum variable that will receive the initialized state. Must be uninitialized.
 
     Notes:
         1. If the output variable has been declared with a specific number of qubits, it must match the number of allocated qubits.
@@ -340,8 +334,6 @@ def prepare_exponential_state(rate: CInt, q: QArray[QBit]) -> None:
     Args:
         rate: The rate of the exponential decay.
         q: The quantum register to prepare.
-
-    Further reading is available on the [reference manual](https://docs.classiq.io/latest/explore/functions/qmod_library_reference/classiq_open_library/special_state_preparations/prepare_exponential_state)
     """
     repeat(q.len, lambda i: RY(2.0 * atan(exp((-rate * 2.0**i) / 2.0)), q[i]))
 
@@ -433,7 +425,7 @@ def prepare_int(
 
     Args:
         value: The value to assign to the quantum variable.
-        out: The allocated quantum variable. Must be uninitialized. For more information on quantum variable initialization, see [here](https://docs.classiq.io/latest/reference-manual/qmod/language-reference/quantum-variables/).
+        out: The allocated quantum variable. Must be uninitialized.
 
     Note:
         If the output variable has been declared with a specific number of qubits, it must match the number of allocated qubits.

classiq/qmod/builtins/functions/swap_test.py

@@ -21,9 +21,6 @@ def swap_test(state1: QArray[QBit], state2: QArray[QBit], test: Output[QBit]) ->
         state1: A quantum state to check its overlap with state2.
         state2: A quantum state to check its overlap with state1.
         test: A qubit for which the probability of measuring 0 is $0.5*(|\\langle state1 | state2 \\rangle |^2+1)$
-
-    Example:
-        Further reading in the Classiq library is found [here](https://docs.classiq.io/latest/explore/algorithms/swap_test/swap_test/).
     """
     allocate(1, test)
     H(test)