実験結果
qiskit.result
コア・クラス
Result(*[, backend_name, backend_version,...] ) | 結果を出すためのモデル。 |
ResultError(エラー) | 結果出力のエラーにより発生した例外。 |
Counts(data[, time_taken, creg_sizes,...] ) | 回路実行のカウント結果を格納するクラス。 |
周縁化
marginal_counts
qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)
実験から得られたカウントを、関心のあるいくつかの指標にわたって周辺化する。
パラメーター
- result (dict |Result) – 疎外される結果(Resultオブジェクトまたはカウントのdict(str, int))。
- indices (list[int] | None) – 限界化の対象となるビットの位置。 (
Noneデフォルトの場合)、一切のマージナル化を行わない。 - inplace (bool) – デフォルト:False。 Trueの場合、元のResult引数を操作し、元のJob Resultを失う。
resultがdictの場合は効果がない。 - format_marginal (bool) – デフォルト:False。 Trueの場合、marginalizeの出力を取り、クレグ間と非インデックスのプレースホルダーでフォーマットする。
- marginalize_memory (bool | None) – もしTrueなら、メモリーフィールドもマージナル化する(存在する場合)。 False の場合、結果からメモリ・フィールドを削除する。 Noneの場合、メモリフィールドはそのままにしておく。
戻り値
結果オブジェクトまたは
観測されたカウントを、関心のあるビットの観測頻度のみを考慮するようにマージナル化したもの。
戻りの型
レイズ
QiskitError - 無効なインデックスをマージナル化する場合。
marginal_distribution
qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)
実験から得られたカウントを、関心のあるいくつかの指標にわたって周辺化する。
とは異なり marginal_counts() この関数は、入力 indices の順序を尊重する。 入力 indices リストが指定された場合、ビットインデックスが指定された順序が、マージナル化された出力におけるビット列の出力順序となる。
パラメーター
- counts (dict) – 疎外される結果
- indices (Sequence[int] | None) – 限界化の対象となるビットの位置。 (
Noneデフォルトの場合)、一切のマージナル化を行わない。 - format_marginal (bool) – デフォルト:False。 Trueの場合、marginalizeの出力を取り、クレグ間と非インデックスのプレースホルダーでフォーマットする。
戻り値
限界辞書
戻りの型
レイズ
- QiskitError -
indicesのいずれかの値が無効であるか、countsdict - は無効である。 -
marginal_memory
qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)
ショットメモリーの限界
この関数はマルチスレッドであり、デフォルトではCPU数と同じスレッド数のスレッドプールを起動する。 スレッド数は RAYON_NUM_THREADS 環境変数で調整できる。 例えば、 RAYON_NUM_THREADS=4 を設定すると、スレッドプールは4スレッドに制限される。
パラメーター
- memory (list[str] | ndarray) – 入力メモリリストは、レベル2の測定メモリを表す16進数文字列のリスト、あるいはレベル0の測定メモリ(単一値または平均値)またはレベル1の測定メモリ(単一値または平均値)を表すNumPy配列のいずれかです。
- indices (list[int] | None) – 限界化の対象となるビットの位置。 (
Noneデフォルトの場合)、一切のマージナル化を行わない。 - int_return (bool) –
Trueに設定すると、整数のリストが出力される。 デフォルトでは、戻り値の型はビット列である。 これとhex_returnは互いに排他的であり、同時に指定することはできない。 このオプションはメモリレベル2でのみ有効である。 - hex_return (bool) –
Trueに設定すると、16進数文字列のリストが出力される。 デフォルトでは、戻り値の型はビット列である。 これとint_returnは互いに排他的であり、同時に指定することはできない。 このオプションはメモリレベル2でのみ有効である。 - avg_data (bool) – 2次元のnumpy配列が
memoryに渡された場合、これをTrueに設定することで、レベル1の単一データではなく、レベル0の平均データであることを示すことができる。 - parallel_threshold (int) – 複数のスレッドで実行を開始する
memoryの要素数。len(memory)が >= この値の場合、関数は複数のスレッドで実行される。 デフォルトでは1000に設定されている。
戻り値
疎外された記憶のリスト
戻りの型
マージナル・メモリー
レイズ
ValueError - int_return と hex_return の両方が設定されている場合 True
ディストリビューション
ProbDistribution(データ[、ショット)] | 確率分布の一般的なディクトのようなクラス。 |
QuasiDistribution(データ[、ショット)] | 準確率を表現するディクトのようなクラス。 |
期待値
sampled_expectation_value
qiskit.result.sampled_expectation_value(dist, oper)
サンプリングされた分布から期待値を計算する
生のdictを渡すには、ビット文字列のキーが必要であることに注意してください。
パラメーター
- dist (dict |result.Counts |QuasiDistribution |ProbDistribution) – サンプリングされた分布を入力してください。
- oper (str |quantum_info.Pauli |quantum_info.SparsePauliOp |quantum_info.SparseObservable) – オブザーバブルのオペレーター。
戻り値
期待値。
レイズ
QiskitError - 入力ディストリビューションまたは演算子の型が無効な場合
戻りの型