objective_element.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_OBJECTIVE_ELEMENT_HPP
#define ACADO_TOOLKIT_OBJECTIVE_ELEMENT_HPP


#include <acado/variables_grid/variables_grid.hpp>
#include <acado/function/function.hpp>

BEGIN_NAMESPACE_ACADO


class ObjectiveElement{


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

        ObjectiveElement( );

        ObjectiveElement( const Grid &grid_ );

        ObjectiveElement( const ObjectiveElement& rhs );

        virtual ~ObjectiveElement( );

        ObjectiveElement& operator=( const ObjectiveElement& rhs );





// ==========================================================================
//
//                               INITIALIZATION
//
// ==========================================================================


        inline returnValue setGrid( const Grid &grid_ );



        returnValue init( const OCPiterate &x );



// =======================================================================================
//
//                                  DEFINITION OF SEEDS:
//
// =======================================================================================



    virtual returnValue setForwardSeed( BlockMatrix *xSeed_ ,   
                                        BlockMatrix *xaSeed_,   
                                        BlockMatrix *pSeed_ ,   
                                        BlockMatrix *uSeed_ ,   
                                        BlockMatrix *wSeed_ ,   
                                        int          order       );



    virtual returnValue setBackwardSeed( BlockMatrix *seed,    
                                         int          order      );




// =======================================================================================
//
//                               RESULTS OF THE EVALUATION
//
// =======================================================================================


    virtual returnValue getObjectiveValue( double &objectiveValue   );



    virtual returnValue getForwardSensitivities( BlockMatrix *D  ,
                                                 int order         );



    virtual returnValue getBackwardSensitivities( BlockMatrix *D  ,
                                                  int order         );




// =======================================================================================
//
//                                     DIMENSIONS
//
// =======================================================================================


        inline int getNX    () const;

        inline int getNXA   () const;

        inline int getNP   () const;

        inline int getNU   () const;

        inline int getNW  () const;

        returnValue getFunction( Function& _function );



// ==========================================================================
//
//                          PROTECTED MEMBER FUNCTIONS:
//
// ==========================================================================

    protected:


        inline Grid getGrid() const;


    //
    // DATA MEMBERS:
    //
    protected:

        Grid             grid   ;   
        Function         fcn    ;   
        EvaluationPoint  z      ;   
        EvaluationPoint  JJ     ;

        int             *y_index;   
        int              t_index;   
        int              nx     ;   
        int              na     ;   
        int              nu     ;   
        int              np     ;   
        int              nw     ;   
        int              ny     ;   
        // INPUT STORAGE:
        // ------------------------
        BlockMatrix      *xSeed   ;   
        BlockMatrix      *xaSeed  ;   
        BlockMatrix      *pSeed   ;   
        BlockMatrix      *uSeed   ;   
        BlockMatrix      *wSeed   ;   
        BlockMatrix      *bSeed   ;   
        BlockMatrix      *xSeed2  ;   
        BlockMatrix      *xaSeed2 ;   
        BlockMatrix      *pSeed2  ;   
        BlockMatrix      *uSeed2  ;   
        BlockMatrix      *wSeed2  ;   
        BlockMatrix      *bSeed2  ;   
        // RESULTS:
        // ------------------------
        double                 obj;   
        BlockMatrix      dForward ;   
        BlockMatrix      dBackward;   
};


CLOSE_NAMESPACE_ACADO



#include <acado/objective/objective_element.ipp>


#endif  // ACADO_TOOLKIT_OBJECTIVE_ELEMENT_HPP

/*
 *     end of file
 */