primatologist-gpl 6.0.4
Public Types | Public Member Functions | Protected Attributes | List of all members
aims::NoLineSearch< O > Class Template Reference

Object used by classes that can take a line search tool as template argument but need a default object when no line search is needed. More...

#include <primatologist/optimization/nolinesearch.h>

Collaboration diagram for aims::NoLineSearch< O >:
Collaboration graph
[legend]

Public Types

typedef O Objective
 
typedef math::Matrix Matrix
 
typedef math::Vector Vector
 

Public Member Functions

 NoLineSearch (const Objective &f=Objective())
 
 NoLineSearch (const NoLineSearch< O > &other)
 
 ~NoLineSearch ()
 
NoLineSearch & operator= (const NoLineSearch< O > &other)
 
void setObjectiveFunction (const Objective &f)
 
void setPosition (const Vector &x=Vector())
 
void setSearchDirection (const Vector &p=Vector())
 
void setMaximize (bool maximize=false)
 
void setVerbose (int v=carto::verbose)
 
const Objective & objectiveFunction () const
 
const Vector & position () const
 
const Vector & searchDirection () const
 
bool maximize () const
 
int verbose () const
 
Vector execute ()
 

Protected Attributes

Objective _f
 
Vector _x
 
Vector _p
 
bool _maximize
 
int _verbose
 

Detailed Description

template<typename O>
class aims::NoLineSearch< O >

Object used by classes that can take a line search tool as template argument but need a default object when no line search is needed.

Definition at line 25 of file nolinesearch.h.

Member Typedef Documentation

◆ Matrix

template<typename O>
typedef math::Matrix aims::NoLineSearch< O >::Matrix

Definition at line 32 of file nolinesearch.h.

◆ Objective

template<typename O>
typedef O aims::NoLineSearch< O >::Objective

Definition at line 31 of file nolinesearch.h.

◆ Vector

template<typename O>
typedef math::Vector aims::NoLineSearch< O >::Vector

Definition at line 33 of file nolinesearch.h.

Constructor & Destructor Documentation

◆ NoLineSearch() [1/2]

template<typename O>
aims::NoLineSearch< O >::NoLineSearch ( const Objective & f = Objective())
inline

Definition at line 38 of file nolinesearch.h.

References _f, _p, and _x.

Referenced by NoLineSearch(), and operator=().

◆ NoLineSearch() [2/2]

template<typename O>
aims::NoLineSearch< O >::NoLineSearch ( const NoLineSearch< O > & other)
inline

Definition at line 41 of file nolinesearch.h.

References _f, _p, _x, and NoLineSearch().

◆ ~NoLineSearch()

template<typename O>
aims::NoLineSearch< O >::~NoLineSearch ( )
inline

Definition at line 44 of file nolinesearch.h.

Member Function Documentation

◆ execute()

template<typename O>
Vector aims::NoLineSearch< O >::execute ( )
inline

Definition at line 80 of file nolinesearch.h.

References _p, and _x.

◆ maximize()

template<typename O>
bool aims::NoLineSearch< O >::maximize ( ) const
inline

Definition at line 74 of file nolinesearch.h.

References _maximize.

Referenced by setMaximize().

◆ objectiveFunction()

template<typename O>
const Objective & aims::NoLineSearch< O >::objectiveFunction ( ) const
inline

Definition at line 71 of file nolinesearch.h.

References _f.

◆ operator=()

template<typename O>
NoLineSearch & aims::NoLineSearch< O >::operator= ( const NoLineSearch< O > & other)
inline

Definition at line 46 of file nolinesearch.h.

References _f, _maximize, _p, _verbose, _x, and NoLineSearch().

◆ position()

template<typename O>
const Vector & aims::NoLineSearch< O >::position ( ) const
inline

Definition at line 72 of file nolinesearch.h.

References _x.

◆ searchDirection()

template<typename O>
const Vector & aims::NoLineSearch< O >::searchDirection ( ) const
inline

Definition at line 73 of file nolinesearch.h.

References _p.

◆ setMaximize()

template<typename O>
void aims::NoLineSearch< O >::setMaximize ( bool maximize = false)
inline

Definition at line 65 of file nolinesearch.h.

References _maximize, and maximize().

◆ setObjectiveFunction()

template<typename O>
void aims::NoLineSearch< O >::setObjectiveFunction ( const Objective & f)
inline

Definition at line 62 of file nolinesearch.h.

References _f.

◆ setPosition()

template<typename O>
void aims::NoLineSearch< O >::setPosition ( const Vector & x = Vector())
inline

Definition at line 63 of file nolinesearch.h.

References _x.

◆ setSearchDirection()

template<typename O>
void aims::NoLineSearch< O >::setSearchDirection ( const Vector & p = Vector())
inline

Definition at line 64 of file nolinesearch.h.

References _p.

◆ setVerbose()

template<typename O>
void aims::NoLineSearch< O >::setVerbose ( int v = carto::verbose)
inline

Definition at line 66 of file nolinesearch.h.

References _verbose.

◆ verbose()

template<typename O>
int aims::NoLineSearch< O >::verbose ( ) const
inline

Definition at line 75 of file nolinesearch.h.

References _verbose.

Member Data Documentation

◆ _f

template<typename O>
Objective aims::NoLineSearch< O >::_f
protected

Definition at line 83 of file nolinesearch.h.

Referenced by NoLineSearch(), NoLineSearch(), objectiveFunction(), operator=(), and setObjectiveFunction().

◆ _maximize

template<typename O>
bool aims::NoLineSearch< O >::_maximize
protected

Definition at line 86 of file nolinesearch.h.

Referenced by maximize(), operator=(), and setMaximize().

◆ _p

template<typename O>
Vector aims::NoLineSearch< O >::_p
protected

Definition at line 85 of file nolinesearch.h.

Referenced by execute(), NoLineSearch(), NoLineSearch(), operator=(), searchDirection(), and setSearchDirection().

◆ _verbose

template<typename O>
int aims::NoLineSearch< O >::_verbose
protected

Definition at line 87 of file nolinesearch.h.

Referenced by operator=(), setVerbose(), and verbose().

◆ _x

template<typename O>
Vector aims::NoLineSearch< O >::_x
protected

Definition at line 84 of file nolinesearch.h.

Referenced by execute(), NoLineSearch(), NoLineSearch(), operator=(), position(), and setPosition().

The documentation for this class was generated from the following file: