Home > matlab > make.m

make

PURPOSE ^

Make ACADO Integrators and OCP. Run the command 'make' directly within the directory <ACADOtoolkit-inst-dir>/interfaces/matlab/

SYNOPSIS ^

function [ ] = make( varargin )

DESCRIPTION ^

  Make ACADO Integrators and OCP. Run the command 'make' directly within the directory <ACADOtoolkit-inst-dir>/interfaces/matlab/

  By running this command, you compile both the ACADO integerators as well
  as the ACADO OCP interface.

  Usage:
   >>make                    Make changed files only, no debugging, no cleaning
   >>make clean              Clean all object and mex files
   >>make debug              Make changed files only in debug mode
   >>make all                Force all files to be maked again
   >>make all debug          Force all files to be maked again in debug mode
   >>make clean all          First clean, then make all files
   >>make clean all debug    First clean, then make all files in debug mode
  
  All information regarding installation available at http://www.acadotoolkit.org/matlab

  You need to setup mex before you can run this make script. Run 
   >>mex -setup
  in your console if you haven't used mex yet. 

  When using Windows, we encourage you to install Microsoft Visual C++
  (express) compiler first. After installation, run "mex -setup" and
  select the Microsoft Visual C++ compiler as your default compiler. This
  compiler can be download free of charge on
  http://www.microsoft.com/Express/VC/.

  When running Linux/Mac OS, select the GCC compiler. 


  After having run make, all ACADO files are compiled and stored in the bin
  directory. Your paths are also altered to reference the ACADO folders.
  If you close are reopen Matlab you need to rerun this file because your
  path settings will be lost. As long as you do not delete the content of
  the bin folder, this should only take a few seconds because all files
  are unchanged. If you prefer not to rerun this file. Run 
    >>savepath
  in your console. This will store the current path for future sessions.


  Example:
   >>make; 
   <hit enter and wait for the compilation to end. This will take a few minutes>

  see also makesimulation, makeocp, makeintegrators, makemex

  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 [ ] = make( varargin )
0002 %  Make ACADO Integrators and OCP. Run the command 'make' directly within the directory <ACADOtoolkit-inst-dir>/interfaces/matlab/
0003 %
0004 %  By running this command, you compile both the ACADO integerators as well
0005 %  as the ACADO OCP interface.
0006 %
0007 %  Usage:
0008 %   >>make                    Make changed files only, no debugging, no cleaning
0009 %   >>make clean              Clean all object and mex files
0010 %   >>make debug              Make changed files only in debug mode
0011 %   >>make all                Force all files to be maked again
0012 %   >>make all debug          Force all files to be maked again in debug mode
0013 %   >>make clean all          First clean, then make all files
0014 %   >>make clean all debug    First clean, then make all files in debug mode
0015 %
0016 %  All information regarding installation available at http://www.acadotoolkit.org/matlab
0017 %
0018 %  You need to setup mex before you can run this make script. Run
0019 %   >>mex -setup
0020 %  in your console if you haven't used mex yet.
0021 %
0022 %  When using Windows, we encourage you to install Microsoft Visual C++
0023 %  (express) compiler first. After installation, run "mex -setup" and
0024 %  select the Microsoft Visual C++ compiler as your default compiler. This
0025 %  compiler can be download free of charge on
0026 %  http://www.microsoft.com/Express/VC/.
0027 %
0028 %  When running Linux/Mac OS, select the GCC compiler.
0029 %
0030 %
0031 %  After having run make, all ACADO files are compiled and stored in the bin
0032 %  directory. Your paths are also altered to reference the ACADO folders.
0033 %  If you close are reopen Matlab you need to rerun this file because your
0034 %  path settings will be lost. As long as you do not delete the content of
0035 %  the bin folder, this should only take a few seconds because all files
0036 %  are unchanged. If you prefer not to rerun this file. Run
0037 %    >>savepath
0038 %  in your console. This will store the current path for future sessions.
0039 %
0040 %
0041 %  Example:
0042 %   >>make;
0043 %   <hit enter and wait for the compilation to end. This will take a few minutes>
0044 %
0045 %  see also makesimulation, makeocp, makeintegrators, makemex
0046 %
0047 %  Licence:
0048 %    This file is part of ACADO Toolkit  - (http://www.acadotoolkit.org/)
0049 %
0050 %    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
0051 %    Copyright (C) 2008-2009 by Boris Houska and Hans Joachim Ferreau, K.U.Leuven.
0052 %    Developed within the Optimization in Engineering Center (OPTEC) under
0053 %    supervision of Moritz Diehl. All rights reserved.
0054 %
0055 %    ACADO Toolkit is free software; you can redistribute it and/or
0056 %    modify it under the terms of the GNU Lesser General Public
0057 %    License as published by the Free Software Foundation; either
0058 %    version 3 of the License, or (at your option) any later version.
0059 %
0060 %    ACADO Toolkit is distributed in the hope that it will be useful,
0061 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
0062 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0063 %    Lesser General Public License for more details.
0064 %
0065 %    You should have received a copy of the GNU Lesser General Public
0066 %    License along with ACADO Toolkit; if not, write to the Free Software
0067 %    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0068 %
0069 %    \author David Ariens
0070 %    \date 2009
0071 %
0072 
0073 if verLessThan('matlab', '7.6.0')
0074     fprintf('\n--------------------------------------------------------\nWARNING: You are using a non supported Matlab version.\n-------------------------------------------------------- \n\nThe optimization interface (OCP, MPC, parameter estimation...) \nonly supports R2008a or newer. \nThe integrators can be ran on earlier versions. \nUse makeintegrators instead.\n\n');
0075     error('Stopping make...');
0076 end
0077 
0078     
0079 if (nargin ~= 0)
0080     makehelper(0, {}, varargin);
0081 else
0082     makehelper(0, {});
0083 end
0084 
0085 end

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