--- title: LinearPauliRotations (v1.0) description: API reference for qiskit.circuit.library.LinearPauliRotations in qiskit v1.0 source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit/1.0/qiskit.circuit.library.LinearPauliRotations --- # LinearPauliRotations *class* `qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py#L24-L189) Bases: [`FunctionalPauliRotations`](/docs/api/qiskit/1.0/qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. For a register of state qubits $|x\rangle$, a target qubit $|0\rangle$ and the basis `'Y'` this circuit acts as: ```python q_0: ─────────────────────────■───────── ... ────────────────────── │ . │ q_(n-1): ─────────────────────────┼───────── ... ───────────■────────── ┌────────────┐ ┌───────┴───────┐ ┌─────────┴─────────┐ q_n: ─┤ RY(offset) ├──┤ RY(2^0 slope) ├ ... ┤ RY(2^(n-1) slope) ├ └────────────┘ └───────────────┘ └───────────────────┘ ``` This can for example be used to approximate linear functions, with $a =$ `slope`$/2$ and $b =$ `offset`$/2$ and the basis `'Y'`: $$ |x\rangle |0\rangle \mapsto \cos(ax + b)|x\rangle|0\rangle + \sin(ax + b)|x\rangle |1\rangle $$ Since for small arguments $\sin(x) \approx x$ this operator can be used to approximate linear functions. Create a new linear rotation circuit. **Parameters** - **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The number of qubits representing the state $|x\rangle$. - **slope** ([*float*](https://docs.python.org/3/library/functions.html#float)) – The slope of the controlled rotation. - **offset** ([*float*](https://docs.python.org/3/library/functions.html#float)) – The offset of the controlled rotation. - **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The type of Pauli rotation (‘X’, ‘Y’, ‘Z’). - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The name of the circuit object. ## Attributes ### ancillas Returns a list of ancilla bits in the order that the registers were added. ### basis The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. **Returns** The kind of Pauli rotation used in controlled rotation. ### calibrations Return calibration dictionary. The custom pulse definition of a given gate is of the form `{'gate_name': {(qubits, params): schedule}}` ### clbits Returns a list of classical bits in the order that the registers were added. ### data ### global\_phase Return the global phase of the current circuit scope in radians. ### instances Default value: `196` ### layout Return any associated layout information about the circuit This attribute contains an optional [`TranspileLayout`](/docs/api/qiskit/1.0/qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") object. This is typically set on the output from [`transpile()`](/docs/api/qiskit/1.0/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or [`PassManager.run()`](/docs/api/qiskit/1.0/qiskit.transpiler.PassManager#run "qiskit.transpiler.PassManager.run") to retain information about the permutations caused on the input circuit by transpilation. There are two types of permutations caused by the [`transpile()`](/docs/api/qiskit/1.0/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") function, an initial layout which permutes the qubits based on the selected physical qubits on the [`Target`](/docs/api/qiskit/1.0/qiskit.transpiler.Target "qiskit.transpiler.Target"), and a final layout which is an output permutation caused by [`SwapGate`](/docs/api/qiskit/1.0/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s inserted during routing. ### metadata The user provided metadata associated with the circuit. The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. ### num\_ancilla\_qubits The minimum number of ancilla qubits in the circuit. **Returns** The minimal number of ancillas required. ### num\_ancillas Return the number of ancilla qubits. ### num\_clbits Return number of classical bits. ### num\_parameters ### num\_qubits Return number of qubits. ### num\_state\_qubits The number of state qubits representing the state $|x\rangle$. **Returns** The number of state qubits. ### offset The angle of the single qubit offset rotation on the target qubit. Before applying the controlled rotations, a single rotation of angle `offset` is applied to the target qubit. **Returns** The offset angle. ### op\_start\_times Return a list of operation start times. This attribute is enabled once one of scheduling analysis passes runs on the quantum circuit. **Returns** List of integers representing instruction start times. The index corresponds to the index of instruction in `QuantumCircuit.data`. **Raises** [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError) – When circuit is not scheduled. ### parameters ### prefix Default value: `'circuit'` ### qregs Type: `list[QuantumRegister]` A list of the quantum registers associated with the circuit. ### qubits Returns a list of quantum bits in the order that the registers were added. ### slope The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. **Returns** The rotation angle common in all controlled rotations.