gaussian_elimination_export.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_GAUSS_ELIM_HPP
#define ACADO_TOOLKIT_EXPORT_GAUSS_ELIM_HPP

#include <acado/code_generation/linear_solvers/linear_solver_export.hpp>


BEGIN_NAMESPACE_ACADO


class ExportGaussElim : public ExportLinearSolver
{
    //
    // PUBLIC MEMBER FUNCTIONS:
    //
    public:

        ExportGaussElim(        UserInteraction* _userInteraction = 0,
                                                        const std::string& _commonHeaderName = ""
                                                        );

        virtual ~ExportGaussElim( );


                virtual returnValue setup( );


                virtual returnValue getDataDeclarations(        ExportStatementBlock& declarations,
                                                                                                        ExportStruct dataStruct = ACADO_ANY
                                                                                                        ) const;


                virtual returnValue getFunctionDeclarations(    ExportStatementBlock& declarations
                                                                                                                ) const;


                virtual returnValue getCode(    ExportStatementBlock& code
                                                                                );


                returnValue appendVariableNames( std::stringstream& string );


                virtual ExportVariable getGlobalExportVariable( const uint factor ) const;


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

                virtual returnValue setupSolveUpperTriangular( ExportFunction& _solveTriangular );

                virtual returnValue setupSolve( ExportFunction& _solve, ExportFunction& _solveTriangular, ExportVariable& _swap, ExportVariable& _determinant, const std::string& absF );

                virtual returnValue setupFactorization( ExportFunction& _solve, ExportVariable& _swap, ExportVariable& _determinant, const std::string& absF );

                virtual returnValue setupSolveReuse(    ExportFunction& _solveReuse, ExportFunction& _solveTriangular, ExportVariable& _bPerm );

                virtual returnValue setupSolveReuseComplete(    ExportFunction& _solveReuse, ExportVariable& _bPerm );

                virtual returnValue setupSolveReuseTranspose(   ExportFunction& _solveReuse, ExportVariable& _bPerm );


    protected:
                
                // DEFINITION OF THE EXPORTVARIABLES
                ExportVariable rk_swap;                                         
                ExportVariable rk_bPerm;                                        
                ExportVariable rk_perm;                                         
                ExportVariable rk_bPerm_trans;                          
                ExportVariable b_trans;                                         
};


CLOSE_NAMESPACE_ACADO


#endif  // ACADO_TOOLKIT_EXPORT_GAUSS_ELIM_HPP

// end of file.