Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add stim.target_pauli and stim.target_combined_paulis #696

Merged
merged 1 commit into from
Feb 17, 2024
Merged

Add stim.target_pauli and stim.target_combined_paulis #696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions doc/python_api_reference_vDev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,9 +385,11 @@ API references for stable versions are kept on the [stim github wiki](https://gi
- [`stim.gate_data`](#stim.gate_data)
- [`stim.main`](#stim.main)
- [`stim.read_shot_data_file`](#stim.read_shot_data_file)
- [`stim.target_combined_paulis`](#stim.target_combined_paulis)
- [`stim.target_combiner`](#stim.target_combiner)
- [`stim.target_inv`](#stim.target_inv)
- [`stim.target_logical_observable_id`](#stim.target_logical_observable_id)
- [`stim.target_pauli`](#stim.target_pauli)
- [`stim.target_rec`](#stim.target_rec)
- [`stim.target_relative_detector_id`](#stim.target_relative_detector_id)
- [`stim.target_separator`](#stim.target_separator)
Expand Down Expand Up @@ -13446,6 +13448,40 @@ def read_shot_data_file(
"""
```

<a name="stim.target_combined_paulis"></a>
```python
# stim.target_combined_paulis

# (at top-level in the stim module)
def target_combined_paulis(
paulis: Union[stim.PauliString, List[stim.GateTarget]],
invert: bool = False,
) -> stim.GateTarget:
"""Returns a list of targets encoding a pauli product for instructions like MPP.

Args:
paulis: The paulis to encode into the targets. This can be a
`stim.PauliString` or a list of pauli targets from `stim.target_x`,
`stim.target_pauli`, etc.
invert: Defaults to False. If True, the product is inverted (like "!X2*Y3").
Note that this is in addition to any inversions specified by the
`paulis` argument.

Examples:
>>> import stim
>>> circuit = stim.Circuit()
>>> circuit.append("MPP", [
... *stim.target_combined_paulis(stim.PauliString("-XYZ")),
... *stim.target_combined_paulis([stim.target_x(2), stim.target_y(5)]),
... *stim.target_combined_paulis([stim.target_z(9)], invert=True),
... ])
>>> circuit
stim.Circuit('''
MPP !X0*Y1*Z2 X2*Y5 !Z9
''')
"""
```

<a name="stim.target_combiner"></a>
```python
# stim.target_combiner
Expand Down Expand Up @@ -13530,6 +13566,52 @@ def target_logical_observable_id(
"""
```

<a name="stim.target_pauli"></a>
```python
# stim.target_pauli

# (at top-level in the stim module)
def target_pauli(
qubit_index: int,
pauli: Union[str, int],
invert: bool = False,
) -> stim.GateTarget:
"""Returns a pauli target that can be passed into `stim.Circuit.append`.

Args:
qubit_index: The qubit that the Pauli applies to.
pauli: The pauli gate to use. This can either be a string identifying the
pauli by name ("x", "X", "y", "Y", "z", or "Z") or an integer following
the convention (1=X, 2=Y, 3=Z). Setting this argument to "I" or to
0 will return a qubit target instead of a pauli target.
invert: Defaults to False. If True, the target is inverted (like "!X10"),
indicating that, for example, measurement results should be inverted).

Examples:
>>> import stim
>>> circuit = stim.Circuit()
>>> circuit.append("MPP", [
... stim.target_pauli(2, "X"),
... stim.target_combiner(),
... stim.target_pauli(3, "y", invert=True),
... stim.target_pauli(5, 3),
... ])
>>> circuit
stim.Circuit('''
MPP X2*!Y3 Z5
''')

>>> circuit.append("M", [
... stim.target_pauli(7, "I"),
... ])
>>> circuit
stim.Circuit('''
MPP X2*!Y3 Z5
M 7
''')
"""
```

<a name="stim.target_rec"></a>
```python
# stim.target_rec
Expand Down
66 changes: 66 additions & 0 deletions doc/stim.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10525,6 +10525,33 @@ def read_shot_data_file(
array([[False, False, False, False],
[False, True, False, True]])
"""
def target_combined_paulis(
paulis: Union[stim.PauliString, List[stim.GateTarget]],
invert: bool = False,
) -> stim.GateTarget:
"""Returns a list of targets encoding a pauli product for instructions like MPP.

Args:
paulis: The paulis to encode into the targets. This can be a
`stim.PauliString` or a list of pauli targets from `stim.target_x`,
`stim.target_pauli`, etc.
invert: Defaults to False. If True, the product is inverted (like "!X2*Y3").
Note that this is in addition to any inversions specified by the
`paulis` argument.

Examples:
>>> import stim
>>> circuit = stim.Circuit()
>>> circuit.append("MPP", [
... *stim.target_combined_paulis(stim.PauliString("-XYZ")),
... *stim.target_combined_paulis([stim.target_x(2), stim.target_y(5)]),
... *stim.target_combined_paulis([stim.target_z(9)], invert=True),
... ])
>>> circuit
stim.Circuit('''
MPP !X0*Y1*Z2 X2*Y5 !Z9
''')
"""
def target_combiner(
) -> stim.GateTarget:
"""Returns a target combiner that can be used to build Pauli products.
Expand Down Expand Up @@ -10588,6 +10615,45 @@ def target_logical_observable_id(
error(0.25) L13
''')
"""
def target_pauli(
qubit_index: int,
pauli: Union[str, int],
invert: bool = False,
) -> stim.GateTarget:
"""Returns a pauli target that can be passed into `stim.Circuit.append`.

Args:
qubit_index: The qubit that the Pauli applies to.
pauli: The pauli gate to use. This can either be a string identifying the
pauli by name ("x", "X", "y", "Y", "z", or "Z") or an integer following
the convention (1=X, 2=Y, 3=Z). Setting this argument to "I" or to
0 will return a qubit target instead of a pauli target.
invert: Defaults to False. If True, the target is inverted (like "!X10"),
indicating that, for example, measurement results should be inverted).

Examples:
>>> import stim
>>> circuit = stim.Circuit()
>>> circuit.append("MPP", [
... stim.target_pauli(2, "X"),
... stim.target_combiner(),
... stim.target_pauli(3, "y", invert=True),
... stim.target_pauli(5, 3),
... ])
>>> circuit
stim.Circuit('''
MPP X2*!Y3 Z5
''')

>>> circuit.append("M", [
... stim.target_pauli(7, "I"),
... ])
>>> circuit
stim.Circuit('''
MPP X2*!Y3 Z5
M 7
''')
"""
def target_rec(
lookback_index: int,
) -> stim.GateTarget:
Expand Down
66 changes: 66 additions & 0 deletions glue/python/src/stim/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10525,6 +10525,33 @@ def read_shot_data_file(
array([[False, False, False, False],
[False, True, False, True]])
"""
def target_combined_paulis(
paulis: Union[stim.PauliString, List[stim.GateTarget]],
invert: bool = False,
) -> stim.GateTarget:
"""Returns a list of targets encoding a pauli product for instructions like MPP.

Args:
paulis: The paulis to encode into the targets. This can be a
`stim.PauliString` or a list of pauli targets from `stim.target_x`,
`stim.target_pauli`, etc.
invert: Defaults to False. If True, the product is inverted (like "!X2*Y3").
Note that this is in addition to any inversions specified by the
`paulis` argument.

Examples:
>>> import stim
>>> circuit = stim.Circuit()
>>> circuit.append("MPP", [
... *stim.target_combined_paulis(stim.PauliString("-XYZ")),
... *stim.target_combined_paulis([stim.target_x(2), stim.target_y(5)]),
... *stim.target_combined_paulis([stim.target_z(9)], invert=True),
... ])
>>> circuit
stim.Circuit('''
MPP !X0*Y1*Z2 X2*Y5 !Z9
''')
"""
def target_combiner(
) -> stim.GateTarget:
"""Returns a target combiner that can be used to build Pauli products.
Expand Down Expand Up @@ -10588,6 +10615,45 @@ def target_logical_observable_id(
error(0.25) L13
''')
"""
def target_pauli(
qubit_index: int,
pauli: Union[str, int],
invert: bool = False,
) -> stim.GateTarget:
"""Returns a pauli target that can be passed into `stim.Circuit.append`.

Args:
qubit_index: The qubit that the Pauli applies to.
pauli: The pauli gate to use. This can either be a string identifying the
pauli by name ("x", "X", "y", "Y", "z", or "Z") or an integer following
the convention (1=X, 2=Y, 3=Z). Setting this argument to "I" or to
0 will return a qubit target instead of a pauli target.
invert: Defaults to False. If True, the target is inverted (like "!X10"),
indicating that, for example, measurement results should be inverted).

Examples:
>>> import stim
>>> circuit = stim.Circuit()
>>> circuit.append("MPP", [
... stim.target_pauli(2, "X"),
... stim.target_combiner(),
... stim.target_pauli(3, "y", invert=True),
... stim.target_pauli(5, 3),
... ])
>>> circuit
stim.Circuit('''
MPP X2*!Y3 Z5
''')

>>> circuit.append("M", [
... stim.target_pauli(7, "I"),
... ])
>>> circuit
stim.Circuit('''
MPP X2*!Y3 Z5
M 7
''')
"""
def target_rec(
lookback_index: int,
) -> stim.GateTarget:
Expand Down
Loading
Loading