saoptimset
(Not recommended) Create simulated annealing options structure
saoptimset
is not recommended. Use
optimoptions
instead. For more information, see Compatibility Considerations.
Syntax
saoptimset
options = saoptimset
options = saoptimset('param1',value1,'param2',value2,...)
options = saoptimset(oldopts,'param1',value1,...)
options = saoptimset(oldopts,newopts)
options = saoptimset('simulannealbnd')
Description
saoptimset
with no input or output arguments displays a complete
list of parameters with their valid values.
options = saoptimset
(with no input arguments) creates a structure
called options
that contains the options, or
parameters, for the simulated annealing algorithm, with all
parameters set to []
.
options = saoptimset('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 []
. It is sufficient to type
only enough leading characters to define the parameter name uniquely. Case is ignored for
parameter names. Note that for character values, correct case and the complete value are
required.
options = saoptimset(oldopts,'param1',value1,...)
creates a copy of
oldopts
, modifying the specified parameters with the specified
values.
options = saoptimset(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 = saoptimset('simulannealbnd')
creates an options structure
with all the parameter names and default values relevant to
'simulannealbnd'
. For example,
saoptimset('simulannealbnd') ans = AnnealingFcn: @annealingfast TemperatureFcn: @temperatureexp AcceptanceFcn: @acceptancesa TolFun: 1.0000e-006 StallIterLimit: '500*numberofvariables' MaxFunctionEvaluations: '3000*numberofvariables' TimeLimit: Inf MaxIterations: Inf ObjectiveLimit: -Inf Display: 'final' DisplayInterval: 10 HybridFcn: [] HybridInterval: 'end' PlotFcns: [] PlotInterval: 1 OutputFcns: [] InitialTemperature: 100 ReannealInterval: 100 DataType: 'double'
Options
The following table lists the options you can set with saoptimset
.
See Simulated Annealing Options for a complete description of these options and their
values. Values in {}
denote the default value. You can also view the
options parameters by typing saoptimset
at the command line.
optimoptions
hides the options listed in
italics, but saoptimset
does not. See Options that optimoptions Hides.
Option | Description | Values |
---|---|---|
| Function the algorithm uses to determine if a new point is accepted. Specify as
| Function handle | |
| Function the algorithm uses to generate new points. Specify as a name of a built-in annealing function or a function handle. | Function handle | function name | |
| Type of decision variable |
|
| Level of display |
|
DisplayInterval | Interval for iterative display | Positive integer | |
FunctionTolerance | Termination tolerance on function value For an options structure, use
| Nonnegative scalar | |
| Automatically run |
or 1-by-2 cell array |
|
HybridInterval | Interval (if not | Positive integer | |
| Initial value of temperature | Nonnegative scalar | positive vector | |
| Maximum number of objective function evaluations allowed For an options
structure, use | Nonnegative integer | |
| Maximum number of iterations allowed For an options structure, use
| Nonnegative integer | |
| Number of iterations over which average change in fitness function value at current
point is less than
For an options
structure, use | Nonnegative integer | |
| The algorithm stops after running for For an options structure, use
| Nonnegative scalar | |
| Minimum objective function value desired | Scalar | |
| Function(s) get(s) iterative data and can change options at run time For an
options structure, use | Function handle | cell array of function handles |
|
| Plot function(s) called during iterations For an options structure, use
| Function handle | built-in plot function name | cell array of function handles | cell
array of built-in plot function names | |
PlotInterval | Plot functions are called at every interval | Positive integer | |
| Reannealing interval | Nonnegative integer | |
| Function used to update temperature schedule | Function handle | built-in temperature function name |
|