statset

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

構文

statset()

statset(statfun)

statset(___)

statset(Name=Value)

statset(oldopts,newopts)

statset(oldopts,Name=Value)

説明

statset() は、統計オプション構造体のすべてのフィールドとその可能な値を表示します。

statset(statfun) は、statfun で指定された関数またはオブジェクトで使用されるフィールドと既定値を表示します。

statset(___) は、前のいずれかの入力引数の組み合わせを使用して統計オプション構造体を返します。

statset(Name=Value) は、1 つ以上の名前と値の引数を使用してオプション構造体のフィールドの値を設定します。たとえば、目的関数評価の最大数やロバスト近似用の重み関数を指定できます。

statset(oldopts,newopts) は、newopts の空のフィールドを oldopts の値に変更したコピーを返します。

statset(oldopts,Name=Value) は、oldopts のフィールドの値を名前と値の引数で指定された値に変更したコピーを返します。

例

フィールドの値の表示

統計オプション構造体のすべてのフィールドとその可能な値を表示します。

statset()

                Display: [ {off} | final | iter ]
            MaxFunEvals: [ positive integer ]
                MaxIter: [ positive integer ]
                 TolBnd: [ positive scalar ]
                 TolFun: [ positive scalar ]
             TolTypeFun: ['abs' |'rel']
                   TolX: [ positive scalar ]
               TolTypeX: ['abs' |'rel']
                GradObj: [ {off} | on ]
               Jacobian: [ {off} | on ]
              DerivStep: [ positive scalar or vector ]
            FunValCheck: [ off | {on} ]
           RobustWgtFun: [ {[]} | bisquare | andrews | cauchy | fair | huber | logistic | talwar | welsch | function handle ]
                   Tune: [ positive scalar ]
            UseParallel: [ {false} | true ]
          UseSubstreams: [ {false} | true ]
                Streams: [ {} | RandStream or cell array ]
              OutputFcn: [ {[]} | function handle or cell array ]

フィールドとその可能な値が出力に表示されます。この出力を統計オプション構造体を作成するときの参考として使用できます。

統計関数用の既定のオプション構造体の作成

fitglm関数用の既定のオプションを含むオプション構造体を作成します。

options = statset("fitglm")

options = struct with fields:
          Display: 'off'
      MaxFunEvals: []
          MaxIter: 100
           TolBnd: []
           TolFun: []
       TolTypeFun: []
             TolX: 1.0000e-06
         TolTypeX: []
          GradObj: []
         Jacobian: []
        DerivStep: []
      FunValCheck: []
           Robust: []
     RobustWgtFun: []
           WgtFun: []
             Tune: []
      UseParallel: []
    UseSubstreams: []
          Streams: {}
        OutputFcn: []

出力から、fitglm 用の既定のオプションには、表示、最大反復回数、およびパラメーターの終了許容誤差の値が含まれていることがわかります。統計オプション構造体を受け入れる他の関数に options を渡すことができます。

カスタム オプション構造体の作成

名前と値の引数を使用して個々のフィールドの値を指定することでカスタム オプション構造体を作成します。

options = statset(FunValCheck="on",TolX=1e-8)

options = struct with fields:
          Display: []
      MaxFunEvals: []
          MaxIter: []
           TolBnd: []
           TolFun: []
       TolTypeFun: []
             TolX: 1.0000e-08
         TolTypeX: []
          GradObj: []
         Jacobian: []
        DerivStep: []
      FunValCheck: 'on'
           Robust: []
     RobustWgtFun: []
           WgtFun: []
             Tune: []
      UseParallel: []
    UseSubstreams: []
          Streams: {}
        OutputFcn: []

適切な統計関数に options を渡して、パラメーターの終了許容誤差を 1e-8 に設定し、無効な値をチェックできます。

既定のオプションの変更

関数nbinfit用の既定のオプションを含む統計オプション構造体を作成します。その後、名前と値の引数を使用してフィールドの値を指定することで構造体を変更します。

oldopts = statset("nbinfit")

