nolinesearch.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_NOLINESEARCH_H
#define PRIMATOLOGIST_OPTIMIZATION_NOLINESEARCH_H

#include <primatologist/math/matrix.h>
#include <cartobase/config/verbose.h>

namespace aims {

  //==========================================================================
  //   NO LINE SEARCH UTILITY
  //==========================================================================
  template <typename O>
  class NoLineSearch
  {
  public:
    //------------------------------------------------------------------------
    //   TYPEDEFS
    //------------------------------------------------------------------------
    typedef O              Objective;
    typedef math::Matrix   Matrix;
    typedef math::Vector   Vector;

    //------------------------------------------------------------------------
    //   CONSTRUCTOR / DESTRUCTOR / COPY
    //------------------------------------------------------------------------
    NoLineSearch( const Objective & f = Objective() ):
      _f(f), _x(), _p()
    {}
    NoLineSearch( const NoLineSearch<O> & other ):
      _f(other._f), _x(other._x), _p(other._p)
    {}
    ~NoLineSearch()
    {}
    NoLineSearch & operator= ( const NoLineSearch<O> & other )
    {
      if( this != & other )
      {
        _f = other._f;
        _x = other._x;
        _p = other._p;
        _maximize = other._maximize;
        _verbose = other._verbose;
      }
      return *this;
    }

    //------------------------------------------------------------------------
    //   SET PARAMETERS
    //------------------------------------------------------------------------
    void setObjectiveFunction( const Objective & f ) { _f = f; }
    void setPosition( const Vector & x = Vector() ) { _x = x; }
    void setSearchDirection( const Vector & p = Vector() ) { _p = p; }
    void setMaximize( bool maximize = false ) { _maximize = maximize; }
    void setVerbose( int v = carto::verbose ) { _verbose = v; }

    //------------------------------------------------------------------------
    //   GET PARAMETERS
    //------------------------------------------------------------------------
    const Objective & objectiveFunction() const { return _f; }
    const Vector & position() const { return _x; }
    const Vector & searchDirection() const { return _p; }
    bool maximize() const { return _maximize(); }
    int verbose() const { return _verbose; }

    //------------------------------------------------------------------------
    //   EXECUTE
    //------------------------------------------------------------------------
    Vector execute() { return _x + _p; }

  protected:
    Objective _f;
    Vector _x;
    Vector _p;
    bool _maximize;
    int _verbose;
  };


} // namespace aims

#endif // PRIMATOLOGIST_OPTIMIZATION_NOLINESEARCH_H