cirq.StepResultBase

A base class for step results.

Inherits From: StepResult

cirq.StepResultBase(
    sim_state: SimulationStateBase[TSimulationState]
)

sim_state The SimulationStateBase for this step.

measurements

Methods

sample

View source

sample(
    qubits: list[cirq.Qid],
    repetitions: int = 1,
    seed: cirq.RANDOM_STATE_OR_SEED_LIKE = None
) -> np.ndarray

Samples from the system at this point in the computation.

Note that this does not collapse the state vector.

Args
qubits The qubits to be sampled in an order that influence the returned measurement results.
repetitions The number of samples to take.
seed A seed for the pseudorandom number generator.

Returns
Measurement results with True corresponding to the |1⟩ state. The outer list is for repetitions, and the inner corresponds to measurements ordered by the supplied qubits. These lists are wrapped as a numpy ndarray.

sample_measurement_ops

View source

sample_measurement_ops(
    measurement_ops: list[cirq.GateOperation],
    repetitions: int = 1,
    seed: cirq.RANDOM_STATE_OR_SEED_LIKE = None,
    *,
    _allow_repeated=False
) -> dict[str, np.ndarray]

Samples from the system at this point in the computation.

Note that this does not collapse the state vector.

In contrast to sample which samples qubits, this takes a list of cirq.GateOperation instances whose gates are cirq.MeasurementGate instances and then returns a mapping from the key in the measurement gate to the resulting bit strings. Different measurement operations must not act on the same qubits.

Args
measurement_ops GateOperation instances whose gates are MeasurementGate instances to be sampled form.
repetitions The number of samples to take.
seed A seed for the pseudorandom number generator.
_allow_repeated If True, adds extra dimension to the result, corresponding to the number of times a key is repeated.

Returns: A dictionary from measurement gate key to measurement results. Measurement results are stored in a 2-dimensional numpy array, the first dimension corresponding to the repetition and the second to the actual boolean measurement results (ordered by the qubits being measured.)

Raises
ValueError If the operation's gates are not MeasurementGate instances or a qubit is acted upon multiple times by different operations from measurement_ops.