FuncMinimum Class Reference

The simplest concrete implementation of IFuncMinimum interface. More...

#include <src/Components/FuncMinimum.h>

Inheritance diagram for FuncMinimum:

Collaboration diagram for FuncMinimum:

Classes
class	FuncMinimumMisc

Public Types
typedef std::vector< const GenFunc * >	Gradient
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Public Member Functions
StatusCode	minimum (const GenFunc &func, Arg &arg) const override
	Find minimum of the function "GenFunc". More...
StatusCode	minimum (const GenFunc &func, Arg &arg, Covariance &covar) const override
	Find minimum of the function "GenFunc". More...
StatusCode	initialize () override
	Overriding initialize. More...
StatusCode	finalize () override
	~FuncMinimum () override=default
	Destructor. More...
	FuncMinimum (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...
Public Member Functions inherited from extends< BASE, Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
	FuncMinimum ()=delete
	default constructor is private More...
	FuncMinimum (const FuncMinimum &)=delete
	copy constructor is private More...
FuncMinimum &	operator= (const FuncMinimum &)=delete
	assignment operator is More...

Private Attributes
std::string	m_algType = "conjugate_fr"
double	m_max_iter = 200
double	m_norm_gradient = 1.0e-10
double	m_step_size = 0.01
double	m_tol = 1e-10
const gsl_multimin_fdfminimizer_type *	m_type = nullptr

Detailed Description

The simplest concrete implementation of IFuncMinimum interface.

See also

GaudiGSL/IFuncMinimum.h

Author

Kirill Miklyaev kiril.nosp@m.lm@i.nosp@m.ris1..nosp@m.itep.nosp@m..ru

Date

2002-09-14

Definition at line 24 of file FuncMinimum.h.

Member Typedef Documentation

typedef std::vector<const GenFunc*> FuncMinimum::Gradient

Definition at line 26 of file FuncMinimum.h.

Constructor & Destructor Documentation

FuncMinimum::~FuncMinimum ( )

overridedefault

Destructor.

FuncMinimum::FuncMinimum	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard constructor.

See also

GaudiTool

Parameters

type	tool type
name	tool name
parent	parent of the tool

declare type of the algorithm for multidimensional minimization

declare maximum of iteration

declare the absolute tolerance for the Euclidean norm of the gradient

declare the size of the first trial step

declare the accuracy of the line minimization

Definition at line 52 of file FuncMinimum.cpp.

  : base_class      ( type, name , parent )
{
  declareProperty ( "Algorithm", m_algType       );
  declareProperty ( "Iteration", m_max_iter      );
  declareProperty ( "Gradient" , m_norm_gradient );
  declareProperty ( "Step_size", m_step_size     );
  declareProperty ( "Tol"      , m_tol           );
}

FuncMinimum::FuncMinimum ( )

privatedelete

default constructor is private

FuncMinimum::FuncMinimum ( const FuncMinimum &  )

privatedelete

copy constructor is private

Member Function Documentation

StatusCode FuncMinimum::finalize ( )

override

Definition at line 320 of file FuncMinimum.cpp.

{
  StatusCode sc = GaudiTool::finalize() ;

  MsgStream log( msgSvc() , name() ) ;

  if ( sc.isFailure() )
    {
      return Error("Could not finalize base class GaudiTool", sc);
    }
  return StatusCode::SUCCESS;
}

StatusCode FuncMinimum::initialize ( )

override

Overriding initialize.

The algorithm for multidimensional minimization

Definition at line 268 of file FuncMinimum.cpp.

{
  StatusCode sc = GaudiTool::initialize() ;

  MsgStream log( msgSvc() , name() ) ;

  if ( sc.isFailure() )
    {
      return Error ("Could not initialize base class GaudiTool", sc);
    }

  if(       "conjugate_fr" == m_algType )
    {
      m_type = gsl_multimin_fdfminimizer_conjugate_fr     ;
      log << MSG::DEBUG
          << "Minimization algorithm to be used: "
          << "'gsl_multimin_fdfminimizer_conjugate_fr'"
          << endmsg;
    }
  else if ( "conjugate_pr" == m_algType )
    {
      m_type = gsl_multimin_fdfminimizer_conjugate_pr     ;
      log << MSG::DEBUG
          << "Minimization algorithm to be used: "
          << "'gsl_multimin_fdfminimizer_conjugate_pr'"
          << endmsg;
    }
  else if ( "vector_bfgs" == m_algType )
    {
      m_type = gsl_multimin_fdfminimizer_vector_bfgs      ;
      log << MSG::DEBUG
          << "Minimization algorithm to be used: " <<
          "'gsl_multimin_fdfminimizer_vector_bfgs'" << endmsg;
    }
  else if ( "steepest_descent" == m_algType )
    {
      m_type = gsl_multimin_fdfminimizer_steepest_descent ;
      log << MSG::DEBUG
          << "Minimization algorithm to be used: "
          << "'gsl_multimin_fdfminimizer_steepest_descent'"
          << endmsg;
    }
  else
    {
      return Error(" Unknown algorithm type '" + m_algType + "'");
    }

  return StatusCode::SUCCESS;
}

StatusCode FuncMinimum::minimum ( const GenFunc &  func, Arg &  arg  ) const

override

Find minimum of the function "GenFunc".

See also

IFuncMinimum.h

Returns

StatusCode

StatusCode FuncMinimum::minimum ( const GenFunc &  func, Arg &  arg, Covariance &  covar  ) const

override

Find minimum of the function "GenFunc".

See also

IFuncMinimum.h

Returns

StatusCode

FuncMinimum& FuncMinimum::operator= ( const FuncMinimum &  )

privatedelete

assignment operator is

Member Data Documentation

std::string FuncMinimum::m_algType = "conjugate_fr"

private

Definition at line 99 of file FuncMinimum.h.

double FuncMinimum::m_max_iter = 200

private

Definition at line 100 of file FuncMinimum.h.

double FuncMinimum::m_norm_gradient = 1.0e-10

private

Definition at line 101 of file FuncMinimum.h.

double FuncMinimum::m_step_size = 0.01

private

Definition at line 102 of file FuncMinimum.h.

double FuncMinimum::m_tol = 1e-10

private

Definition at line 103 of file FuncMinimum.h.

const gsl_multimin_fdfminimizer_type* FuncMinimum::m_type = nullptr

private

Definition at line 104 of file FuncMinimum.h.

---

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

• GaudiGSL/src/Components/FuncMinimum.h
• GaudiGSL/src/Components/FuncMinimum.cpp