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.FlipSimulator.broadcast_pauli_errors #678

Merged
merged 7 commits into from
Dec 11, 2023
Merged

Add stim.FlipSimulator.broadcast_pauli_errors #678

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f556295
add apply_pauli_errors
m-mcewen Dec 7, 2023
62c0c1a
bittwidling, also doctests
m-mcewen Dec 7, 2023
73c3d79
fix pybind tests
m-mcewen Dec 7, 2023
4044b76
craig review
m-mcewen Dec 8, 2023
2feae5a
prevent running with scisors
m-mcewen Dec 8, 2023
582ade0
...regen_docs
m-mcewen Dec 8, 2023
03c4306
Finish up
Strilanc Dec 10, 2023
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
56 changes: 56 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 @@ -173,6 +173,7 @@ API references for stable versions are kept on the [stim github wiki](https://gi
- [`stim.FlipSimulator`](#stim.FlipSimulator)
- [`stim.FlipSimulator.__init__`](#stim.FlipSimulator.__init__)
- [`stim.FlipSimulator.batch_size`](#stim.FlipSimulator.batch_size)
- [`stim.FlipSimulator.broadcast_pauli_errors`](#stim.FlipSimulator.broadcast_pauli_errors)
- [`stim.FlipSimulator.do`](#stim.FlipSimulator.do)
- [`stim.FlipSimulator.get_detector_flips`](#stim.FlipSimulator.get_detector_flips)
- [`stim.FlipSimulator.get_measurement_flips`](#stim.FlipSimulator.get_measurement_flips)
Expand Down Expand Up @@ -6153,6 +6154,61 @@ def batch_size(
"""
```

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

# (in class stim.FlipSimulator)
def broadcast_pauli_errors(
self,
*,
pauli: Union[str, int],
mask: np.ndarray,
) -> None:
"""Applies a pauli error to all qubits in all instances, filtered by a mask.

Args:
pauli: The pauli, specified as an integer or string.
Uses the convention 0=I, 1=X, 2=Y, 3=Z.
Any value from [0, 1, 2, 3, 'X', 'Y', 'Z', 'I', '_'] is allowed.
mask: A 2d numpy array specifying where to apply errors. The first axis
is qubits, the second axis is simulation instances. The first axis
can have a length less than the current number of qubits (or more,
which adds qubits to the simulation). The length of the second axis
must match the simulator's `batch_size`. The array must satisfy

mask.dtype == np.bool_
len(mask.shape) == 2
mask.shape[1] == flip_sim.batch_size

The error is only applied to qubit q in instance k when

mask[q, k] == True.

Examples:
>>> import stim
>>> import numpy as np
>>> sim = stim.FlipSimulator(
... batch_size=2,
... num_qubits=3,
... disable_stabilizer_randomization=True,
... )
>>> sim.broadcast_pauli_errors(
... pauli='X',
... mask=np.asarray([[True, False],[False, False],[True, True]]),
... )
>>> sim.peek_pauli_flips()
[stim.PauliString("+X_X"), stim.PauliString("+__X")]

>>> sim.broadcast_pauli_errors(
... pauli='Z',
... mask=np.asarray([[False, True],[False, False],[True, True]]),
... )
>>> sim.peek_pauli_flips()
[stim.PauliString("+X_Y"), stim.PauliString("+Z_Y")]
"""
```

<a name="stim.FlipSimulator.do"></a>
```python
# stim.FlipSimulator.do
Expand Down
48 changes: 48 additions & 0 deletions doc/stim.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4670,6 +4670,54 @@ class FlipSimulator:
>>> sim.batch_size
42
"""
def broadcast_pauli_errors(
self,
*,
pauli: Union[str, int],
mask: np.ndarray,
) -> None:
"""Applies a pauli error to all qubits in all instances, filtered by a mask.

Args:
pauli: The pauli, specified as an integer or string.
Uses the convention 0=I, 1=X, 2=Y, 3=Z.
Any value from [0, 1, 2, 3, 'X', 'Y', 'Z', 'I', '_'] is allowed.
mask: A 2d numpy array specifying where to apply errors. The first axis
is qubits, the second axis is simulation instances. The first axis
can have a length less than the current number of qubits (or more,
which adds qubits to the simulation). The length of the second axis
must match the simulator's `batch_size`. The array must satisfy

mask.dtype == np.bool_
len(mask.shape) == 2
mask.shape[1] == flip_sim.batch_size

The error is only applied to qubit q in instance k when

mask[q, k] == True.

Examples:
>>> import stim
>>> import numpy as np
>>> sim = stim.FlipSimulator(
... batch_size=2,
... num_qubits=3,
... disable_stabilizer_randomization=True,
... )
>>> sim.broadcast_pauli_errors(
... pauli='X',
... mask=np.asarray([[True, False],[False, False],[True, True]]),
... )
>>> sim.peek_pauli_flips()
[stim.PauliString("+X_X"), stim.PauliString("+__X")]

>>> sim.broadcast_pauli_errors(
... pauli='Z',
... mask=np.asarray([[False, True],[False, False],[True, True]]),
... )
>>> sim.peek_pauli_flips()
[stim.PauliString("+X_Y"), stim.PauliString("+Z_Y")]
"""
def do(
self,
obj: Union[stim.Circuit, stim.CircuitInstruction, stim.CircuitRepeatBlock],
Expand Down
48 changes: 48 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 @@ -4670,6 +4670,54 @@ class FlipSimulator:
>>> sim.batch_size
42
"""
def broadcast_pauli_errors(
self,
*,
pauli: Union[str, int],
mask: np.ndarray,
) -> None:
"""Applies a pauli error to all qubits in all instances, filtered by a mask.

Args:
pauli: The pauli, specified as an integer or string.
Uses the convention 0=I, 1=X, 2=Y, 3=Z.
Any value from [0, 1, 2, 3, 'X', 'Y', 'Z', 'I', '_'] is allowed.
mask: A 2d numpy array specifying where to apply errors. The first axis
is qubits, the second axis is simulation instances. The first axis
can have a length less than the current number of qubits (or more,
which adds qubits to the simulation). The length of the second axis
must match the simulator's `batch_size`. The array must satisfy

mask.dtype == np.bool_
len(mask.shape) == 2
mask.shape[1] == flip_sim.batch_size

The error is only applied to qubit q in instance k when

mask[q, k] == True.

Examples:
>>> import stim
>>> import numpy as np
>>> sim = stim.FlipSimulator(
... batch_size=2,
... num_qubits=3,
... disable_stabilizer_randomization=True,
... )
>>> sim.broadcast_pauli_errors(
... pauli='X',
... mask=np.asarray([[True, False],[False, False],[True, True]]),
... )
>>> sim.peek_pauli_flips()
[stim.PauliString("+X_X"), stim.PauliString("+__X")]

>>> sim.broadcast_pauli_errors(
... pauli='Z',
... mask=np.asarray([[False, True],[False, False],[True, True]]),
... )
>>> sim.peek_pauli_flips()
[stim.PauliString("+X_Y"), stim.PauliString("+Z_Y")]
"""
def do(
self,
obj: Union[stim.Circuit, stim.CircuitInstruction, stim.CircuitRepeatBlock],
Expand Down
116 changes: 116 additions & 0 deletions src/stim/simulators/frame_simulator.pybind.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -770,4 +770,120 @@ void stim_pybind::pybind_frame_simulator_methods(
[stim.PauliString("+YX__")]
)DOC")
.data());

c.def(
"broadcast_pauli_errors",
[](FrameSimulator<MAX_BITWORD_WIDTH> &self,
const pybind11::object &pauli,
const pybind11::object &mask
) {
uint8_t p = 255;
try {
p = pybind11::cast<uint8_t>(pauli);
if (p >= 4) {
throw pybind11::cast_error();
}
} catch (const pybind11::cast_error &) {
try {
std::string s = pybind11::cast<std::string>(pauli);
if (s == "X") {
p = 1;
} else if (s == "Y") {
p = 2;
} else if (s == "Z") {
p = 3;
} else if (s == "I" || s == "_") {
p = 0;
} else {
throw pybind11::cast_error();
}
} catch (const pybind11::cast_error &) {
throw std::invalid_argument(
"broadcast_pauli_errors only accepts pauli arguments in ['I', '_', 'X', 'Y', 'Z', 0,1,2,3]");
}
}

bool flip_z_part = p & 2;
bool flip_x_part = (0b0110 >> p) & 1; // parity of 2 bit number


if (!pybind11::isinstance<pybind11::array_t<bool>>(mask)) {
throw std::invalid_argument(
"broadcast_pauli_errors can only accept mask that is a 2D array of np.bool_");
}
const pybind11::array_t<bool> &arr = pybind11::cast<pybind11::array_t<bool>>(mask);

if (arr.ndim() != 2) {
throw std::invalid_argument(
"broadcast_pauli_errors can only accept mask that is a 2D array of np.bool_");
}

size_t major = arr.shape(0);
size_t minor = arr.shape(1);

if (minor != self.batch_size) {
throw std::invalid_argument(
"broadcast_pauli_errors can only accept mask that has minor shape equal to the batch_size");
}

self.ensure_safe_to_do_circuit_with_stats(CircuitStats{.num_qubits=(uint32_t)major});
Strilanc marked this conversation as resolved.
Show resolved Hide resolved

auto u = arr.unchecked<2>();
This conversation was marked as resolved.
Show resolved Hide resolved
for (size_t i = 0; i < major; i++){
for (size_t j = 0; j < minor; j++){
auto b = u.data(i, j);
self.x_table[i][j] ^= *b & flip_x_part;
self.z_table[i][j] ^= *b & flip_z_part;
}
}
},
pybind11::kw_only(),
pybind11::arg("pauli"),
pybind11::arg("mask"),
clean_doc_string(R"DOC(
@signature def broadcast_pauli_errors(self, *, pauli: Union[str, int], mask: np.ndarray) -> None:
Applies a pauli error to all qubits in all instances, filtered by a mask.

Args:
pauli: The pauli, specified as an integer or string.
Uses the convention 0=I, 1=X, 2=Y, 3=Z.
Any value from [0, 1, 2, 3, 'X', 'Y', 'Z', 'I', '_'] is allowed.
mask: A 2d numpy array specifying where to apply errors. The first axis
is qubits, the second axis is simulation instances. The first axis
can have a length less than the current number of qubits (or more,
which adds qubits to the simulation). The length of the second axis
must match the simulator's `batch_size`. The array must satisfy

mask.dtype == np.bool_
len(mask.shape) == 2
mask.shape[1] == flip_sim.batch_size

The error is only applied to qubit q in instance k when

mask[q, k] == True.

Examples:
>>> import stim
>>> import numpy as np
>>> sim = stim.FlipSimulator(
... batch_size=2,
... num_qubits=3,
... disable_stabilizer_randomization=True,
... )
>>> sim.broadcast_pauli_errors(
... pauli='X',
... mask=np.asarray([[True, False],[False, False],[True, True]]),
... )
>>> sim.peek_pauli_flips()
[stim.PauliString("+X_X"), stim.PauliString("+__X")]

>>> sim.broadcast_pauli_errors(
... pauli='Z',
... mask=np.asarray([[False, True],[False, False],[True, True]]),
... )
>>> sim.peek_pauli_flips()
[stim.PauliString("+X_Y"), stim.PauliString("+Z_Y")]

)DOC")
.data());
}
Loading
Loading