---
title: PiecewisePolynomialPauliRotations (v1.1)
description: API reference for qiskit.circuit.library.PiecewisePolynomialPauliRotations in qiskit v1.1
source: https://quantum.cloud.ibm.com/docs/en/api/qiskit/1.1/qiskit.circuit.library.PiecewisePolynomialPauliRotations
---

# PiecewisePolynomialPauliRotations

*class* `qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py#L27-L317)

Bases: [`FunctionalPauliRotations`](/docs/api/qiskit/1.1/qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations")

Piecewise-polynomially-controlled Pauli rotations.

This class implements a piecewise polynomial (not necessarily continuous) function, $f(x)$, on qubit amplitudes, which is defined through breakpoints and coefficients as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding coefficients by $[a_{j,1},...,a_{j,d}]$, where $d$ is the highest degree among all polynomials.

Then $f(x)$ is defined as:

$$
f(x) = \begin{cases}
0, x < x_0 \\
\sum_{i=0}^{i=d}a_{j,i}/2 x^i, x_j \leq x < x_{j+1}
\end{cases}
$$

where if given the same number of breakpoints as polynomials, we implicitly assume $x_{J+1} = 2^n$.

> **Note**
>
> Note the $1/2$ factor in the coefficients of $f(x)$, this is consistent with Qiskit’s Pauli rotations.

**Examples**

```python
>>> from qiskit import QuantumCircuit
>>> from qiskit.circuit.library.arithmetic.piecewise_polynomial_pauli_rotations import\
... PiecewisePolynomialPauliRotations
>>> qubits, breakpoints, coeffs = (2, [0, 2], [[0, -1.2],[-1, 1, 3]])
>>> poly_r = PiecewisePolynomialPauliRotations(num_state_qubits=qubits,
...breakpoints=breakpoints, coeffs=coeffs)
>>>
>>> qc = QuantumCircuit(poly_r.num_qubits)
>>> qc.h(list(range(qubits)));
>>> qc.append(poly_r.to_instruction(), list(range(qc.num_qubits)));
>>> qc.draw()
     ┌───┐┌──────────┐
q_0: ┤ H ├┤0         ├
     ├───┤│          │
q_1: ┤ H ├┤1         ├
     └───┘│          │
q_2: ─────┤2         ├
          │  pw_poly │
q_3: ─────┤3         ├
          │          │
q_4: ─────┤4         ├
          │          │
q_5: ─────┤5         ├
          └──────────┘
```

**References**

**\[1]: Haener, T., Roetteler, M., & Svore, K. M. (2018).**

Optimizing Quantum Circuits for Arithmetic. [arXiv:1805.12445](http://arxiv.org/abs/1805.12445)

**\[2]: Carrera Vazquez, A., Hiptmair, R., & Woerner, S. (2022).**

Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ACM Transactions on Quantum Computing 3, 1, Article 2](https://doi.org/10.1145/3490631)

**Parameters**

- **num\_state\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]*) – The number of qubits representing the state.
- **breakpoints** (*Optional\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]*) – The breakpoints to define the piecewise-linear function. Defaults to `[0]`.
- **coeffs** (*Optional\[List\[List\[*[*float*](https://docs.python.org/3/library/functions.html#float)*]]]*) – The coefficients of the polynomials for different segments of the
- **x** (*piecewise-linear function. coeffs\[j]\[i] is the coefficient of the i-th power of*) –
- **polynomial.** (*for the j-th*) – Defaults to linear: `[[1]]`.
- **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.

## Attributes

### ancillas

A list of `AncillaQubit`s in the order that they were added. You should not mutate this.

### 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.

### breakpoints

The breakpoints of the piecewise polynomial function.

The function is polynomial in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`.

**Returns**

The list of breakpoints.

### calibrations

Return calibration dictionary.

The custom pulse definition of a given gate is of the form `{'gate_name': {(qubits, params): schedule}}`

### clbits

A list of `Clbit`s in the order that they were added. You should not mutate this.

### coeffs

The coefficients of the polynomials.

**Returns**

The polynomial coefficients per interval as nested lists.

### contains\_zero\_breakpoint

Whether 0 is the first breakpoint.

**Returns**

True, if 0 is the first breakpoint, otherwise False.

### data

### global\_phase

The global phase of the current circuit scope in radians.

### instances

Default value: `256`

### layout

Return any associated layout information about the circuit

This attribute contains an optional [`TranspileLayout`](/docs/api/qiskit/1.1/qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") object. This is typically set on the output from [`transpile()`](/docs/api/qiskit/1.1/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or [`PassManager.run()`](/docs/api/qiskit/1.1/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.1/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.1/qiskit.transpiler.Target "qiskit.transpiler.Target"), and a final layout which is an output permutation caused by [`SwapGate`](/docs/api/qiskit/1.1/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s inserted during routing.

### mapped\_coeffs

The coefficients mapped to the internal representation, since we only compare x>=breakpoint.

**Returns**

The mapped coefficients.

### metadata

Arbitrary user-defined metadata for the circuit.

Qiskit will not examine the content of this mapping, but it will pass it through the transpiler and reattach it to the output, so you can track your own metadata.

### 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\_captured\_vars

The number of real-time classical variables in the circuit marked as captured from an enclosing scope.

This is the length of the `iter_captured_vars()` iterable. If this is non-zero, [`num_input_vars`](#qiskit.circuit.library.PiecewisePolynomialPauliRotations.num_input_vars "qiskit.circuit.library.PiecewisePolynomialPauliRotations.num_input_vars") must be zero.

### num\_clbits

Return number of classical bits.

### num\_declared\_vars

The number of real-time classical variables in the circuit that are declared by this circuit scope, excluding inputs or captures.

This is the length of the `iter_declared_vars()` iterable.

### num\_input\_vars

The number of real-time classical variables in the circuit marked as circuit inputs.

This is the length of the `iter_input_vars()` iterable. If this is non-zero, [`num_captured_vars`](#qiskit.circuit.library.PiecewisePolynomialPauliRotations.num_captured_vars "qiskit.circuit.library.PiecewisePolynomialPauliRotations.num_captured_vars") must be zero.

### 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.

### num\_vars

The number of real-time classical variables in the circuit.

This is the length of the `iter_vars()` iterable.

### 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 `QuantumRegister`s in this circuit. You should not mutate this.

### qubits

A list of `Qubit`s in the order that they were added. You should not mutate this.

### name

Type: `str`

A human-readable name for the circuit.

### cregs

Type: `list[ClassicalRegister]`

A list of the `ClassicalRegister`s in this circuit. You should not mutate this.

### duration

Type: `int | float | None`

The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PiecewisePolynomialPauliRotations.unit "qiskit.circuit.library.PiecewisePolynomialPauliRotations.unit").

### unit

The unit that [`duration`](#qiskit.circuit.library.PiecewisePolynomialPauliRotations.duration "qiskit.circuit.library.PiecewisePolynomialPauliRotations.duration") is specified in.

## Methods

### evaluate

`evaluate(x)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py#L210-L224)

Classically evaluate the piecewise polynomial rotation.

**Parameters**

**x** ([*float*](https://docs.python.org/3/library/functions.html#float)) – Value to be evaluated at.

**Returns**

Value of piecewise polynomial function at x.

**Return type**

[float](https://docs.python.org/3/library/functions.html#float)