oldopts = struct with fields:
          Display: 'off'
      MaxFunEvals: 400
          MaxIter: 200
           TolBnd: 1.0000e-06
           TolFun: 1.0000e-06
       TolTypeFun: []
             TolX: 1.0000e-06
         TolTypeX: []
          GradObj: []
         Jacobian: []
        DerivStep: []
      FunValCheck: []
           Robust: []
     RobustWgtFun: []
           WgtFun: []
             Tune: []
      UseParallel: []
    UseSubstreams: []
          Streams: {}
        OutputFcn: []

oldopts は、nbinfit 関数用の既定の値を含む統計オプション構造体です。TolX の既定値が 1e-6 であることに注目してください。

oldopts のコピーを作成し、TolX に 1e-8 を指定します。

opts = statset(oldopts,TolX=1e-8)

opts = struct with fields:
          Display: 'off'
      MaxFunEvals: 400
          MaxIter: 200
           TolBnd: 1.0000e-06
           TolFun: 1.0000e-06
       TolTypeFun: []
             TolX: 1.0000e-08
         TolTypeX: []
          GradObj: []
         Jacobian: []
        DerivStep: []
      FunValCheck: []
           Robust: []
     RobustWgtFun: []
           WgtFun: []
             Tune: []
      UseParallel: []
    UseSubstreams: []
          Streams: {}
        OutputFcn: []

出力から、opts のフィールドの値が TolX 以外は oldopts のフィールドと同じであることがわかります。

入力引数

statfun — 統計関数

文字ベクトル | string スカラー

統計関数。文字ベクトルまたは string スカラーとして次のように指定します。

• 以下の表に示す関数またはオブジェクトの名前。

  bootci	bootstrp	candexch
  copulafit	cordexch	crossval
  coxphfit	daugment	dcovary
  evfit	factoran	fitcox
  fitglm	fitglme	fitlme
  fitlmematrix	fitnlm	fitrgp
  gamfit	GeneralizedLinearMixedModel	gevfit
  glmfit	gmdistribution	gpfit
  kmeans	kmedoids	lasso
  lassoglm	LinearMixedModel	lognfit
  mdscale	mlecov	mvncdf
  mvtcdf	nbinfit	nlmefitsa
  nlinfit	nnmf	normfit
  pca	plsregress	ppca
  rocmetrics	rowexch	sequentialfs
  TreeBagger	tsne	wblfit

  これらの関数名のいずれかを指定すると、statset はその関数用の既定のオプションを返します。

• "mlecustom" — カスタム確率分布を指定するときに mle 関数用のオプションを指定します。

• "parallel" — 並列化をサポートする関数用のオプションを指定します。

例: "bootci"

データ型: char | string

oldopts — 古いオプション

オプション構造体

古いオプション。統計オプション構造体として指定します。

データ型: struct

newopts — 新しいオプション

オプション構造体

新しいオプション。統計オプション構造体として指定します。

データ型: string

名前と値の引数

オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。

例: statset(MaxFunEvals=200,TolBnd=1e-6,TolX=1e-6) は、目的関数評価の最大数を 200 と指定し、パラメーターの制限許容誤差とパラメーターの終了許容誤差の両方を 1e-6 と指定します。

DerivStep — 相対差

正のスカラー (既定値) | 正のスカラーのベクトル

有限差分の計算用の相対差。正のスカラーまたは正のスカラーのベクトルとして指定します。DerivStep が正のスカラーのベクトルの場合、オプション構造体を使用して関数で推定されるパラメーターのベクトルと同じサイズでなければなりません。

例: DerivStep=0.1

データ型: single | double

Display — アルゴリズム情報を表示するオプション

"off" | "final" | "iter"

アルゴリズム情報を表示するオプション。次のいずれかとして指定します。

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

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

• "iter" — 一部の関数についてはコマンド ウィンドウに反復出力を表示し、それ以外については最終出力を表示します。

例: Display="iter"

データ型: char | string

FunValCheck — 無効な値をチェックするためのフラグ

"off" | "on"

目的関数によって返される無効な値をチェックするためのフラグ。"off" または "on" として指定します。無効な値の例には NaN や Inf があります。

例: FunValCheck="on"

データ型: char | string

GradObj — 勾配を返すためのフラグ

"off" | "on"

目的関数の追加の出力として勾配ベクトルを返すためのフラグ。"off" または "on" として指定します。

例: GradObj="on"

データ型: char | string

Jacobian — ヤコビアンを返すためのフラグ

"off" | "on"

