standard implementation of the line search based on the "sufficient descent" More...

#include <line_search.h>

Inheritance diagram for ug::StandardLineSearch< TVector >:

Public Types
typedef TVector	vector_type

Public Types inherited from ug::ILineSearch< TVector >
typedef TVector	vector_type

Public Member Functions
virtual std::string	config_string () const
	returns information about configuration parameters

virtual bool	createNewtonUpdater ()

virtual bool	search (SmartPtr< IOperator< vector_type > > spOp, vector_type &u, vector_type &p, vector_type &d, number defect)

void	set_accept_best (bool bAcceptBest)
	sets iff after max_steps the best try is used

void	set_check_all (bool bCheckAll)
	sets iff all the max_steps line search steps must be tested even if the sufficient descent is achieved

void	set_lambda_start (number start)
	sets start factor

void	set_maximum_defect (number maxDef)
	sets maximum allowed norm of the defect (an exception is thrown if this value if exceeded)

void	set_maximum_steps (int steps)
	sets maximum number of line search steps

virtual void	set_offset (std::string offset)
	set string to be printed before each output of line search

void	set_reduce_factor (number factor)
	sets factor by which line search factor is multiplied in each step

void	set_suff_descent_factor (number factor)
	sets the factor controlling the sufficient descent

void	set_verbose (bool level)
	sets if info should be printed

virtual void	setNewtonUpdater (SmartPtr< NewtonUpdaterGeneric< TVector > > nU)

	StandardLineSearch ()
	default constructor (setting default values)

	StandardLineSearch (int maxSteps, number lambdaStart, number lambdaReduce, bool bAcceptBest)
	constructor

	StandardLineSearch (int maxSteps, number lambdaStart, number lambdaReduce, bool bAcceptBest, bool bCheckAll)
	constructor

Public Member Functions inherited from ug::ILineSearch< TVector >
virtual	~ILineSearch ()
	virtual destructor

Protected Attributes
number	m_alpha
	sufficient descent factor

bool	m_bAcceptBest
	accept best

bool	m_bCheckAll
	check all

number	m_lambdaReduce
	reduction factor for the step length

number	m_lambdaStart
	initial step length scaling

number	m_maxDefect
	maximum allowed defect

int	m_maxSteps
	maximum number of steps to be performed

std::string	m_offset
	number of spaces inserted before output

bool	m_verbose
	verbosity level

vector_type	s
	solution in line direction

Private Attributes
SmartPtr< NewtonUpdaterGeneric< TVector > >	m_newtonUpdater

Detailed Description

template<typename TVector>
class ug::StandardLineSearch< TVector >

standard implementation of the line search based on the "sufficient descent"

Member Typedef Documentation

◆ vector_type

template<typename TVector >

typedef TVector ug::StandardLineSearch< TVector >::vector_type

Constructor & Destructor Documentation

◆ StandardLineSearch() [1/3]

template<typename TVector >

ug::StandardLineSearch< TVector >::StandardLineSearch ( )

inline

default constructor (setting default values)

◆ StandardLineSearch() [2/3]

template<typename TVector >

ug::StandardLineSearch< TVector >::StandardLineSearch	(	int	maxSteps,
		number	lambdaStart,
		number	lambdaReduce,
		bool	bAcceptBest
	)

inline

constructor

◆ StandardLineSearch() [3/3]

template<typename TVector >

ug::StandardLineSearch< TVector >::StandardLineSearch	(	int	maxSteps,
		number	lambdaStart,
		number	lambdaReduce,
		bool	bAcceptBest,
		bool	bCheckAll
	)

inline

constructor

Member Function Documentation

◆ config_string()

template<typename TVector >

virtual std::string ug::StandardLineSearch< TVector >::config_string ( ) const

inlinevirtual

returns information about configuration parameters

Implements ug::ILineSearch< TVector >.

References ug::StandardLineSearch< TVector >::m_bAcceptBest, ug::StandardLineSearch< TVector >::m_bCheckAll, ug::StandardLineSearch< TVector >::m_lambdaReduce, ug::StandardLineSearch< TVector >::m_lambdaStart, and ug::StandardLineSearch< TVector >::m_maxSteps.

◆ createNewtonUpdater()

template<typename TVector >

virtual bool ug::StandardLineSearch< TVector >::createNewtonUpdater ( )

inlinevirtual

Implements ug::ILineSearch< TVector >.

References ug::StandardLineSearch< TVector >::m_newtonUpdater, and SPNULL.

◆ search()

template<typename TVector >

virtual bool ug::StandardLineSearch< TVector >::search	(	SmartPtr< IOperator< vector_type > >	spOp,
		vector_type &	u,
		vector_type &	p,
		vector_type &	d,
		number	defect
	)

inlinevirtual

Performs a line search to a given direction.

Parameters

[in]	Op	Non-linear operator
[in]	u	current solution
[in]	p	search direction
[in,out]	d	defect
[in]	defect	norm of current defect

Returns: true if line search successful false if line search failed

Implements ug::ILineSearch< TVector >.

◆ set_accept_best()

template<typename TVector >

void ug::StandardLineSearch< TVector >::set_accept_best ( bool bAcceptBest )

inline

sets iff after max_steps the best try is used

References ug::StandardLineSearch< TVector >::m_bAcceptBest.

◆ set_check_all()

template<typename TVector >

void ug::StandardLineSearch< TVector >::set_check_all ( bool bCheckAll )

inline

sets iff all the max_steps line search steps must be tested even if the sufficient descent is achieved

References ug::StandardLineSearch< TVector >::m_bCheckAll.

◆ set_lambda_start()

template<typename TVector >

