Skip to content

Commit

Permalink
prevent running with scisors
Browse files Browse the repository at this point in the history
  • Loading branch information
@m-mcewen
m-mcewen committed Dec 8, 2023
1 parent 4044b76 commit 2feae5a
Show file tree
Hide file tree
Showing 5 changed files with 116 additions and 18 deletions.
18 changes: 14 additions & 4 deletions doc/python_api_reference_vDev.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6165,15 +6165,25 @@ def broadcast_pauli_errors(
pauli: Union[str, int],
mask: np.ndarray,
) -> None:
"""Applies a pauli over all qubits in all simulation indices, filtered by mask.
"""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 np.bool_ array with shape (qubit, simulation_instance)
The pauli error is only applied to qubits q and simulation indices k
where mask[q, k] == True
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
Expand Down
18 changes: 14 additions & 4 deletions doc/stim.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4676,15 +4676,25 @@ class FlipSimulator:
pauli: Union[str, int],
mask: np.ndarray,
) -> None:
"""Applies a pauli over all qubits in all simulation indices, filtered by mask.
"""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 np.bool_ array with shape (qubit, simulation_instance)
The pauli error is only applied to qubits q and simulation indices k
where mask[q, k] == True
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
Expand Down
18 changes: 14 additions & 4 deletions glue/python/src/stim/__init__.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4676,15 +4676,25 @@ class FlipSimulator:
pauli: Union[str, int],
mask: np.ndarray,
) -> None:
"""Applies a pauli over all qubits in all simulation indices, filtered by mask.
"""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 np.bool_ array with shape (qubit, simulation_instance)
The pauli error is only applied to qubits q and simulation indices k
where mask[q, k] == True
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
Expand Down
26 changes: 22 additions & 4 deletions src/stim/simulators/frame_simulator.pybind.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -820,6 +820,14 @@ void stim_pybind::pybind_frame_simulator_methods(

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});

auto u = arr.unchecked<2>();
for (size_t i = 0; i < major; i++){
for (size_t j = 0; j < minor; j++){
Expand All @@ -834,15 +842,25 @@ void stim_pybind::pybind_frame_simulator_methods(
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 over all qubits in all simulation indices, filtered by mask.
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 np.bool_ array with shape (qubit, simulation_instance)
The pauli error is only applied to qubits q and simulation indices k
where mask[q, k] == True
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
Expand Down
54 changes: 52 additions & 2 deletions src/stim/simulators/frame_simulator_pybind_test.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ def test_broadcast_pauli_errors():
stim.PauliString("+ZYZ")
]

with pytest.raises(Exception):
with pytest.raises(ValueError, match='pauli'):
sim.broadcast_pauli_errors(
pauli='whoops',
mask=np.asarray([
Expand All @@ -343,7 +343,7 @@ def test_broadcast_pauli_errors():
[True, True]]
),
)
with pytest.raises(Exception):
with pytest.raises(ValueError, match='pauli'):
sim.broadcast_pauli_errors(
pauli=4,
mask=np.asarray([
Expand All @@ -352,6 +352,56 @@ def test_broadcast_pauli_errors():
[True, True]]
),
)
with pytest.raises(ValueError, match='batch_size'):
sim.broadcast_pauli_errors(
pauli='X',
mask=np.asarray([
[True, True,True],
[False, True, True],
[True, True, True]]
),
)
with pytest.raises(ValueError, match='batch_size'):
sim.broadcast_pauli_errors(
pauli='X',
mask=np.asarray([
[True],
[False],
[True]]
),
)
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],
[True, True]]
),
) # automatically expands the qubit basis
peek = sim.peek_pauli_flips()
assert peek == [
stim.PauliString("+X_XX"),
stim.PauliString("+__XX")
]
sim.broadcast_pauli_errors(
pauli='X',
mask=np.asarray([
[True, False],
[False, False],
]
),
) # tolerates fewer qubits in mask than in simulator
peek = sim.peek_pauli_flips()
assert peek == [
stim.PauliString("+__XX"),
stim.PauliString("+__XX")
]


def test_repro_heralded_pauli_channel_1_bug():
Expand Down

0 comments on commit 2feae5a

Please sign in to comment.