SamplerPubResult
class qiskit.primitives.SamplerPubResult(data, metadata=None)
Bases: PubResult
Result of Sampler Pub.
Initialize a pub result.
Parameters
- data (DataBin) – Result data.
- metadata (dict(opens in a new tab)[str(opens in a new tab), Any] | None) – Metadata specific to this pub. Keys are expected to be strings.
Attributes
data
Result data for the pub.
metadata
Metadata for the pub.
Methods
join_data
join_data(names=None)
Join data from many registers into one data container.
Data is joined along the bits axis. For example, for BitArray data, this corresponds to bitstring concatenation.
Parameters
names (Iterable[str(opens in a new tab)] | None) – Which registers to join. Their order is maintained, for example, given ["alpha", "beta"], the data from register alpha is placed to the left of the data from register beta. When None is given, this value is set to the ordered list of register names, which will have been preserved from the input circuit order.
Returns
Joint data.
Raises
- ValueError(opens in a new tab) – If specified names are empty.
- ValueError(opens in a new tab) – If specified name does not exist.
- TypeError(opens in a new tab) – If specified data comes from incompatible types.
Return type
BitArray | np.ndarray