MechSys  1.0
Computing library for simulations in continuum and discrete mechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Public Attributes
Numerical::Min< Instance > Class Template Reference

#include <min.h>

List of all members.

Public Types

typedef double(Instance::* pF )(double const X[])
 calc F (returns F(X))
typedef void(Instance::* pdF )(double const X[], double dFdX[])
 calc dFdX

Public Member Functions

 Min (Instance *p2Inst, pF p2F, pdF p2dF, size_t NDim, char const *Scheme="BFGS")
 p2dF can be NULL, in this case Scheme must be NMSimplex or NMSimplexRnd
 ~Min ()
void SetScheme (char const *Scheme="BFGS")
 if p2dF is NULL, scheme must be NMSimplex or NMSimplexRnd
double Find (double X[], double StepSize=0.01, double Tol=1.0e-3, size_t MaxIt=1000)
 Find min around X. Returns results in X.
double _call_F (double const X[])
void _call_dF (double const X[], double dFdX[])

Public Attributes

bool Debug

template<typename Instance>
class Numerical::Min< Instance >


Member Typedef Documentation

template<typename Instance>
typedef void(Instance::* Numerical::Min< Instance >::pdF)(double const X[], double dFdX[])

calc dFdX

template<typename Instance>
typedef double(Instance::* Numerical::Min< Instance >::pF)(double const X[])

calc F (returns F(X))


Constructor & Destructor Documentation

template<typename Instance >
Numerical::Min< Instance >::Min ( Instance *  p2Inst,
pF  p2F,
pdF  p2dF,
size_t  NDim,
char const *  Scheme = "BFGS" 
) [inline]

p2dF can be NULL, in this case Scheme must be NMSimplex or NMSimplexRnd

template<typename Instance >
Numerical::Min< Instance >::~Min ( ) [inline]

Member Function Documentation

template<typename Instance>
void Numerical::Min< Instance >::_call_dF ( double const  X[],
double  dFdX[] 
) [inline]
template<typename Instance>
double Numerical::Min< Instance >::_call_F ( double const  X[]) [inline]
template<typename Instance >
double Numerical::Min< Instance >::Find ( double  X[],
double  StepSize = 0.01,
double  Tol = 1.0e-3,
size_t  MaxIt = 1000 
) [inline]

Find min around X. Returns results in X.

template<typename Instance >
void Numerical::Min< Instance >::SetScheme ( char const *  Scheme = "BFGS") [inline]

if p2dF is NULL, scheme must be NMSimplex or NMSimplexRnd


Member Data Documentation

template<typename Instance>
bool Numerical::Min< Instance >::Debug

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines