export_for_loop.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_FOR_LOOP_HPP
#define ACADO_TOOLKIT_EXPORT_FOR_LOOP_HPP


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


BEGIN_NAMESPACE_ACADO


class ExportForLoop : public ExportStatementBlock
{
        //
        // PUBLIC MEMBER FUNCTIONS:
        //
        public:

                ExportForLoop(  const ExportIndex& _loopVariable = emptyConstExportIndex,
                                                const ExportIndex& _startValue = emptyConstExportIndex,
                                                const ExportIndex& _finalValue = emptyConstExportIndex,
                                                const ExportIndex& _increment = constExportIndexValueOne,
                                                bool _doLoopUnrolling = false
                                                );

                ExportForLoop(  const ExportForLoop& arg
                                                );

                virtual ~ExportForLoop( );

                ExportForLoop& operator=(       const ExportForLoop& arg
                                                                        );

                virtual ExportStatement* clone( ) const;

                returnValue init(       const ExportIndex& _loopVariable,
                                                        const ExportIndex& _startValue,
                                                        const ExportIndex& _finalValue,
                                                        const ExportIndex& _increment,
                                                        bool _doLoopUnrolling
                                                        );


                virtual returnValue exportDataDeclaration(      std::ostream& stream,
                                                                                                        const std::string& _realString = "real_t",
                                                                                                        const std::string& _intString = "int",
                                                                                                        int _precision = 16
                                                                                                        ) const;

                virtual returnValue exportCode( std::ostream& stream,
                                                                                const std::string& _realString = "real_t",
                                                                                const std::string& _intString = "int",
                                                                                int _precision = 16
                                                                                ) const;


                ExportForLoop& unrollLoop( );

                ExportForLoop& keepLoop( );

                ExportForLoop& allocate(MemoryAllocatorPtr allocator);


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

                returnValue clear( );

        private:

                returnValue sanityCheck( void ) const;

        //
        // DATA MEMBERS:
        //
        protected:

                ExportIndex loopVariable;               
                ExportIndex startValue;                 
                ExportIndex finalValue;                 
                ExportIndex increment;                  
                bool doLoopUnrolling;   
};


CLOSE_NAMESPACE_ACADO



#endif  // ACADO_TOOLKIT_EXPORT_FOR_LOOP_HPP


/*
 *      end of file
 */