---
title: XOR (latest version)
description: API reference for qiskit.circuit.library.XOR in the latest version of qiskit
source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit/qiskit.circuit.library.XOR
---

# XOR

*class* `qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/2.5/qiskit/circuit/library/boolean_logic/quantum_xor.py#L23-L78)

Bases: [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")

An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`.

The `amount` is xor-ed in bitstring form with the input.

This circuit can also represent addition by `amount` over the finite field GF(2).

> **Deprecated since version 2.1**
>
> The class `qiskit.circuit.library.boolean_logic.quantum_xor.XOR` is deprecated as of Qiskit 2.1. It will be removed in Qiskit 3.0. Instead, for xor-ing with a specified amount, use BitwiseXorGate,and for xor-ing with a random amount, use random\_bitwise\_xor.

**Parameters**

- **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – the width of circuit.
- **amount** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – the xor amount in decimal form.
- **seed** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – random seed in case a random xor is requested.

**Raises**

[**CircuitError**](/docs/api/qiskit/circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if the xor bitstring exceeds available qubits.

Reference Circuit:

![Diagram illustrating the previously described circuit.](https://eu-de.quantum.cloud.ibm.com/docs/images/api/qiskit/qiskit-circuit-library-XOR-1.avif)

## Attributes

### name

Type: `str`

A human-readable name for the circuit.

**Example**

```python
from qiskit import QuantumCircuit

qc = QuantumCircuit(2, 2, name="my_circuit")
print(qc.name)
```

```text
my_circuit
```