Home > mpt > mpt_init.m

mpt_init

PURPOSE ^

MPT_INIT Initializes the MPT toolbox

SYNOPSIS ^

function out=mpt_init(varargin)

DESCRIPTION ^

MPT_INIT Initializes the MPT toolbox

 ---------------------------------------------------------------------------
 DESCRIPTION
 ---------------------------------------------------------------------------
 Any routine of the MPT toolbox can be called with user-specified values
 of different parameters. To make usage of MPT toolbox as user-friendly as
 possible, we provide the option to store default values of the parameters
 in variable mptOptions, which is stored in MATLAB's workspace as a global
 variable (i.e. it stays there unless one types 'clear all'). 

 Please have a look at the code bellow to see what are the default values
 of the fields of mptOptions.

 Fields of mptOptions:

 lpsolver       - variable which sets the default LP solver. 
                  allowed values:
                    'nag'       - NAG LP solver (e04naf)
                    'e04mbf'    - NAG LP solver (e04mbf)
                    'cdd'       - CDD Criss-Cross
                    'cplex'     - CPLEX 9 LP solver
                    'cplex8'    - CPLEX 8 LP solver
                    'glpk'      - GLPK solver
                    'linprog'   - Matlab's linprog
                    'sedumi'    - SeDuMi
                    'qsopt'     - QSopt
                    'xpress'    - XPRESS
                    'mosek'     - MOSEK
                    'ooqp'      - OOQP
                    'clp'       - CLP
                    'bpmpd'     - BPMPD
                    'cplexmex'  - CPLEX (interfaced with CPLEXMEX)

 qpsolver       - variable which sets the default QP solver
                  allowed values:
                    'nag'       - NAG QP solver
                    'cplex'     - CPLEX 9 QP solver
                    'cplex8'    - CPLEX 8 QP solver
                    'quadprog'  - Matlab's quadprog
                    'xpress'    - XPRESS
                    'mosek'     - MOSEK
                    'ooqp'      - OOQP
                    'clp'       - CLP
                    'bpmpd'     - BPMPD
                    'cplexmex'  - CPLEX (interfaced with CPLEXMEX)

 milpsolver     - variable which sets the default MILP solver. 
                  allowed values:
                    'cplex'     - CPLEX 9 (interfaced with cplexint)
                    'yalmip'    - YALMIP Branch & Bound algorithm
                    'glpk'      - GLPK solver (interfaced with glpkmex)
                    'xpress'    - XPRESS
                    'mosek'     - MOSEK
                    'bintprog'  - bintprog.m
                    'cplexmex'  - CPLEX (interfaced with CPLEXMEX)

 miqpsolver     - variable which sets the default MIQP solver. 
                  allowed values:
                    'cplex'     - CPLEX 9 (interfaced with cplexint)
                    'yalmip'    - YALMIP Branch & Bound algorithm
                    'xpress'    - XPRESS
                    'mosek'     - MOSEK
                    'cplexmex'  - CPLEX (interfaced with CPLEXMEX)

 extreme_solver - method to use for extreme points and convex hull enumeration
                  allowed values:
                     'matlab'   - analytical enumeration
                     'lrs'      - LRS algorithm (matlab implementation)
                     'cdd'      - CDD

 details        - defines how many details about the solution should be stored
                  in the resulting controller structure.
 rel_tol        - relative tolerance for computation
 abs_tol        - absolute tolerance for computation
 step_size      - step of a size over a facet in mpQP/mpLP
 debug_level    - level of debugging in mpQP/mpLP
 infbox         - the R^n polyhedra is internally converted to a box,
                  this option defines bounds of that box
 newfigure      - if set to 1, each picture will be plotted in a separate
                  figure window
 verbose        - level of verbosity of the algorithms


 USAGE:

   mpt_init
   mpt_init('Property',Value,'Property',Value,...)
   e.g.
   mpt_init('qpsolver','quadprog','lpsolver','cdd','debug_level',2)

 ---------------------------------------------------------------------------
 INPUT
 ---------------------------------------------------------------------------
 Pair(s) Property, Value

 ---------------------------------------------------------------------------
 OUTPUT                                                                                                    
 ---------------------------------------------------------------------------
 mptOptions structure

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Thu 30-Mar-2006 10:26:47 by m2html © 2003