gradient_decl.h

Go to the documentation of this file.

/* Copyright (C) 2000-2013 CEA
 *
 * This software and supporting documentation were developed by
 *     bioPICSEL
 *     CEA/DSV/I²BM/MIRCen/LMN, Batiment 61,
 *     18, route du Panorama
 *     92265 Fontenay-aux-Roses
 *     France
 */

#ifndef PRIMATOLOGIST_OPTIMIZATION_GRADIENT_DECL_H
#define PRIMATOLOGIST_OPTIMIZATION_GRADIENT_DECL_H

#include <primatologist/math/matrix.h>               // aims::math::Matrix
#include <primatologist/optimization/nolinesearch.h> // aims::NoLineSearch
#include <cartobase/config/verbose.h>                // carto::verbose

namespace aims {


  //==========================================================================
  //    GRADIEN DESCENT
  //==========================================================================
  template <typename O, template <typename> class L = NoLineSearch >
  class GradientDescent
  {
  public:
    //------------------------------------------------------------------------
    //   TYPEDEFS
    //------------------------------------------------------------------------
    typedef O              Objective;
    typedef L<O>           LineSearch;
    typedef math::Matrix   Matrix;
    typedef math::Vector   Vector;

    //------------------------------------------------------------------------
    //   CONSTRUCTOR / DESTRUCTOR / COPY
    //------------------------------------------------------------------------
    GradientDescent( const Objective & f = Objective(),
                     const Vector & x = Vector() );
    GradientDescent( const GradientDescent<O,L> & other );
    ~GradientDescent();
    GradientDescent<O,L> & operator=( const GradientDescent<O,L> & other );

    //------------------------------------------------------------------------
    //   SET PARAMETERS
    //------------------------------------------------------------------------
    // Intrinsic parameters
    void setGamma( float gamma = 0.1 );
    void setStopCriterion( const std::string & crit = "absdiff" );
    void setStopValue( float epsilon = 1E-5 );
    void setLineSearch( const LineSearch & l = LineSearch() );
    void setMaximize( bool maximize = false );
    void setMaxIterations( int n = - 1 );
    void setVerbose( int v = carto::verbose );
    // Search parameters
    void setObjectiveFunction( const Objective & f );
    void setPosition( const Vector & x = Vector() );

    //------------------------------------------------------------------------
    //   GET PARAMETERS
    //------------------------------------------------------------------------
    // Intrinsic parameters
    float gamma() const;
    const std::string & stopCriterion() const;
    float stopValue() const;
    LineSearch & lineSearch();
    bool maximize() const;
    int maxIterations() const;
    int verbose() const;
    // Search parameters
    const Vector & position() const;
    const Objective & objectiveFunction() const;

    //------------------------------------------------------------------------
    //   EXECUTE
    //------------------------------------------------------------------------
    Vector execute();

  protected:
    //------------------------------------------------------------------------
    //   PARAMETERS
    //------------------------------------------------------------------------
    float _gamma;         
    Vector _x;            
    Objective _f;         
    LineSearch _ls;       
    int _verbose;         
    bool _maximize;       
    int _max_it;          
    std::string _crit;    
    float _epsilon;       
  };

} // namespace aims

#endif // PRIMATOLOGIST_OPTIMIZATION_GRADIENT_DECL_H