export_variable_internal.hpp

Go to the documentation of this file.

/*
 *    This file is part of ACADO Toolkit.
 *
 *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
 *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
 *    Milan Vukov, Rien Quirynen, KU 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
 *
 */



#ifndef ACADO_TOOLKIT_EXPORT_VARIABLE_INTERNAL_HPP
#define ACADO_TOOLKIT_EXPORT_VARIABLE_INTERNAL_HPP

#include <acado/utils/acado_utils.hpp>
#include <acado/code_generation/export_argument_internal.hpp>
#include <acado/code_generation/export_index.hpp>


BEGIN_NAMESPACE_ACADO


class ExportArithmeticStatement;


class ExportVariableInternal : public ExportArgumentInternal
{
        //
    // PUBLIC MEMBER FUNCTIONS:
    //
    public:

        ExportVariableInternal( );

                ExportVariableInternal( const std::string& _name,
                                                                const DMatrixPtr& _data,
                                                                ExportType _type = REAL,
                                                                ExportStruct _dataStruct = ACADO_LOCAL,
                                                                bool _callItByValue = false,
                                                                const std::string& _prefix = std::string()
                                                                );

                virtual ~ExportVariableInternal( );

                virtual ExportVariableInternal* clone() const;

                bool isZero( const ExportIndex& rowIdx,
                                                        const ExportIndex& colIdx
                                                        ) const;

                bool isOne(     const ExportIndex& rowIdx,
                                                        const ExportIndex& colIdx
                                                        ) const;

                bool isGiven(   const ExportIndex& rowIdx,
                                                                const ExportIndex& colIdx
                                                                ) const;

                virtual bool isGiven() const;


                const std::string get(  const ExportIndex& rowIdx,
                                                        const ExportIndex& colIdx
                                                        ) const;

                virtual uint getNumRows( ) const;

                virtual uint getNumCols( ) const;

                virtual uint getDim( ) const;

                ExportVariable getTranspose( ) const;

                ExportVariable getRow(  const ExportIndex& idx
                                                                ) const;

                ExportVariable getCol(  const ExportIndex& idx
                                                                ) const;

                ExportVariable getRows( const ExportIndex& idx1,
                                                                const ExportIndex& idx2
                                                                ) const;

                ExportVariable getCols( const ExportIndex& idx1,
                                                                const ExportIndex& idx2
                                                                ) const;

                ExportVariable getSubMatrix(    const ExportIndex& _rowIdx1,
                                                                                const ExportIndex& _rowIdx2,
                                                                                const ExportIndex& _colIdx1,
                                                                                const ExportIndex& _colIdx2
                                                                                ) const;


                ExportVariable makeRowVector( ) const;

                ExportVariable makeColVector( ) const;


                bool isVector( ) const;


                const DMatrix& getGivenMatrix( ) const;


                returnValue print( ) const;

                bool isSubMatrix() const;

                bool isDiagonal() const;

        //
    // PROTECTED MEMBER FUNCTIONS:
    //
    protected:

                virtual uint getColDim( ) const;

                virtual ExportIndex     getTotalIdx(    const ExportIndex& rowIdx,
                                                                                        const ExportIndex& colIdx
                                                                                        ) const;

                returnValue setSubmatrixOffsets(        const ExportIndex& _rowOffset,
                                                                                        const ExportIndex& _colOffset,
                                                                                        unsigned _rowDim = 0,
                                                                                        unsigned _colDim = 0,
                                                                                        unsigned _nRows = 0,
                                                                                        unsigned _nCols = 0
                                                                                        );


                bool hasValue(  const ExportIndex& _rowIdx,
                                                const ExportIndex& _colIdx,
                                                double _value
                                                ) const;

        protected:

                bool doAccessTransposed;                                
                ExportIndex rowOffset;                                          
                ExportIndex colOffset;                                          
                unsigned rowDim;                                                        
                unsigned colDim;                                                        
                unsigned nRows;                                                         
                unsigned nCols;                                                         
};

CLOSE_NAMESPACE_ACADO


#endif  // ACADO_TOOLKIT_EXPORT_VARIABLE_INTERNAL_HPP

// end of file.