ParameterExpression
class qiskit.circuit.ParameterExpression(name_map=None, expr=None)
ベース: object
パラメータ式。
これはQiskitの記号式エンジンと、式内のパラメータのキャッシュによって支えられています。
属性
num_parameters
式中の未束縛パラメータの数。
これはに等価であるが len(expr.parameters) 、集合の作成とその長さの計算に伴うオーバーヘッドを伴わない。
parameters
式に存在するパラメータを取得する。
Qiskitは平等性を保証します( == )の式から取得したパラメータを元の Parameter この式を作成するために使用されたオブジェクトですが、 is 成功するための比較。
方法
abs
abs()
式の絶対値を取る。
arccos
arccos()
表現のアルコシン。
arcsin
arcsin()
式のアークサイン。
arctan
arctan()
式のアークタンジェント。
assign
assign(parameter, value)
1つのパラメータに値を割り当てる。この値は、数値でも別のパラメータ式でもよい。
パラメーター
- parameter - この式で値が更新されるパラメータ。
- value - バインドする新しい値。
戻り値
代入によって束縛されなかったパラメータによってパラメータ化された新しい式。
bind
bind(parameter_values, allow_unknown_parameters=False)
指定されたパラメータのセットを、対応する値に結びつける。
パラメーター
- パラメータ値 – マッピング
Parameterインスタンスを、バインドされる数値に設定します。 - allow_unknown_parameters -
Falseの場合、parameter_valuesのキーに、式に存在しない s が含まれているとエラーを発生する。Parameterが含まれている場合、エラーを発生させる。Trueの場合、そのようなパラメータは単に無視される。
レイズ
-
- parameter_valuesにselfのパラメータ以外のパラメータが含まれる場合。 -
parameter_valuesに数値以外の値が渡された場合。
- parameter_valuesにselfのパラメータ以外のパラメータが含まれる場合。 -
-
- 提供された値をバインドする際にゼロによる除算が必要な場合。
戻り値
parameter_values で束縛されなかったパラメータでパラメータ化された新しい式。
bind_all
bind_all(values)
self のすべてのパラメータを辞書内の数値にバインドし、数値を返す。
これは bind() であり、より高いパフォーマンスを達成することができる。 values 辞書に、この式で使用されないパラメータが含まれていても問題はない。同じバインディング辞書が、他の式にも供給されることを期待している。
すべての値をバインドしていない values ディクショナリでこのメソッドを呼び出したり、数値以外の値でこのメソッドを呼び出したりするのはエラーであるが、このメソッドはパフォーマンス重視の使用を意図しているため、明示的にチェックされることはない。 不正な辞書を渡すと、予期しない動作をすることがある。
とは異なり bind()と異なり、このメソッドは非有限の浮動小数点値に遭遇しても例外を発生させない。
パラメーター
values - パラメータの数値へのマッピング。
conjugate
conjugate()
式の複素共役を返す。
cos
cos()
式のコサイン。
exp
exp()
式を指数化する。
gradient
gradient(param)
入力パラメータに関するこの式の導関数を返す。
パラメーター
param - 微分を計算するパラメータ.
戻り値
定数数値または記号としての導関数 ParameterExpression.
is_real
is_real()
式が実数を表しているかどうかをチェックする。
未束縛のパラメータがある場合、これは None 。
is_symbol
is_symbol()
式がプレーンシンボルに対応するかどうかをチェックする。
戻り値
True この式が記号に対応する場合は False 、そうでない場合は。
log
log()
式の自然対数をとる。
numeric
numeric(strict=True)
この式を数値にキャストする。
パラメーター
strict - True (デフォルト) の場合、式中に未結合の記号があるとエラーになります。 False の場合、未束縛の記号に関係なく、式が数値を表す場合にキャストできる。 例えば、 (0 * Parameter("x")) は0だが、シンボル x が存在する。
sign
sign()
式の符号を返す。
sin
sin()
式の正弦。
subs
subs(parameter_map, allow_unknown_parameters=False)
パラメータを置き換えた新しい式を返します。
パラメーター
- parameter_map - 以下のマッピング
ParameterselfのParameterExpressionインスタンスへのマッピング。 - allow_unknown_parameters -
Falseの場合、parameter_mapのキーに、式に存在しない s が含まれているとエラーを発生する。Parameterが含まれている場合、エラーを発生させる。Trueの場合、そのようなパラメータは単に無視される。
レイズ
- parameter_mapにselfのパラメータ以外のパラメータが含まれる場合。 -
parameter_mapの置換パラメータが、生成される式で名前の衝突を引き起こす場合。
戻り値
指定されたパラメータを置き換えた新しい式。
sympify
sympify()
この式の SymPy 等価物を返す。
戻り値
この式の SymPy。
tan
tan()
式のタンジェント。