ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

statget

統計オプション構造体の値にアクセス

構文

val = statget(options,param)
val = statget(options,param,default)

説明

val = statget(options,param) は、param で指定された統計オプション構造体 options のパラメーターの値を返します。入力 param は、パラメーター名の文字ベクトルまたは string スカラーです。options でパラメーターが定義されていない場合、statget[] を返します。なお、パラメーター名の先頭の数文字を入力するだけで、パラメーターを特定できます。statget は、パラメーター名の大文字と小文字の区別を無視します。使用可能な options については、「入力」を参照してください。

val = statget(options,param,default) は、指定されたパラメーターが最適化オプション構造体 options で定義されていない場合、default を返します。

入力引数

DerivStep

有限差分導関数計算で使用する相対差分。正のスカラーまたはオプション構造体を使用して関数 Statistics and Machine Learning Toolbox™ で推定されるパラメーターのベクトルと同じサイズの正のスカラーのベクトル。

Display

アルゴリズムで表示される情報量。

  • 'off' — 何の情報も表示しません。

  • 'final' — 最終出力を表示します。

  • 'iter' — いくつかの関数ではコマンド ウィンドウに反復出力を表示します。それ以外では最終出力を表示します。

FunValCheck

目的関数から、NaNInf などの無効な値をチェックします。

  • 'off'

  • 'on'

GradObj

目的関数が 2 番目の出力として勾配ベクトルを返すかどうかのフラグ。

  • 'off'

  • 'on'

Jacobian

目的関数が 2 番目の出力としてヤコビアンを返すかどうかのフラグ。

  • 'off'

  • 'on'

MaxFunEvals

可能な目的関数評価の最大回数。正の整数。

MaxIter

反復の最大許容回数。正の整数。

OutputFcn

ソルバーは、各反復後にすべての出力関数を呼び出します。

  • @ を使用して指定される関数ハンドル

  • 関数ハンドルの cell 配列

  • 空の配列 (既定の設定)

Robust

ロバスト近似オプションを呼び出します。

  • 'off'

  • 'on'

RobustWgtFun

ロバスト近似用の重み関数。Robust'on' の場合にのみ有効です。入力として正規化された残差を受け取り、出力としてロバストな重みを返す、関数ハンドルとしても使用できます。

  • 'bisquare'

  • 'andrews'

  • 'cauchy'

  • 'fair'

  • 'huber'

  • 'logistic'

  • 'talwar'

  • 'welsch'

Streams

RandStream クラスの単一のインスタンス、または RandStream インスタンスの cell 配列。Streams オプションは一部の関数で使用でき、その関数内でどのストリームを乱数の生成に使用するかを制御します。'UseSubstreams'true の場合、ストリーム値はスカラーまたは空のいずれかでなければなりません。'UseParallel'true で、'UseSubstreams'false の場合、ストリームの引数が空であるか、その長さが計算に使用するプロセッサの台数と合致していなければなりません。つまり、parpool が開いている場合は parpool サイズに等しく、それ以外ではスカラーです。

TolBnd

パラメーターの制限許容誤差。正のスカラー。

TolFun

目的関数値の終了許容誤差。正のスカラー。

TolTypeFun

TolFun は、目的関数の許容誤差の絶対値または相対値を指定します。

  • 'abs'

  • 'rel'

TolTypeX

TolX は、パラメーターの許容誤差の絶対値または相対値を指定します。

  • 'abs'

  • 'rel'

TolX

パラメーターの終了許容誤差。正のスカラー。

Tune

ロバスト近似に使用する調整定数で、重み関数を適用する前に残差を正規化するため使用します。既定値は重み関数に依存します。関数ハンドルとして重み関数を指定する場合、このパラメーターが必要になります。正のスカラー。

UseParallel

使用可能関数が Parallel Computing Toolbox™ (PCT) の機能を使用するかどうかを示すフラグ。これはその機能が使用できる場合、つまり、PCT がインストールされ、PCT parpool が有効な場合のことです。有効な値は、逐次計算では false (既定値)、並列計算では true です。

UseSubstreams

適格な関数の乱数発生器で RandStream クラスの Substream プロパティを使用するかどうかを指定するフラグ。false (既定) または truetrue の場合、つまり関数内で高レベル反復を指定すると、Substream プロパティを反復値に設定します。この機能は、並列および/または逐次モード計算において、再現性のある乱数ストリームを生成するのに役立ちます。

WgtFun

ロバスト近似用の重み関数。Robust'on' の場合にのみ有効です。入力として正規化された残差を受け取り、出力としてロバストな重みを返す、関数ハンドルとしても使用できます。

  • 'bisquare'

  • 'andrews'

  • 'cauchy'

  • 'fair'

  • 'huber'

  • 'logistic'

  • 'talwar'

  • 'welsch'

次のステートメントは、my_options という名前の構造体から、Display 統計オプション パラメーターの値を返します。

val = statget(my_options,'Display')

my_options という名前の構造体から、Display 統計オプション パラメーターの値を (前の例と同様に) 返します。Display パラメーターが定義されていない場合、statget は値 'final' を返します。

optnew = statget(my_options,'Display','final');

参考

R2006a より前に導入