optimset

最適化オプション構造体の作成または変更

構文

options = optimset(Name,Value)

optimset

options = optimset

options = optimset(optimfun)

options = optimset(oldopts,Name,Value)

options = optimset(oldopts,newopts)

説明

MATLAB^® ソルバーのオプション構造体を作成または変更します。

メモ

fzero、fminbnd、fminsearch、および lsqnonneg を除くすべてのソルバーには、optimset の代わりに optimoptions の使用を推奨します。

options = optimset(Name,Value) は、1 つ以上の名前と値のペアの引数を使用して設定したパラメーターが指定された options を返します。

optimset (入力引数や出力引数なし) は、パラメーターと各パラメーターの有効な値のリストを表示します。

options = optimset (入力引数なし) は、すべてのパラメーターが [] に設定されたオプション構造体 options を作成します。

options = optimset(optimfun) は、最適化関数 optimfun に関連するすべてのパラメーター名と既定値をもつ options を作成します。

options = optimset(oldopts,Name,Value) は、oldopts のコピーを作成し、1 つ以上の名前と値のペアの引数を使用して指定したパラメーターを変更します。

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

例

既定ではないオプションの作成

fminsearch でプロット関数と既定よりも厳密な停止条件を使用するためのオプションを設定します。

options = optimset('PlotFcns','optimplotfval','TolX',1e-7);

このオプションを使用して、点 (–1,2) から開始する Rosenbrock 関数を最小化し、その最小化プロセスを監視します。Rosenbrock 関数は点 (1,1) で最小値 0 となります。

fun = @(x)100*((x(2) - x(1)^2)^2) + (1 - x(1))^2; % Rosenbrock's function
x0 = [-1,2];
[x,fval] = fminsearch(fun,x0,options)

x = 1×2

    1.0000    1.0000

fval = 
4.7305e-16

ソルバーの既定のオプションの作成

fzero ソルバーの既定のオプションを含む構造体を作成します。

options = optimset('fzero');

fzero の TolX オプションの既定値を表示します。

tol = options.TolX

tol = 
2.2204e-16

オプションの変更

関数の許容誤差として 1e-6 を使用するためのオプションを設定します。

oldopts = optimset('TolFun',1e-6);

'optimplotfval' プロット関数と、TolX の値として 1e-6 を使用するために、oldopts のオプションを変更します。

options = optimset(oldopts,'PlotFcns','optimplotfval','TolX',1e-6);

設定した 3 つのオプションを表示します。

disp(options.TolFun);

   1.0000e-06

disp(options.PlotFcns);

optimplotfval

disp(options.TolX);

   1.0000e-06

新しいオプション構造体を使用したオプション構造体の更新

optimset を使用して、オプション構造体の該当部分を別のオプション構造体で上書きします。

oldopts = optimset('Display','iter','TolX',1e-6);
newopts = optimset('PlotFcns','optimplotfval','Display','off');
options = optimset(oldopts,newopts);

oldopts と newopts はどちらも、Display オプションの値を設定しています。newopts がこのオプションの oldopts を上書きすることを確認します。

options.Display

ans = 
'off'

他の 2 つのオプションの値を確認します。

options.TolX

ans = 
1.0000e-06

options.PlotFcns

ans = 
'optimplotfval'

入力引数

optimfun — 最適化ソルバー

名前 | 関数ハンドル

最適化ソルバー。名前または関数ハンドルとして指定します。返されるオプション構造体では、指定したソルバーについてのみ、エントリが空以外になります。

例: options = optimset('fzero')

例: options = optimset(@fminsearch)

データ型: char | string | function_handle

oldopts — 元の最適化オプション

構造体

元の最適化オプション。構造体として指定します。出力の options は、指定したパラメーターを除いて oldopts と同じです。

例: options = optimset(oldopts,'TolX',1e-6)

データ型: struct

newopts — 新しい最適化オプション

構造体

新しい最適化オプション。構造体として指定します。出力の options は newopts と同じで、さらに newopts では空で oldopts では空以外だったパラメーターが含まれます。

例: options = optimset(oldopts,newopts)

データ型: struct

名前と値の引数

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

R2021a より前では、コンマを使用して名前と値をそれぞれ区切り、Name を引用符で囲みます。

例: options = optimset('TolX',1e-6,'PlotFcns',@optimplotfval)

固有なオプション名を設定する場合は、先頭文字だけでも構いません。optimset はオプション名の大文字小文字を区別しません。

Display — 表示レベル

'notify' (既定値) | 'final' | 'off' | 'none' | 'iter'

表示レベル。'Display' と次のいずれかの値で構成されるコンマ区切りのペアとして指定します。

• 'notify' ― 関数が収束しない場合に出力を表示する。

• 'final' — 最終出力のみを表示する。

• 'off' または 'none' — 出力を表示しない。

• 'iter' — 各反復の出力を表示する (lsqnonneg では使用不可)。

Display はすべての最適化ソルバーで使用できます。

例: options = optimset('Display','iter')

データ型: char | string

FunValCheck — 関数値が有効かどうかチェックするフラグ

'off' (既定値) | 'on'

関数値が有効かどうかチェックするフラグ。'FunValCheck' と 値 'off' または 'on' で構成されるコンマ区切りのペアとして指定します。値が 'on' の場合、目的関数が複素数または NaN の値を返すと、ソルバーはエラーを表示します。

