statset

統計オプション構造体の作成

構文

statset
statset(statfun)
options = statset(...)
options = statset(fieldname1,val1,fieldname2,val2,...)
options = statset(oldopts,fieldname1,val1,fieldname2,val2,...)
options = statset(oldopts,newopts)


説明

statset は、入力引数と出力引数がない場合、統計オプション構造体のすべてのフィールドと可能な値を表示します。

statset(statfun) は、Statistics and Machine Learning Toolbox™ の関数 statfun で使用するフィールドと既定値を表示します。statfun の指定には、文字ベクトル、string スカラーまたは関数ハンドルを使用します。

options = statset(...) は、統計オプション構造体 options を作成します。入力引数がない場合、オプション構造体のすべてのフィールドは空の配列 ([]) になります。statfun を指定すると、関数固有のフィールドは既定値で、残りのフィールドは [] になります。[] で設定した関数固有のフィールドは、その関数が、そのパラメーター用に既定値を使用することを表します。使用可能な options については、「入力」を参照してください。

options = statset(fieldname1,val1,fieldname2,val2,...) は、名前の付いたフィールドに指定された値をもつオプション構造体を作成します。値を指定しない場合はすべて [] にします。フィールド名には string スカラーまたは文字ベクトルを使用します。名前付きの値の場合は、その値の完全な文字ベクトルまたは string スカラーを入力しなければなりません。値に対して無効な文字ベクトルまたは string スカラーが指定された場合、statset は既定値を使用します。

options = statset(oldopts,fieldname1,val1,fieldname2,val2,...) は、名前の付いたパラメーターを指定された値に変更した oldopts のコピーを作成します。

options = statset(oldopts,newopts) は、既存のオプション構造体 oldopts と新しいオプション構造体 newopts を組み合わせます。空でない値をもつ newopts のパラメーターは、oldopts の対応するパラメーターを上書きします。

入力引数

DerivStep	有限差分導関数計算で使用する相対差分。正のスカラーまたはオプション構造体を使用して関数 Statistics and Machine Learning Toolbox で推定されるパラメーターのベクトルと同じサイズの正のスカラーのベクトル。
Display	アルゴリズムで表示される情報量。 'off' — 何の情報も表示しません。 'final' — 最終出力を表示します。 'iter' — いくつかの関数ではコマンド ウィンドウに反復出力を表示します。それ以外では最終出力を表示します。
FunValCheck	目的関数から、NaN や Inf などの無効な値をチェックします。 'off' 'on'
GradObj	目的関数が 2 番目の出力として勾配ベクトルを返すかどうかのフラグ。 'off' 'on'
Jacobian	目的関数が 2 番目の出力としてヤコビアンを返すかどうかのフラグ。 'off' 'on'
MaxFunEvals	可能な目的関数評価の最大回数。正の整数。
MaxIter	反復の最大許容回数。正の整数。
OutputFcn	ソルバーは、各反復後にすべての出力関数を呼び出します。 @ を使用して指定される関数ハンドル 関数ハンドルの cell 配列 空の配列 (既定の設定)
Robust	(非推奨) ロバスト近似オプションを呼び出します。 'off' 'on' 関数 Robust は推奨されません。ロバスト近似には RobustWgtFun を使用します。
RobustWgtFun	ロバスト近似用の重み関数。入力として正規化された残差を受け取り、出力としてロバストな重みを返す、関数ハンドルとしても使用できます。関数ハンドルを使用する場合、定数 Tune を使用します。ロバスト オプションを参照してください。
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 (既定) または true。true の場合、つまり関数内で高レベル反復を指定すると、Substream プロパティを反復値に設定します。この機能は、並列および/または逐次モード計算において、再現性のある乱数ストリームを生成するのに役立ちます。
WgtFun	(非推奨) ロバスト近似用の重み関数。Robust が 'on' の場合にのみ有効です。入力として正規化された残差を受け取り、出力としてロバストな重みを返す、関数ハンドルとしても使用できます。ロバスト オプションを参照してください。 関数 WgtFun は推奨されません。代わりに RobustWgtFun を使用してください。

例

データの極値分布を近似する、関数 evfit の既定の設定のパラメーター値を変更するものとします。既定の設定のパラメーター値は次のとおりです。

statset('evfit')
ans = 
          Display: 'off'
      MaxFunEvals: []
          MaxIter: []
           TolBnd: []
           TolFun: []
       TolTypeFun: []
             TolX: 1.0000e-06
         TolTypeX: []
          GradObj: []
         Jacobian: []
        DerivStep: []
      FunValCheck: []
           Robust: []
     RobustWgtFun: []
           WgtFun: []
             Tune: []
      UseParallel: []
    UseSubstreams: []
          Streams: []
        OutputFcn: []

evfit が使用するパラメーターは Display と TolX だけです。TolX の値を 1e-8 に設定してオプション構造体を作成するには、以下のように入力します。

options = statset('TolX',1e-8)
% Pass options to evfit:
mu = 1;
sigma = 1;
data = evrnd(mu,sigma,1,100);

paramhat = evfit(data,[],[],[],options)

詳細

ロバスト オプション

重み関数	式	既定の設定の調整定数
'andrews'	w = (abs(r)<pi) .* sin(r) ./ r	1.339
'bisquare' (既定の設定)	w = (abs(r)<1) .* (1 - r.^2).^2	4.685
'cauchy'	w = 1 ./ (1 + r.^2)	2.385
'fair'	w = 1 ./ (1 + abs(r))	1.400
'huber'	w = 1 ./ max(1, abs(r))	1.345
'logistic'	w = tanh(r) ./ r	1.205
'talwar'	w = 1 * (abs(r)<1)	2.795
'welsch'	w = exp(-(r.^2))	2.985
[]	非ロバスト近似	—

バージョン履歴

R2006a より前に導入

参考

statget