export_cholesky_solver.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_CHOLESKY_SOLVER_HPP
#define ACADO_TOOLKIT_EXPORT_CHOLESKY_SOLVER_HPP

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

BEGIN_NAMESPACE_ACADO

class ExportCholeskySolver : public ExportLinearSolver
{
public:

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

        virtual ~ExportCholeskySolver( );

        returnValue init(       unsigned _dimA,
                                                unsigned _numColsB,
                                                const std::string& _id
                                                );

        virtual returnValue setup( );

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

        virtual returnValue getFunctionDeclarations(    ExportStatementBlock& declarations
                                                                                                        ) const;

        virtual returnValue getCode(    ExportStatementBlock& code
                                                                        );

        virtual returnValue appendVariableNames( std::stringstream& string );

        const ExportFunction& getCholeskyFunction() const;

        const ExportFunction& getSolveFunction() const;

private:

        ExportFunction chol;

        ExportVariable B;

        unsigned nColsB;
};

CLOSE_NAMESPACE_ACADO

#endif  // ACADO_TOOLKIT_EXPORT_CHOLESKY_SOLVER_HPP