artelys_knitro_options

artelys_knitro_options(overrides, mpopt)

artelys_knitro_options() - Sets options for Artelys Knitro (version 13.x and greater).

OPT = ARTELYS_KNITRO_OPTIONS
OPT = ARTELYS_KNITRO_OPTIONS(OVERRIDES)
OPT = ARTELYS_KNITRO_OPTIONS(OVERRIDES, FNAME)
OPT = ARTELYS_KNITRO_OPTIONS(OVERRIDES, MPOPT)

Sets the values for the options struct normally passed to Artelys Knitro.

Inputs are all optional, second argument must be either a string
(FNAME) or a struct (MPOPT):

    OVERRIDES - struct containing values to override the defaults
    FNAME - name of user-supplied function called after default
        options are set to modify them. Calling syntax is:
                MODIFIED_OPT = FNAME(DEFAULT_OPT);
    MPOPT - MATPOWER options struct, uses the following fields:
        opf.violation    - used to set opt.FeasibilityTol
        verbose          - used to set opt.DisplayInterval,
                              opt.OutputFlag, opt.LogToConsole
        knitro.tol_x     - used to set opt.xtol
        knitro.tol_f     - used to set opt.ftol
        knitro.maxit     - used to set opt.maxit
        knitro.opts      - struct containing values to use as OVERRIDES
        knitro.opt_fname - name of user-supplied options file, to be
            passed to the solver as a 'knitroOptsFile' input argument,
            overriding any options it specifies
        knitro.opt      - numbered user option file, if and only if
            knitro.opt_fname is empty and knitro.opt is a non-zero
            integer N then knitro.opt_fname is auto generated as:
            'knitro_user_options_N.txt'

Output is a parameter struct to pass to Artelys Knitro.

There are multiple ways of providing values to override the default
options. Their precedence and order of application are as follows:

With inputs OVERRIDES and FNAME
    1. FNAME is called
    2. OVERRIDES are applied
With inputs OVERRIDES and MPOPT
    1. knitro.opts (if not empty) are applied
    2. OVERRIDES are applied
    3. Options in options file (if specified) are applied

For details on the available options, see the "Knitro user options"
section of the "Artelys Knitro User's Manual" at:

    https://www.artelys.com/app/docs/knitro/index.html

See also knitro_options, mpoption().