save_amplitudes_squared#

save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)[source]#

Save squared statevector amplitudes (probabilities).

Parameters:

  • params (List[int] or List[str]) – the basis states to return amplitudes for.

  • label (str) – the key for retrieving saved data from results.

  • unnormalized (bool) – If True return save the unnormalized accumulated probabilities over all shots [Default: False].

  • pershot (bool) – if True save a list of probability vectors for each shot of the simulation rather than the a single amplitude vector [Default: False].

  • conditional (bool) – if True save the probability vector conditional on the current classical register values [Default: False].

Returns:

with attached instruction.

Return type:

QuantumCircuit

Raises:

ValueError – if params is invalid for the specified number of qubits.