sparse_solver.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_SPARSE_SOLVER_HPP
00034 #define ACADO_TOOLKIT_SPARSE_SOLVER_HPP
00035 
00036 
00037 #include <acado/utils/acado_utils.hpp>
00038 
00039 
00040 BEGIN_NAMESPACE_ACADO
00041 
00042 
00066 class SparseSolver{
00067 
00068 
00069     //
00070     // PUBLIC MEMBER FUNCTIONS:
00071     //
00072     public:
00073 
00075         SparseSolver( );
00076 
00078         virtual ~SparseSolver( );
00079 
00081         virtual SparseSolver* clone() const = 0;
00082 
00083 
00088         virtual returnValue setDimension( const int &n ) = 0;
00089 
00090 
00096         virtual returnValue setNumberOfEntries( const int &nDense_ ) = 0;
00097 
00098 
00099 
00103         virtual returnValue setIndices( const int *rowIdx_,
00104                                         const int *colIdx_  ) = 0;
00105 
00106 
00107 
00112         virtual returnValue setMatrix( double *A_ ) = 0;
00113 
00114 
00115 
00121         virtual returnValue solve( double *b ) = 0;
00122 
00123 
00129         virtual returnValue solveTranspose( double *b );
00130 
00131 
00136         virtual returnValue getX( double *x ) = 0;
00137 
00138 
00139 
00150         virtual returnValue setTolerance( double TOL ) = 0;
00151 
00152 
00157         virtual returnValue setPrintLevel( PrintLevel PrintLevel_ ) = 0;
00158 
00159 
00160 
00161 
00162     //
00163     // PROTECTED MEMBER FUNCTIONS:
00164     //
00165     protected:
00166 
00167 
00168 
00169     //
00170     // DATA MEMBERS:
00171     //
00172     protected:
00173 
00174 
00175 };
00176 
00177 
00178 CLOSE_NAMESPACE_ACADO
00179 
00180 #include <acado/sparse_solver/sparse_solver.ipp>
00181 
00182 #endif  // ACADO_TOOLKIT_SPARSE_SOLVER_HPP
00183 
00184 #include <acado/sparse_solver/conjugate_gradient_method.hpp>
00185 #include <acado/sparse_solver/normal_conjugate_gradient_method.hpp>
00186 #include <acado/sparse_solver/symmetric_conjugate_gradient_method.hpp>
00187 
00188 /*
00189  *   end of file
00190  */
00191 


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:39:18