wcmarginOptions

Option set for wcmargin

Syntax

opt = wcmarginOptions
opt = wcmarginOptions(Name,Value,...)

Description

opt = wcmarginOptions returns the default option set for wcmargin.

opt = wcmarginOptions(Name,Value,...) creates an option set with the options specified by one or more Name,Value pair arguments.

Input Arguments

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

'Sensitivity'

Determines whether to compute the sensitivity of worst-case gain with respect to each individual uncertain element.

Sensitivity is a string that takes the following values:

  • 'on' — Sensitivity of the worst-case gain is computed with respect to each individual uncertain element. This provides an indication of which elements are most problematic.

  • 'off'wcmargin does not compute the sensitivity of the worst-case gain with respect to each individual uncertain element.

Default: 'off'

'AbsTol'

Absolute tolerance on computed worst-case margin bounds.

The algorithm terminates if UpperBound-LowerBound <= max(AbsTol, Reltol*UpperBound)

Default: 0.02

'RelTol'

Relative tolerance on computed worst-case margin bounds.

The algorithm terminates if UpperBound-LowerBound <= max(AbsTol, Reltol*UpperBound)

Default: 0.05

Output Arguments

opt

Option set containing the specified options for wcmargin.

Examples

Create an options set for wcmargin with an 0.01 and 0.03 as the absolute and relative tolerances on the worst-case margin bounds, respectively.

opt = wcmarginOptions('AbsTol',0.01,'RelTol',0.03);

Alternatively, use dot notation to set the values of opt.

opt = wcmarginOptions;
opt.AbsTol = 0.01;
opt.RelTol = 0.03;
Was this topic helpful?