void ug::StandardLineSearch< TVector >::set_lambda_start ( number start )

inline

sets start factor

References ug::StandardLineSearch< TVector >::m_lambdaStart.

◆ set_maximum_defect()

template<typename TVector >

void ug::StandardLineSearch< TVector >::set_maximum_defect ( number maxDef )

inline

sets maximum allowed norm of the defect (an exception is thrown if this value if exceeded)

References ug::StandardLineSearch< TVector >::m_maxDefect.

◆ set_maximum_steps()

template<typename TVector >

void ug::StandardLineSearch< TVector >::set_maximum_steps ( int steps )

inline

sets maximum number of line search steps

References ug::StandardLineSearch< TVector >::m_maxSteps.

◆ set_offset()

template<typename TVector >

virtual void ug::StandardLineSearch< TVector >::set_offset ( std::string offset )

inlinevirtual

set string to be printed before each output of line search

Implements ug::ILineSearch< TVector >.

References ug::StandardLineSearch< TVector >::m_offset.

◆ set_reduce_factor()

template<typename TVector >

void ug::StandardLineSearch< TVector >::set_reduce_factor ( number factor )

inline

sets factor by which line search factor is multiplied in each step

References ug::StandardLineSearch< TVector >::m_lambdaReduce.

◆ set_suff_descent_factor()

template<typename TVector >

void ug::StandardLineSearch< TVector >::set_suff_descent_factor ( number factor )

inline

sets the factor controlling the sufficient descent

References ug::StandardLineSearch< TVector >::m_alpha.

◆ set_verbose()

template<typename TVector >

void ug::StandardLineSearch< TVector >::set_verbose ( bool level )

inline

sets if info should be printed

References ug::StandardLineSearch< TVector >::m_verbose.

◆ setNewtonUpdater()

template<typename TVector >

virtual void ug::StandardLineSearch< TVector >::setNewtonUpdater ( SmartPtr< NewtonUpdaterGeneric< TVector > > nU )

inlinevirtual

Implements ug::ILineSearch< TVector >.

References ug::StandardLineSearch< TVector >::m_newtonUpdater.

Member Data Documentation

◆ m_alpha

template<typename TVector >

number ug::StandardLineSearch< TVector >::m_alpha

protected

sufficient descent factor

Referenced by ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::set_suff_descent_factor().

◆ m_bAcceptBest

template<typename TVector >

bool ug::StandardLineSearch< TVector >::m_bAcceptBest

protected

accept best

Referenced by ug::StandardLineSearch< TVector >::config_string(), ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::set_accept_best().

◆ m_bCheckAll

template<typename TVector >

bool ug::StandardLineSearch< TVector >::m_bCheckAll

protected

check all

Referenced by ug::StandardLineSearch< TVector >::config_string(), ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::set_check_all().

◆ m_lambdaReduce

template<typename TVector >

number ug::StandardLineSearch< TVector >::m_lambdaReduce

protected

reduction factor for the step length

Referenced by ug::StandardLineSearch< TVector >::config_string(), ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::set_reduce_factor().

◆ m_lambdaStart

template<typename TVector >

number ug::StandardLineSearch< TVector >::m_lambdaStart

protected

initial step length scaling

Referenced by ug::StandardLineSearch< TVector >::config_string(), ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::set_lambda_start().

◆ m_maxDefect

template<typename TVector >

number ug::StandardLineSearch< TVector >::m_maxDefect

protected

maximum allowed defect

Referenced by ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::set_maximum_defect().

◆ m_maxSteps

template<typename TVector >

int ug::StandardLineSearch< TVector >::m_maxSteps

protected

maximum number of steps to be performed

Referenced by ug::StandardLineSearch< TVector >::config_string(), ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::set_maximum_steps().

◆ m_newtonUpdater

template<typename TVector >

SmartPtr<NewtonUpdaterGeneric<TVector> > ug::StandardLineSearch< TVector >::m_newtonUpdater

private

Referenced by ug::StandardLineSearch< TVector >::createNewtonUpdater(), ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::setNewtonUpdater().

◆ m_offset

template<typename TVector >

std::string ug::StandardLineSearch< TVector >::m_offset

protected

number of spaces inserted before output

Referenced by ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::set_offset().

◆ m_verbose

template<typename TVector >

bool ug::StandardLineSearch< TVector >::m_verbose

protected

verbosity level

Referenced by ug::StandardLineSearch< TVector >::search(), and ug::StandardLineSearch< TVector >::set_verbose().

◆ s

template<typename TVector >

vector_type ug::StandardLineSearch< TVector >::s

protected

solution in line direction

Referenced by ug::StandardLineSearch< TVector >::search().

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

ugbase/lib_disc/operator/non_linear_operator/line_search.h

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ vector_type

Constructor & Destructor Documentation

◆ StandardLineSearch() [1/3]

◆ StandardLineSearch() [2/3]

◆ StandardLineSearch() [3/3]

Member Function Documentation

◆ config_string()

◆ createNewtonUpdater()

◆ search()

◆ set_accept_best()

◆ set_check_all()

◆ set_lambda_start()

◆ set_maximum_defect()

◆ set_maximum_steps()

◆ set_offset()

◆ set_reduce_factor()

◆ set_suff_descent_factor()

◆ set_verbose()

◆ setNewtonUpdater()

Member Data Documentation

◆ m_alpha

◆ m_bAcceptBest

◆ m_bCheckAll

◆ m_lambdaReduce

◆ m_lambdaStart

◆ m_maxDefect

◆ m_maxSteps

◆ m_newtonUpdater

◆ m_offset

◆ m_verbose

◆ s