resetoptions

オプションのリセット

構文

options2 = resetoptions(options,optionname)

options2 = resetoptions(options,multioptions)

説明

options2 = resetoptions(options,optionname) は、指定したオプションを既定値にリセットします。

ヒント

オプションのセットが 1 つしか必要ない場合は、出力引数として options2 の代わりに options を使用します。

options2 = resetoptions(options,multioptions) は、複数のオプションを既定値にリセットします。

例

1 つのオプションのリセット

一部の設定が既定値ではないオプションを作成します。MaxIterations 設定を調べます。

options = optimoptions('fmincon','Algorithm','sqp','MaxIterations',2e4,...
    'SpecifyObjectiveGradient',true);
options.MaxIterations

ans =

       20000

MaxIterations オプションを既定値にリセットします。

options2 = resetoptions(options,'MaxIterations');
options2.MaxIterations

ans =

   400

'sqp' アルゴリズムに対する MaxIterations オプションの既定値は 400 です。

複数のオプションのリセット

一部の設定が既定値ではないオプションを作成します。MaxIterations 設定を調べます。

options = optimoptions('fmincon','Algorithm','sqp','MaxIterations',2e4,...
    'SpecifyObjectiveGradient',true);
options.MaxIterations

ans =

       20000

MaxIterations オプションと Algorithm オプションを既定値にリセットします。MaxIterations 設定を調べます。

multiopts = {'MaxIterations','Algorithm'};
options2 = resetoptions(options,multiopts);
options2.MaxIterations

ans =

        1000

既定の 'interior-point' アルゴリズムに対する MaxIterations オプションの既定値は 1000 です。

入力引数

options — 最適化オプション

optimoptions によって作成されたオブジェクト

最適化オプション。optimoptions によって作成されたオブジェクトとして指定します。

例: optimoptions('fmincon','Algorithm','sqp','SpecifyObjectiveGradient',true)

optionname — オプション名

一重引用符に囲まれた名前

オプション名。一重引用符で囲んで名前として指定します。各ソルバーの許容されるオプション名については、関数リファレンス ページの options のセクションを参照してください。

例: 'Algorithm'

データ型: char

multioptions — 複数のオプション

名前の cell 配列

複数のオプション。名前の cell 配列として指定します。

例: {'Algorithm','OptimalityTolerance'}

データ型: cell

出力引数

options2 — 最適化オプション

optimoptions によって作成されたオブジェクト

最適化オプション。optimoptions によって作成されたオブジェクトとして返されます。

バージョン履歴

R2016a で導入

参考

optimoptions

トピック

• 最適化オプションの設定