142 lines
4.2 KiB
Plaintext
142 lines
4.2 KiB
Plaintext
---
|
||
title: Z2Symmetries
|
||
description: API reference for qiskit.opflow.primitive_ops.Z2Symmetries
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries
|
||
---
|
||
|
||
# Z2Symmetries
|
||
|
||
<Class id="qiskit.opflow.primitive_ops.Z2Symmetries" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py" signature="Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)" modifiers="class">
|
||
Bases: `object`
|
||
|
||
Z2 Symmetries
|
||
|
||
**Parameters**
|
||
|
||
* **symmetries** (`List`\[`Pauli`]) – the list of Pauli objects representing the Z\_2 symmetries
|
||
* **sq\_paulis** (`List`\[`Pauli`]) – the list of single - qubit Pauli objects to construct the Clifford operators
|
||
* **sq\_list** (`List`\[`int`]) – the list of support of the single-qubit Pauli objects used to build the Clifford operators
|
||
* **tapering\_values** (`Optional`\[`List`\[`int`]]) – values determines the sector.
|
||
|
||
**Raises**
|
||
|
||
[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – Invalid paulis
|
||
|
||
## Methods Defined Here
|
||
|
||
### consistent\_tapering
|
||
|
||
<Function id="qiskit.opflow.primitive_ops.Z2Symmetries.consistent_tapering" signature="Z2Symmetries.consistent_tapering(operator)">
|
||
Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values.
|
||
|
||
**Parameters**
|
||
|
||
**operator** (`PauliSumOp`) – the to-be-tapered operator
|
||
|
||
**Return type**
|
||
|
||
`OperatorBase`
|
||
|
||
**Returns**
|
||
|
||
The tapered operator
|
||
|
||
**Raises**
|
||
|
||
[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – The given operator does not commute with the symmetry
|
||
</Function>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.opflow.primitive_ops.Z2Symmetries.copy" signature="Z2Symmetries.copy()">
|
||
Get a copy of self. :rtype: `Z2Symmetries` :returns: copy
|
||
</Function>
|
||
|
||
### find\_Z2\_symmetries
|
||
|
||
<Function id="qiskit.opflow.primitive_ops.Z2Symmetries.find_Z2_symmetries" signature="Z2Symmetries.find_Z2_symmetries(operator)" modifiers="classmethod">
|
||
Finds Z2 Pauli-type symmetries of an Operator.
|
||
|
||
**Return type**
|
||
|
||
`Z2Symmetries`
|
||
|
||
**Returns**
|
||
|
||
a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list.
|
||
</Function>
|
||
|
||
### is\_empty
|
||
|
||
<Function id="qiskit.opflow.primitive_ops.Z2Symmetries.is_empty" signature="Z2Symmetries.is_empty()">
|
||
Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not
|
||
</Function>
|
||
|
||
### taper
|
||
|
||
<Function id="qiskit.opflow.primitive_ops.Z2Symmetries.taper" signature="Z2Symmetries.taper(operator)">
|
||
Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record.
|
||
|
||
**Parameters**
|
||
|
||
**operator** (`PauliSumOp`) – the to-be-tapered operator.
|
||
|
||
**Returns**
|
||
|
||
\[:class\`PauliSumOp\`]; otherwise, [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")
|
||
|
||
**Return type**
|
||
|
||
If tapering\_values is None
|
||
|
||
**Raises**
|
||
|
||
[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – Z2 symmetries, single qubit pauli and single qubit list cannot be empty
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### cliffords
|
||
|
||
<Attribute id="qiskit.opflow.primitive_ops.Z2Symmetries.cliffords">
|
||
Get clifford operators, build based on symmetries and single-qubit X. :rtype: `List`\[`PauliSumOp`] :returns: a list of unitaries used to diagonalize the Hamiltonian.
|
||
</Attribute>
|
||
|
||
### settings
|
||
|
||
<Attribute id="qiskit.opflow.primitive_ops.Z2Symmetries.settings">
|
||
Return operator settings.
|
||
|
||
**Return type**
|
||
|
||
`Dict`
|
||
</Attribute>
|
||
|
||
### sq\_list
|
||
|
||
<Attribute id="qiskit.opflow.primitive_ops.Z2Symmetries.sq_list">
|
||
returns sq list
|
||
</Attribute>
|
||
|
||
### sq\_paulis
|
||
|
||
<Attribute id="qiskit.opflow.primitive_ops.Z2Symmetries.sq_paulis">
|
||
returns sq paulis
|
||
</Attribute>
|
||
|
||
### symmetries
|
||
|
||
<Attribute id="qiskit.opflow.primitive_ops.Z2Symmetries.symmetries">
|
||
return symmetries
|
||
</Attribute>
|
||
|
||
### tapering\_values
|
||
|
||
<Attribute id="qiskit.opflow.primitive_ops.Z2Symmetries.tapering_values">
|
||
returns tapering values
|
||
</Attribute>
|
||
</Class>
|
||
|