目的関数の追加の出力としてヤコビアンを返すためのフラグ。"off" または "on" として指定します。

例: Jacobian="on"

データ型: char | string

MaxFunEvals — 目的関数評価の最大数

正の整数

目的関数評価の最大数。正の整数として指定します。

例: MaxFunEvals=200

データ型: single | double

MaxIter — 最大反復回数

正の整数

最大反復回数。正の整数を指定します。

例: MaxIter=100

データ型: single | double

OutputFcn — 出力関数

関数ハンドル | 関数ハンドルの cell 配列

出力関数。関数ハンドルまたは関数ハンドルの cell 配列として指定します。

例: OutputFcn=@myfun

データ型: cell | function_handle

RobustWgtFun — ロバスト近似用の重み関数

文字ベクトル | string スカラー

ロバスト近似用の重み関数。次の関数名のいずれかの文字ベクトルまたは string スカラーとして指定します。

重み関数	式	既定の設定の調整定数
"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

例: RobustWgtFun="logistic"

データ型: char | string

Streams — 乱数ストリーム

RandStream オブジェクト | RandStream オブジェクトの cell 配列

乱数ストリーム。RandStream オブジェクトまたは RandStream オブジェクトの cell 配列として指定します。

UseSubstreams が true の場合、Streams を RandStream オブジェクトの cell 配列にすることはできません。UseSubstreams が false で UseParallel が true の場合、Streams は空であるか、計算のプロセッサ数と同じ長さでなければなりません。プロセッサ数はスカラーであるか、並列プール (開いている場合) のサイズと等しくなります。

TolBnd — パラメーターの制限許容誤差

正のスカラー

パラメーターの制限許容誤差。正のスカラーとして指定します。

例: TolBnd=1e-6

データ型: single | double

TolFun — 目的関数の終了許容誤差

正のスカラー

目的関数の終了許容誤差。正のスカラーとして指定します。

例: TolFun=1.5

データ型: single | double

TolTypeFun — 目的関数の終了許容誤差のタイプ

"abs" | "rel"

目的関数の終了許容誤差のタイプ。"abs" または "rel" として指定します。TolTypeFun が "abs" の場合、TolFun は絶対許容誤差です。TolTypeFun が "rel" の場合、TolFun は相対許容誤差です。

例: TolTypeFun="rel"

データ型: char | string

TolX — パラメーターの終了許容誤差

正のスカラー

パラメーターの終了許容誤差。正のスカラーとして指定します。

例: TolX=1e-6

データ型: single | double

TolTypeX — パラメーターの終了許容誤差のタイプ

"abs" | "rel"

パラメーターの終了許容誤差のタイプ。"abs" または "rel" として指定します。TolTypeX が "abs" の場合、TolX は絶対許容誤差です。TolTypeX が "rel" の場合、TolX は相対許容誤差です。

例: TolTypeX="rel"

データ型: char | string

Tune — ロバスト近似用の調整定数

正のスカラー

ロバスト近似用の調整定数。正のスカラーとして指定します。Tune の既定値は、RobustWgtFun で指定される重み関数によって異なります。

例: Tune=1.5

データ型: single | double

UseParallel — 並列計算を使用するためのフラグ

false または 0 | true または 1

並列計算機能 (Parallel Computing Toolbox™ が必要) を使用するためのフラグ。数値または logical の 0 (false) または 1 (true) として指定します。UseParallel が true の場合に並列計算を使用するには、Parallel Computing Toolbox がインストールされていて、並列プールが開いている必要があります。

例: UseParallel=true

データ型: logical

UseSubstreams — サブストリームを使用するためのフラグ

false または 0 | true または 1

乱数発生器でサブストリームを使用するためのフラグ。数値または logical の 0 (false) または 1 (true) として指定します。

UseSubstreams が true の場合、options の出力を使用する関数は RandStream オブジェクトの Substream プロパティを使用します。RandStream オブジェクトは、名前と値の引数 Streams を使用して指定できます。

サブストリームを使用すると、並列モードおよび逐次モードの計算において、再現性のある乱数ストリームを生成するのに役立ちます。詳細については、並列統計計算での再現性を参照してください。

例: UseSubstreams=true

データ型: logical

バージョン履歴

R2006a より前に導入

参考

statget