Engee documentation

OptimizeOptions

Page in progress.

Creates an object for optimization settings.

Library

EngeeDesignOptimization

Description

Function OptimizeOptions creates an object for optimization settings EngeeDesignOptimization.OptimizeOptions for the function optimize. The settings allow you to specify the tolerances, the maximum number of iterations, and the number of restarts of the optimization method.

Syntax

Function call

  • opt = OptimizeOptions() — creates an optimization settings object opt with default properties for solving the optimization problem using the function optimize.

  • opt = OptimizeOptions(Name=Value) — creates an optimization settings object opt and sets its properties using one or more arguments of the type «name-value».

Properties of the object EngeeDesignOptimization.OptimizeOptions available for reading and installation using the operator ..

Arguments

Input arguments «name-value»

Specify optional argument pairs as Name=Value, where Name — the name of the argument, and Value — the appropriate value. The order of type arguments «name-value» It doesn’t matter.

# Restarts — the number of restarts of the optimization method

+ 0 (by default) | scalar

Details

The number of restarts of the optimization method in case the convergence criteria are not met, set as a non-negative integer. At each restart, the initial values of the configurable parameters are set equal to the final values obtained during the previous optimization stage.

Типы данных

Int16, Int32, Int64

# GradFcn — providing gradient information

+ true (by default) | false

Details

An option indicating whether the target function passed to provides EngeeDesignOptimization.OptimizeOptions for the function optimize, information about the gradient.

It is set to one of the following values:

  • false — the objective function does not provide information about the gradient, optimize calculates the gradient using the central difference method;

  • true — the objective function provides information about the gradient as one of its output arguments.

Типы данных

Bool

Output arguments

# opt — optimization settings

+ object

Details

Optimization settings returned as an object EngeeDesignOptimization.OptimizeOptions.

Properties of the object are available for reading and setting using the operator .. Unspecified properties retain their default values.

Типы данных

EngeeDesignOptimization.OptimizeOptions

Features

# MethodOptions — optimization method settings

+ EngeeOptimization.LsqnonlinOptions (by default) | object

Details

Optimization method settings, set as an object.

By default, the optimization method is lsqnonlin therefore, its settings are used by default in this property. Detailed information about the available settings and their default values is available on the documentation page. lsqnonlin.

To change the settings of the optimization method, use the operator .. For example: opt.MethodOptions.StepTolerance = 1.5e-3.

Типы данных

EngeeOptimization.SolverOptions

# Restarts — the number of restarts of the optimization method

+ 0 (default) | scalar

Details

The number of restarts of the optimization method in case the convergence criteria are not met, set as a non-negative integer. At each restart, the initial values of the configurable parameters are set equal to the final values obtained during the previous optimization stage.

Типы данных

Int16, Int32, Int64

# GradFcn — providing gradient information

+ false (default) | true

Details

An option indicating whether the target function passed to provides optimize, information about the gradient.

It is set to one of the following values:

  • false — the objective function does not provide information about the gradient, optimize calculates the gradient using the central difference method;

  • true — the objective function provides information about the gradient as one of its output arguments.

Типы данных

Bool