PLMD::RootFindingBase< FCLASS > Class Template Reference

#include <RootFindingBase.h>

Inheritance diagram for PLMD::RootFindingBase< FCLASS >:

Public Member Functions
	RootFindingBase (FCLASS *funcc)
void	linesearch (const std::vector< double > &dir, std::vector< double > &p, engf_pointer myfunc) const
	This is the line minimiser.
void	lsearch (const std::vector< double > &dir, std::vector< double > &p, engfnc_pointer myfunc) const

Private Types
typedef double(FCLASS::*	engf_pointer) (const std::vector< double > &p, std::vector< double > &der) const
	This is the pointer to the member function in the energy calculating class that calculates the energy.
typedef double(FCLASS::*	engfnc_pointer) (const std::vector< double > &p, std::vector< double > &der)

Private Member Functions
void	doSearch (const std::vector< double > &dir, std::vector< double > &p, F1dim< FCLASS > &f1dim) const
	This actually does the search for a root.

Private Attributes
FCLASS *	myclass_func
	The class that calculates the energy given a position.

Member Typedef Documentation

engf_pointer

template<class FCLASS>

typedef double(FCLASS::* PLMD::RootFindingBase< FCLASS >::engf_pointer) (const std::vector< double > &p, std::vector< double > &der) const

private

This is the pointer to the member function in the energy calculating class that calculates the energy.

engfnc_pointer

template<class FCLASS>

typedef double(FCLASS::* PLMD::RootFindingBase< FCLASS >::engfnc_pointer) (const std::vector< double > &p, std::vector< double > &der)

private

Constructor & Destructor Documentation

RootFindingBase()

template<class FCLASS>

PLMD::RootFindingBase< FCLASS >::RootFindingBase ( FCLASS * funcc )

inlineexplicit

Member Function Documentation

doSearch()

template<class FCLASS>

void PLMD::RootFindingBase< FCLASS >::doSearch ( const std::vector< double > & dir, std::vector< double > & p, F1dim< FCLASS > & f1dim ) const

private

This actually does the search for a root.

linesearch()

template<class FCLASS>

void PLMD::RootFindingBase< FCLASS >::linesearch	(	const std::vector< double > &	dir,
		std::vector< double > &	p,
		engf_pointer	myfunc ) const

This is the line minimiser.

lsearch()

template<class FCLASS>

void PLMD::RootFindingBase< FCLASS >::lsearch	(	const std::vector< double > &	dir,
		std::vector< double > &	p,
		engfnc_pointer	myfunc ) const

Member Data Documentation

myclass_func

template<class FCLASS>

FCLASS* PLMD::RootFindingBase< FCLASS >::myclass_func

private

The class that calculates the energy given a position.

---

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

• tools/RootFindingBase.h