set

Sets value of an option.

  Usage:
    >> OptimizationAlgorithm.set(name, value)

  Parameters:
    name  Possible values:     [STRING]
         OPT_UNKNOWN     
         MAX_NUM_STEPS     
         INTEGRATOR_TOLERANCE     
         ABSOLUTE_TOLERANCE     
         INITIAL_STEPSIZE     
         MIN_STEPSIZE     
         MAX_STEPSIZE     
         STEPSIZE_TUNING     
         CORRECTOR_TOLERANCE     
         INTEGRATOR_PRINTLEVEL     
         LINEAR_ALGEBRA_SOLVER     
         ALGEBRAIC_RELAXATION     
         RELAXATION_PARAMETER     
         FEASIBILITY_CHECK     
         MAX_NUM_ITERATIONS     
         KKT_TOLERANCE     
         KKT_TOLERANCE_SAFEGUARD     
         LEVENBERG_MARQUARDT     
         PRINTLEVEL     
         PRINT_COPYRIGHT     
         HESSIAN_APPROXIMATION     
         DYNAMIC_SENSITIVITY     
         OBJECTIVE_SENSITIVITY     
         CONSTRAINT_SENSITIVITY     
         DISCRETIZATION_TYPE     
         LINESEARCH_TOLERANCE     
         MIN_LINESEARCH_PARAMETER     
         MAX_NUM_QP_ITERATIONS     
         HOTSTART_QP     
         INFEASIBLE_QP_RELAXATION     
         INFEASIBLE_QP_HANDLING     
         USE_REALTIME_ITERATIONS     
         INTEGRATOR_TYPE     
         SAMPLING_TIME     
         SIMULATE_COMPUTATIONAL_DELAY     
         PARETO_FRONT_DISCRETIZATION     
         PARETO_FRONT_GENERATION     
         PARETO_FRONT_HOTSTART 
    value  Assigned value to option    [NUMERIC/HessianApproximationMode/..]

  Example:
    >> ocp = acado.OCP(0.0, 1.0, 20);
    >> algo = acado.OptimizationAlgorithm(ocp);   
    >> algo.set('INTEGRATOR_TOLERANCE', 1e-0 );

  Licence:
    This file is part of ACADO Toolkit  - (http://www.acadotoolkit.org/)

    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
    Copyright (C) 2008-2009 by Boris Houska and Hans Joachim Ferreau, K.U.Leuven.
    Developed within the Optimization in Engineering Center (OPTEC) under
    supervision of Moritz Diehl. All rights reserved.

    ACADO Toolkit is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 3 of the License, or (at your option) any later version.

    ACADO Toolkit is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with ACADO Toolkit; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

    Author: David Ariens
    Date: 2009

0001 function set(obj, name, value)
0002 %Sets value of an option.
0003 %
0004 %  Usage:
0005 %    >> OptimizationAlgorithm.set(name, value)
0006 %
0007 %  Parameters:
0008 %    name  Possible values:     [STRING]
0009 %         OPT_UNKNOWN
0010 %         MAX_NUM_STEPS
0011 %         INTEGRATOR_TOLERANCE
0012 %         ABSOLUTE_TOLERANCE
0013 %         INITIAL_STEPSIZE
0014 %         MIN_STEPSIZE
0015 %         MAX_STEPSIZE
0016 %         STEPSIZE_TUNING
0017 %         CORRECTOR_TOLERANCE
0018 %         INTEGRATOR_PRINTLEVEL
0019 %         LINEAR_ALGEBRA_SOLVER
0020 %         ALGEBRAIC_RELAXATION
0021 %         RELAXATION_PARAMETER
0022 %         FEASIBILITY_CHECK
0023 %         MAX_NUM_ITERATIONS
0024 %         KKT_TOLERANCE
0025 %         KKT_TOLERANCE_SAFEGUARD
0026 %         LEVENBERG_MARQUARDT
0027 %         PRINTLEVEL
0028 %         PRINT_COPYRIGHT
0029 %         HESSIAN_APPROXIMATION
0030 %         DYNAMIC_SENSITIVITY
0031 %         OBJECTIVE_SENSITIVITY
0032 %         CONSTRAINT_SENSITIVITY
0033 %         DISCRETIZATION_TYPE
0034 %         LINESEARCH_TOLERANCE
0035 %         MIN_LINESEARCH_PARAMETER
0036 %         MAX_NUM_QP_ITERATIONS
0037 %         HOTSTART_QP
0038 %         INFEASIBLE_QP_RELAXATION
0039 %         INFEASIBLE_QP_HANDLING
0040 %         USE_REALTIME_ITERATIONS
0041 %         INTEGRATOR_TYPE
0042 %         SAMPLING_TIME
0043 %         SIMULATE_COMPUTATIONAL_DELAY
0044 %         PARETO_FRONT_DISCRETIZATION
0045 %         PARETO_FRONT_GENERATION
0046 %         PARETO_FRONT_HOTSTART
0047 %    value  Assigned value to option    [NUMERIC/HessianApproximationMode/..]
0048 %
0049 %  Example:
0050 %    >> ocp = acado.OCP(0.0, 1.0, 20);
0051 %    >> algo = acado.OptimizationAlgorithm(ocp);
0052 %    >> algo.set('INTEGRATOR_TOLERANCE', 1e-0 );
0053 %
0054 %  Licence:
0055 %    This file is part of ACADO Toolkit  - (http://www.acadotoolkit.org/)
0056 %
0057 %    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
0058 %    Copyright (C) 2008-2009 by Boris Houska and Hans Joachim Ferreau, K.U.Leuven.
0059 %    Developed within the Optimization in Engineering Center (OPTEC) under
0060 %    supervision of Moritz Diehl. All rights reserved.
0061 %
0062 %    ACADO Toolkit is free software; you can redistribute it and/or
0063 %    modify it under the terms of the GNU Lesser General Public
0064 %    License as published by the Free Software Foundation; either
0065 %    version 3 of the License, or (at your option) any later version.
0066 %
0067 %    ACADO Toolkit is distributed in the hope that it will be useful,
0068 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
0069 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0070 %    Lesser General Public License for more details.
0071 %
0072 %    You should have received a copy of the GNU Lesser General Public
0073 %    License along with ACADO Toolkit; if not, write to the Free Software
0074 %    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0075 %
0076 %    Author: David Ariens
0077 %    Date: 2009
0078 %
0079    
0080 if (isa(value, 'acado.MexInput'))
0081     error('You cant use an acado.MexInput for setting optimization algorithm options.');
0082 end
0083 
0084 
0085     obj.set_n{end+1} = name;
0086     obj.set_v{end+1} = value;
0087     
0088 end