PLMD::F1dim< FCLASS > Class Template Reference

#include <MinimiseBase.h>

Public Member Functions
	F1dim (const std::vector< double > &pp, const std::vector< double > &dd, FCLASS *ff, engf_pointer cc, engfnc_pointer cc2)
double	getEng (const double &xt)
	Calculate the energy at \(\mathbf{p} + xt*\mathbf{dir}\).

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 Attributes
engf_pointer	calc
	Member of class that calculates the energy we are trying to mnimise.
engfnc_pointer	calc2
	Member of class that calcualtes the energy we are trying to minimise.
const std::vector< double > &	dir
	The direction of the vector we are minimising along.
std::vector< double >	fake_der
	Vector that holds the derivatives at the point at which we calculate the energy (these are not used).
FCLASS *	func
	Class containging the function in the class.
const std::vector< double > &	p
	Pointer to the vector containing an initial position on the vector.
std::vector< double >	pt
	Tempory vector that holds a point at which we want to calculate the energy.

Member Typedef Documentation

engf_pointer

template<class FCLASS>

typedef double(FCLASS::* PLMD::F1dim< 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::F1dim< FCLASS >::engfnc_pointer) (const std::vector< double > &p, std::vector< double > &der)

private

Constructor & Destructor Documentation

F1dim()

template<class FCLASS>

PLMD::F1dim< FCLASS >::F1dim ( const std::vector< double > & pp, const std::vector< double > & dd, FCLASS * ff, engf_pointer cc, engfnc_pointer cc2 )

explicit

Member Function Documentation

getEng()

template<class FCLASS>

double PLMD::F1dim< FCLASS >::getEng

(

const double &

xt

)

Calculate the energy at \(\mathbf{p} + xt*\mathbf{dir}\).

Member Data Documentation

calc

template<class FCLASS>

engf_pointer PLMD::F1dim< FCLASS >::calc

private

Member of class that calculates the energy we are trying to mnimise.

calc2

template<class FCLASS>

engfnc_pointer PLMD::F1dim< FCLASS >::calc2

private

Member of class that calcualtes the energy we are trying to minimise.

dir

template<class FCLASS>

const std::vector<double>& PLMD::F1dim< FCLASS >::dir

private

The direction of the vector we are minimising along.

fake_der

template<class FCLASS>

std::vector<double> PLMD::F1dim< FCLASS >::fake_der

private

Vector that holds the derivatives at the point at which we calculate the energy (these are not used).

func

template<class FCLASS>

FCLASS* PLMD::F1dim< FCLASS >::func

private

Class containging the function in the class.

p

template<class FCLASS>

const std::vector<double>& PLMD::F1dim< FCLASS >::p

private

Pointer to the vector containing an initial position on the vector.

pt

template<class FCLASS>

std::vector<double> PLMD::F1dim< FCLASS >::pt

private

Tempory vector that holds a point at which we want to calculate the energy.

---

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

• tools/MinimiseBase.h