symmetric_conjugate_gradient_method.hpp
Go to the documentation of this file.
1 /*
2  * This file is part of ACADO Toolkit.
3  *
4  * ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
5  * Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
6  * Milan Vukov, Rien Quirynen, KU Leuven.
7  * Developed within the Optimization in Engineering Center (OPTEC)
8  * under supervision of Moritz Diehl. All rights reserved.
9  *
10  * ACADO Toolkit is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 3 of the License, or (at your option) any later version.
14  *
15  * ACADO Toolkit is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with ACADO Toolkit; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 
26 
34 #ifndef ACADO_TOOLKIT_SYMMETRIC_CONJUGATE_GRADIENT_METHOD_HPP
35 #define ACADO_TOOLKIT_SYMMETRIC_CONJUGATE_GRADIENT_METHOD_HPP
36 
37 
39 
40 
42 
43 
62 
63 
64  //
65  // PUBLIC MEMBER FUNCTIONS:
66  //
67  public:
68 
69 
72 
75 
78 
80  virtual SparseSolver* clone() const;
81 
82 
86  virtual returnValue setIndices( const int *rowIdx_,
87  const int *colIdx_ );
88 
89 
90 
94  virtual returnValue setIndices( const int *indices_ );
95 
96 
97  //
98  // PROTECTED MEMBER FUNCTIONS:
99  //
100  protected:
101 
102 
103 
105  virtual void multiply( double *xx , double *result );
106 
107 
109  virtual returnValue computePreconditioner( double* A_ );
110 
111 
113  virtual returnValue applyPreconditioner( double *b );
114 
116  virtual returnValue applyInversePreconditioner( double *x_ );
117 
118 
119 
120  //
121  // DATA MEMBERS:
122  //
123  protected:
124 
125 
126  int **index;
127  int *nIndex;
128  int *diag;
129 
130 };
131 
132 
134 
135 
136 
137 #include <acado/sparse_solver/symmetric_conjugate_gradient_method.ipp>
138 
139 
140 #endif // ACADO_TOOLKIT_SYMMETRIC_CONJUGATE_GRADIENT_METHOD_HPP
141 
142 /*
143  * end of file
144  */
145 
virtual returnValue applyInversePreconditioner(double *x_)
Allows to pass back messages to the calling function.
virtual returnValue setIndices(const int *rowIdx_, const int *colIdx_)
#define CLOSE_NAMESPACE_ACADO
Implements a conjugate gradient method as sparse linear algebra solver for symmetric linear systems...
virtual void multiply(double *xx, double *result)
Implements a conjugate gradient method as sparse linear algebra solver.
Generic interface for sparse solvers to be coupled with ACADO Toolkit.
#define BEGIN_NAMESPACE_ACADO


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:12