Home > matlab > acado > packages > +acado > @OCP > maximizeMayerTerm.m

maximizeMayerTerm

PURPOSE ^

Adds an expression as a the Mayer term to be maximized.

SYNOPSIS ^

function maximizeMayerTerm(obj, varargin)

DESCRIPTION ^

Adds an expression as a the Mayer term to be maximized. 

  Usage:
    >> ocp.maximizeMayerTerm(expression)

  Parameters:
    expression     expression to be maximized     [  ]

  Example:
    >> ocp = acado.OCP(0.0, 1.0, 20);
    >> ocp.maximizeMayerTerm(x + p*p + q*q);

  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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function maximizeMayerTerm(obj, varargin)
0002 %Adds an expression as a the Mayer term to be maximized.
0003 %
0004 %  Usage:
0005 %    >> ocp.maximizeMayerTerm(expression)
0006 %
0007 %  Parameters:
0008 %    expression     expression to be maximized     [  ]
0009 %
0010 %  Example:
0011 %    >> ocp = acado.OCP(0.0, 1.0, 20);
0012 %    >> ocp.maximizeMayerTerm(x + p*p + q*q);
0013 %
0014 %  Licence:
0015 %    This file is part of ACADO Toolkit  - (http://www.acadotoolkit.org/)
0016 %
0017 %    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
0018 %    Copyright (C) 2008-2009 by Boris Houska and Hans Joachim Ferreau, K.U.Leuven.
0019 %    Developed within the Optimization in Engineering Center (OPTEC) under
0020 %    supervision of Moritz Diehl. All rights reserved.
0021 %
0022 %    ACADO Toolkit is free software; you can redistribute it and/or
0023 %    modify it under the terms of the GNU Lesser General Public
0024 %    License as published by the Free Software Foundation; either
0025 %    version 3 of the License, or (at your option) any later version.
0026 %
0027 %    ACADO Toolkit is distributed in the hope that it will be useful,
0028 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
0029 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0030 %    Lesser General Public License for more details.
0031 %
0032 %    You should have received a copy of the GNU Lesser General Public
0033 %    License along with ACADO Toolkit; if not, write to the Free Software
0034 %    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0035 %
0036 %    Author: David Ariens
0037 %    Date: 2009
0038 %
0039 
0040     if (isa(varargin{1}, 'acado.Expression'))
0041 
0042         obj.maxMayerTerms{end+1} = varargin{1};
0043 
0044     else
0045         error('ERROR: Invalid OCP.maximizeMayerTerm call. <a href="matlab: help acado.OCP.maximizeMayerTerm">help acado.OCP.maximizeMayerTerm</a>'); 
0046 
0047     end
0048 
0049 end

www.acadotoolkit.org/matlab
Generated on Tue 01-Jun-2010 20:14:12 by m2html © 2005