findopOptions
Option set for findop
Description
opt = findopOptions(
creates
a default option set for computing the operating point of a specified
nonlinear ARX or Hammerstein-Wiener model. Use dot notation to modify
this option set for your specific application. Options that you do
not modify retain their default values.model
)
creates
an option set with options specified by one or more opt
= findopOptions(model
,Name,Value
)Name,Value
pair
arguments.
Examples
Create Default Option Set for Operating Point Search
Create a default option set for findop
using an idnlarx
model.
opt = findopOptions(idnlarx);
Create and Modify Default Operating Point Search Options
Create a default option set for findop
using an idnlhw
model.
opt = findopOptions(idnlhw);
Use dot notation to specify a subspace Gauss-Newton least squares search with a maximum of 25 iterations.
opt.SearchMethod = 'gn';
opt.SearchOptions.MaxIterations = 25;
Specify Options for Operating Point Search
Create an option set for findop
using an idnlarx
model. Specify a steepest descent least squares search with default search options.
opt = findopOptions(idnlarx,'SearchMethod','grad');
Input Arguments
model
— Estimated nonlinear model
idnlarx
model | idnlhw
model
Estimated nonlinear model, specified as one of the following:
idnlarx
modelidnlhw
model
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: 'SearchMethod','grad'
specifies a
steepest descent least squares search method
SearchMethod
— Numerical search method used for iterative parameter estimation
'auto'
(default) | 'gn'
| 'gna'
| 'lm'
| 'grad'
| 'lsqnonlin'
| 'fmincon'
Numerical search method used for iterative parameter estimation, specified as the one of the values in the following table.
SearchMethod | Description |
---|---|
'auto' | Automatic method selection A combination of the
line search algorithms, |
'gn' | Subspace Gauss-Newton least-squares search Singular
values of the Jacobian matrix less than
|
'gna' | Adaptive subspace Gauss-Newton search Eigenvalues
less than |
'lm' | Levenberg-Marquardt least squares search Each
parameter value is |
'grad' | Steepest descent least-squares search |
'lsqnonlin' | Trust-region-reflective algorithm of This algorithm requires Optimization Toolbox™ software. |
'fmincon' | Constrained nonlinear solvers You can use the
sequential quadratic programming (SQP) and trust-region-reflective
algorithms of the
|
SearchOptions
— Option set for the search algorithm
search option set
Option set for the search algorithm, specified as the comma-separated
pair consisting of 'SearchOptions'
and a search
option set with fields that depend on the value of
SearchMethod
.
SearchOptions
Structure When SearchMethod
Is Specified
as 'gn'
, 'gna'
, 'lm'
,
'grad'
, or 'auto'
Field Name | Description | Default | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Tolerance | Minimum percentage difference between the current value
of the loss function and its expected improvement after the next iteration,
specified as a positive scalar. When the percentage of expected improvement
is less than | 0.01 | ||||||||||||||||||||||||||||||
MaxIterations | Maximum number of iterations during loss-function minimization, specified as a positive
integer. The iterations stop when Setting
Use
| 20 | ||||||||||||||||||||||||||||||
Advanced | Advanced search settings, specified as a structure with the following fields.
|
SearchOptions
Structure When SearchMethod
Is Specified
as 'lsqnonlin'
Field Name | Description | Default |
---|---|---|
FunctionTolerance | Termination tolerance on the loss function that the software minimizes to determine the estimated parameter values, specified as a positive scalar. The
value of | 1e-5 |
StepTolerance | Termination tolerance on the estimated parameter values, specified as a positive scalar. The value of | 1e-6 |
MaxIterations | Maximum number of iterations during loss-function minimization, specified as a positive
integer. The iterations stop when The value of
| 20 |
SearchOptions
Structure When SearchMethod
Is Specified
as 'fmincon'
Field Name | Description | Default |
---|---|---|
Algorithm |
For more information about the algorithms, see Constrained Nonlinear Optimization Algorithms (Optimization Toolbox) and Choosing the Algorithm (Optimization Toolbox). | 'sqp' |
FunctionTolerance | Termination tolerance on the loss function that the software minimizes to determine the estimated parameter values, specified as a positive scalar. | 1e-6 |
StepTolerance | Termination tolerance on the estimated parameter values, specified as a positive scalar. | 1e-6 |
MaxIterations | Maximum number of iterations during loss function minimization, specified as a positive
integer. The iterations stop when | 100 |
To specify field values in SearchOptions
, create a
default findopOptions
set and modify the fields using
dot notation. Any fields that you do not modify retain their default
values.
opt = findopOptions; opt.SearchOptions.MaxIterations = 15; opt.SearchOptions.Advanced.RelImprovement = 0.5;
Output Arguments
opt
— Option set for findop
command
findopOptions
object
Option set for findop
command, returned
as a findopOptions
object.
Version History
Introduced in R2015aR2018a: Renaming of Estimation and Analysis Options
The names of some estimation and analysis options were changed in R2018a. Prior names still work.
See Also
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)