FunValCheck は fminbnd、fminsearch、および fzero で使用できます。

例: options = optimset('FunValCheck','on')

データ型: char | string

MaxFunEvals — 関数評価の最大回数

fminbnd では 500、fminsearch では 200*(number of variables) (既定値) | 正の整数

関数評価の最大回数。'MaxFunEvals' と正の整数で構成されるコンマ区切りのペアとして指定します。

MaxFunEvals は fminbnd と fminsearch で使用できます。

例: options = optimset('MaxFunEvals',2e3)

データ型: single | double

MaxIter — 反復の最大回数

fminbnd では 500、fminsearch では 200*(number of variables) (既定値) | 正の整数

反復の最大回数。'MaxIter' と正の整数で構成されるコンマ区切りのペアとして指定します。

MaxIter は fminbnd と fminsearch で使用できます。

例: options = optimset('MaxIter',2e3)

データ型: single | double

OutputFcn — 出力関数

[] (既定値) | 関数名 | 関数ハンドル | 関数ハンドルの cell 配列

出力関数。'OutputFcn' と関数名または関数ハンドルで構成されるコンマ区切りのペアとして指定します。複数の出力関数は関数ハンドルの cell 配列として指定します。出力関数は各反復の後に実行され、解法プロセスを監視することや、反復を停止することができます。詳細については、最適化ソルバーの出力関数を参照してください。

OutputFcn は fminbnd、fminsearch、および fzero で使用できます。

例: options = optimset('OutputFcn',{@outfun1,@outfun2})

データ型: char | string | cell | function_handle

PlotFcns — プロット関数

[] (既定値) | 関数名 | 関数ハンドル | 関数ハンドルの cell 配列

プロット関数。 'PlotFcns' と関数名または関数ハンドルで構成されるコンマ区切りのペアとして指定します。複数のプロット関数は関数ハンドルの cell 配列として指定します。プロット関数は各反復の後に実行され、解法プロセスを監視することや、反復を停止することができます。詳細についてはプロット関数と出力関数とプロット関数の構文を参照してください。

組み込みプロット関数は次のとおりです。

• @optimplotx は現在の点をプロットします。

• @optimplotfval は関数値をプロットします。

• @optimplotfunccount は関数カウントをプロットします (fzero では使用不可)。

PlotFcns は fminbnd、fminsearch、および fzero で使用できます。

例: options = optimset('PlotFcns','optimplotfval')

データ型: char | string | cell | function_handle

TolFun — 関数値の終了許容誤差

1e-4 (既定値) | 非負のスカラー

関数値の終了許容誤差。'TolFun' と非負のスカラーで構成されるコンマ区切りのペアとして指定します。現在の関数値と前回の値との差が初期関数値を基準とした TolFun を下回ると、反復は終了します。許容誤差と停止条件を参照してください。

TolFun は fminsearch でのみ使用できます。

例: options = optimset('TolFun',2e-6)

データ型: single | double

TolX — 現在の点 x における終了許容誤差

fminbnd と fminsearch では 1e-4、fzero では eps、lsqnonneg では 10*eps*norm(c,1)*length(c) (既定値) | 非負のスカラー

現在の点 x における終了許容誤差。'TolX' と非負のスカラーで構成されるコンマ区切りのペアとして指定します。現在の点と前回の点との差が x のサイズを基準とした TolX を下回ると、反復は終了します。許容誤差と停止条件を参照してください。

TolX はすべてのソルバーで使用できます。

例: options = optimset('TolX',2e-6)

データ型: single | double

出力引数

options — 最適化オプション

構造体

最適化オプション。構造体として返されます。設定しなかったパラメーターは、返される値が [] となります。その結果、ソルバーはこれらのパラメーターの既定値を使用します。

制限

• optimset では、4 つの MATLAB 最適化ソルバー (fminbnd、fminsearch、fzero、および lsqnonneg) のオプションを設定します。Optimization Toolbox™ ソルバーまたは Global Optimization Toolbox ソルバーのオプションを設定する場合、推奨される関数は optimoptions です。

• optimset では、一部の Optimization Toolbox ソルバーのオプション (intlinprog など) を設定できません。代わりに optimoptions を使用してください。

• optimset では、Global Optimization Toolbox ソルバーのほとんどのオプションを設定できません。代わりに optimoptions を使用してください。

拡張機能

C/C++ コード生成

MATLAB® Coder™ を使用して C および C++ コードを生成します。

使用上の注意および制限:

• コード生成は、入力引数または出力引数をとらない構文はサポートしません。

  optimset

• options で指定される関数はコード生成でサポートされなければなりません。

• 入力引数 optimfun はコード生成でサポートされる関数でなければなりません。

• オプション構造体 oldopts のフィールドは固定サイズ フィールドでなければなりません。

• コード生成は、Display オプションを無視します。

• コード生成は、Optimization Toolbox の関数 optimset で作成されたオプション構造体では追加のオプションをサポートしません。入力オプション構造体に追加の Optimization Toolbox オプションが含まれる場合、出力構造体にそれらのオプションは含まれません。

バージョン履歴

R2006a より前に導入

参考

optimget | optimoptions | fminbnd | fminsearch | fzero | lsqnonneg

トピック

• optimoptions と optimset からの選択
• 一般的に使用される最適化オプション: 調整とトラブルシューティング
• 最適化オプションの設定と変更