matrix_variable.hpp
Go to the documentation of this file.
00001 /*
00002  *    This file is part of ACADO Toolkit.
00003  *
00004  *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
00005  *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
00006  *    Milan Vukov, Rien Quirynen, KU Leuven.
00007  *    Developed within the Optimization in Engineering Center (OPTEC)
00008  *    under supervision of Moritz Diehl. All rights reserved.
00009  *
00010  *    ACADO Toolkit is free software; you can redistribute it and/or
00011  *    modify it under the terms of the GNU Lesser General Public
00012  *    License as published by the Free Software Foundation; either
00013  *    version 3 of the License, or (at your option) any later version.
00014  *
00015  *    ACADO Toolkit is distributed in the hope that it will be useful,
00016  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
00017  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018  *    Lesser General Public License for more details.
00019  *
00020  *    You should have received a copy of the GNU Lesser General Public
00021  *    License along with ACADO Toolkit; if not, write to the Free Software
00022  *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00023  *
00024  */
00025 
00026 
00033 #ifndef ACADO_TOOLKIT_MATRIX_VARIABLE_HPP
00034 #define ACADO_TOOLKIT_MATRIX_VARIABLE_HPP
00035 
00036 
00037 #include <acado/variables_grid/variable_settings.hpp>
00038 #include <acado/matrix_vector/matrix_vector.hpp>
00039 
00040 
00041 BEGIN_NAMESPACE_ACADO
00042 
00043 
00044 
00055 class MatrixVariable : public DMatrix, public VariableSettings
00056 {
00057     //
00058     // PUBLIC MEMBER FUNCTIONS:
00059     //
00060     public:
00063         MatrixVariable( );
00064 
00078                 MatrixVariable( uint _nRows,
00079                                                 uint _nCols,
00080                                                 VariableType _type = VT_UNKNOWN,
00081                                                 const char** const _names = 0,
00082                                                 const char** const _units = 0,
00083                                                 DVector _scaling = emptyVector,
00084                                                 DVector _lb = emptyVector,
00085                                                 DVector _ub = emptyVector,
00086                                                 BooleanType _autoInit = defaultAutoInit
00087                                                 );
00088 
00093                 MatrixVariable( const MatrixVariable& rhs
00094                                                 );
00095 
00101         MatrixVariable( const DMatrix& _matrix,
00102                                                 VariableType _type = VT_UNKNOWN
00103                                                 );
00104 
00107         ~MatrixVariable( );
00108 
00113         MatrixVariable& operator=(      const MatrixVariable& rhs
00114                                                                         );
00115 
00120         MatrixVariable& operator=(      const DMatrix& rhs
00121                                                                         );
00122 
00123 
00140                 returnValue init(       uint _nRows,
00141                                                         uint _nCols,
00142                                                         VariableType _type = VT_UNKNOWN,
00143                                                         const char** const _names = 0,
00144                                                         const char** const _units = 0,
00145                                                         DVector _scaling = emptyVector,
00146                                                         DVector _lb = emptyVector,
00147                                                         DVector _ub = emptyVector,
00148                                                         BooleanType _autoInit = defaultAutoInit
00149                                                         );
00150 
00151 
00156                 inline DMatrix getMatrix( ) const;
00157 
00158 
00169                 MatrixVariable getRows( uint startIdx,
00170                                                                 uint endIdx
00171                                                                 ) const;
00172 
00183                 MatrixVariable getCols( uint startIdx,
00184                                                                 uint endIdx
00185                                                                 ) const;
00186 
00187 
00188     //
00189     // PROTECTED MEMBER FUNCTIONS:
00190     //
00191     protected:
00192 
00193 
00194     //
00195     // DATA MEMBERS:
00196     //
00197     protected:
00198 
00199 };
00200 
00201 
00202 CLOSE_NAMESPACE_ACADO
00203 
00204 
00205 
00206 #include <acado/variables_grid/matrix_variable.ipp>
00207 
00208 
00209 #endif  // ACADO_TOOLKIT_MATRIX_VARIABLE_HPP
00210 
00211 /*
00212  *      end of file
00213  */


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Thu Aug 27 2015 11:59:10