psoptimget

(Not recommended) Obtain values of pattern search options structure

psoptimget is not recommended. Instead, query options using dot notation. For more information, see Version History.

Syntax

val = psoptimget(options,'name')
val = psoptimget(options,'name',default)


Description

val = psoptimget(options,'name') returns the value of the parameter name from the pattern search options structure options. psoptimget(options,'name') returns an empty matrix [] if the value of name is not specified in options. It is only necessary to type enough leading characters of name to uniquely identify it. psoptimget ignores case in parameter names.

val = psoptimget(options,'name',default) returns the value of the parameter name from the pattern search options structure options, but returns default if the parameter is not specified (as in []) in options.

Examples

opts = psoptimset('TolX',1e-4);
val = psoptimget(opts,'TolX')

returns val = 1e-4.

Version History

Introduced before R2006a

R2018b: psoptimget is not recommended

To query options, the gaoptimget, psoptimget, and saoptimget functions are not recommended. Instead, use dot notation. For example, to see the setting of the Display option in opts,

displayopt = opts.Display
% instead of
displayopt = gaoptimget(opts,'Display')

Using automatic code completions, dot notation takes fewer keystrokes: displayopt = opts.D Tab.

There are no plans to remove gaoptimget, psoptimget, and saoptimget at this time.