| Genetic Algorithm and Direct Search Toolbox |
 |
psoptimset
Create a pattern search options structure
Syntax
options = psoptimset
psoptimset
options = psoptimset('param1',value1,'param2',value2,...)
options = psoptimset(oldopts,'param1',value1,...)
options = psoptimset(oldopts,newopts)
Description
options = psoptimset (with no input arguments) creates a structure called options that contains the options, or parameters, for the pattern search and sets parameters to their default values.
psoptimset with no input or output arguments displays a complete list of parameters with their valid values.
options = psoptimset('param1',value1,'param2',value2,...) creates a structure options and sets the value of 'param1' to value1, 'param2' to value2, and so on. Any unspecified parameters are set to their default values. It is sufficient to type only enough leading characters to define the parameter name uniquely. Case is ignored for parameter names.
options = psoptimset(oldopts,'param1',value1,...) creates a copy of oldopts, modifying the specified parameters with the specified values.
options = psoptimset(oldopts,newopts) combines an existing options structure, oldopts, with a new options structure, newopts. Any parameters in newopts with nonempty values overwrite the corresponding old parameters in oldopts.
Options
The following table lists the options you can set with psoptimset. See Pattern Search Options for a complete description of the options and their values. Values in {} denote the default value. You can also view the optimization parameters and defaults by typing psoptimset at the command line.
Option
|
Description
|
Values
|
Cache
|
With Cache set to 'on', patternsearch keeps a history of the mesh points it polls and does not poll points close to them again at subsequent iterations. Use this option if patternsearch runs slowly because it is taking a long time to compute the objective function.
|
'on' | {'off'}
|
CacheSize
|
Size of the history
|
Positive scalar | {1e4}
|
CacheTol
|
Positive scalar specifying how close the current mesh point must be to a point in the history in order for patternsearch to avoid polling it
|
Positive scalar | {1e-10}
|
CompletePoll
|
Complete poll around current iterate
|
'on' | {'off'}
|
CompleteSearch
|
Complete poll around current iterate
|
'on' | {'off'}
|
Display
|
Level of display
|
'off' | 'iter' | 'notify' | 'diagnose' | {'final'}
|
InitialMeshSize
|
Initial mesh size for pattern algorithm
|
Positive scalar | {1.0}
|
MaxFunEvals
|
Maximum number of objective function evaluations
|
Positive integer | {2000*numberOfVariables}
|
MaxIteration
|
Maximum number of iterations
|
Positive integer | {100*numberOfVariables}
|
MaxMeshSize
|
Maximum mesh size
|
Positive scalar | {Inf}
|
MeshAccelerator
|
Accelerate convergence near a minimum
|
'on' | {'off'}
|
MeshContraction
|
Mesh contraction factor. Used when iteration is unsuccessful.
|
Positive scalar | {0.5}
|
MeshExpansion
|
Mesh expansion factor. Expands mesh when iteration is successful.
|
Positive scalar |{2.0}
|
OutputFcn
|
Specifies a user-defined function that an optimization function calls at each iteration
|
@psoutputhistory | {none}
|
PlotFcn
|
Specifies plots of output from the pattern search
|
@psplotbestf | @psplotmeshsize | @psplotfuncount | {[]}
|
PlotInterval
|
Specifies the number of iterations between consecutive calls to the plot functions
|
Positive integer
|
PollingOrder
|
Order of poll directions in pattern search
|
'Random' | 'Success' | {'Consecutive'}
|
PollMethod
|
Polling strategy used in pattern search
|
{'PositiveBasis2N'} | 'PositiveBasisNp1'
|
ScaleMesh
|
Automatic scaling of variables
|
{'on'} | 'off'
|
SearchMethod
|
Type of search used in pattern search
|
'PositiveBasisNp1' | 'PositiveBasis2N' | @searchga | @searchlhs | @searchneldermead| {[]}
|
TolBind
|
Binding tolerance
|
Positive scalar | {1e-3}
|
TolCon
|
Tolerance on constraints
|
Positive scalar | {1e-6}
|
TolFun
|
Tolerance on function
|
Positive scalar | {1e-6}
|
TolMesh
|
Tolerance on mesh size
|
Positive scalar | {1e-6}
|
TolX
|
Tolerance on variable
|
Positive scalar | {1e-6}
|
Vectorized
|
Specifies whether functions are vectorized
|
'on' | {'off'}
|
For a detailed description of these options, see Pattern Search Options.
See Also
patternsearch, psoptimget
| psoptimget | |