normal_conjugate_gradient_method.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_NORMAL_CONJUGATE_GRADIENT_METHOD_HPP
#define ACADO_TOOLKIT_NORMAL_CONJUGATE_GRADIENT_METHOD_HPP


#include <acado/utils/acado_utils.hpp>


BEGIN_NAMESPACE_ACADO


class NormalConjugateGradientMethod : public ConjugateGradientMethod{


    //
    // PUBLIC MEMBER FUNCTIONS:
    //
    public:


        NormalConjugateGradientMethod( );

        NormalConjugateGradientMethod( const NormalConjugateGradientMethod &arg );

        virtual ~NormalConjugateGradientMethod( );

        virtual SparseSolver* clone() const;


        virtual returnValue setIndices( const int *rowIdx_,
                                        const int *colIdx_  );


        virtual returnValue setIndices( const int *indices_ );



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


    virtual void multiply( double *xx , double *result );


    virtual returnValue computePreconditioner( double* A_ );

    virtual returnValue applyPreconditioner( double *b );


    virtual returnValue applyInversePreconditioner( double *x_ );


    //
    // DATA MEMBERS:
    //
    protected:

        int     **index;
        int     *nIndex;

        double *iResult;
};


CLOSE_NAMESPACE_ACADO



#include <acado/sparse_solver/normal_conjugate_gradient_method.ipp>


#endif  // ACADO_TOOLKIT_NORMAL_CONJUGATE_GRADIENT_METHOD_HPP

/*
 *   end of file
 */