AFEPack
公有类型 | 公有成员 | 私有属性
FunctionFunction< value_type >模板类参考

#include <Miscellaneous.h>

类FunctionFunction< value_type >继承关系图:
Function< value_type >

所有成员的列表。

公有类型

typedef value_type(* ValuePrototype )(const double *)
typedef std::vector< value_type >(* GradientPrototype )(const double *)

公有成员

 FunctionFunction (value_type(*v)(const double *)=NULL, std::vector< value_type >(*g)(const double *)=NULL)
 FunctionFunction (const FunctionFunction< value_type > &f)
virtual ~FunctionFunction ()
ValuePrototype valueFunction () const
ValuePrototypevalueFunction ()
GradientPrototype gradientFunction () const
GradientPrototypegradientFunction ()
 operator ValuePrototype () const
 operator ValuePrototype ()
 operator GradientPrototype () const
 operator GradientPrototype ()
virtual value_type value (const double *p) const
virtual std::vector< value_typegradient (const double *p) const

私有属性

ValuePrototype vf
GradientPrototype gf

详细描述

template<class value_type>
class FunctionFunction< value_type >

function of function. The function adopt pointers to funtion to evaluate its value and gradient. This make it convenient to use an old C and C++ function in the new formation.


成员类型定义文档

template<class value_type>
typedef std::vector<value_type>(* FunctionFunction< value_type >::GradientPrototype)(const double *)
template<class value_type>
typedef value_type(* FunctionFunction< value_type >::ValuePrototype)(const double *)

构造及析构函数文档

template<class value_type>
FunctionFunction< value_type >::FunctionFunction ( value_type(*)(const double *)  v = NULL,
std::vector< value_type >(*)(const double *)  g = NULL 
) [inline]

Constructor

template<class value_type>
FunctionFunction< value_type >::FunctionFunction ( const FunctionFunction< value_type > &  f) [inline]
template<class value_type>
virtual FunctionFunction< value_type >::~FunctionFunction ( ) [inline, virtual]

Destructor


成员函数文档

template<class value_type>
virtual std::vector<value_type> FunctionFunction< value_type >::gradient ( const double *  p) const [inline, virtual]

the gradient of the function.

重载Function< value_type >

template<class value_type>
GradientPrototype FunctionFunction< value_type >::gradientFunction ( ) const [inline]

the pointer of the gradient function.

template<class value_type>
GradientPrototype& FunctionFunction< value_type >::gradientFunction ( ) [inline]

the pointer of the gradient function.

template<class value_type>
FunctionFunction< value_type >::operator GradientPrototype ( ) const [inline]
template<class value_type>
FunctionFunction< value_type >::operator GradientPrototype ( ) [inline]
template<class value_type>
FunctionFunction< value_type >::operator ValuePrototype ( ) const [inline]
template<class value_type>
FunctionFunction< value_type >::operator ValuePrototype ( ) [inline]
template<class value_type>
virtual value_type FunctionFunction< value_type >::value ( const double *  p) const [inline, virtual]

the value of the function.

重载Function< value_type >

template<class value_type>
ValuePrototype FunctionFunction< value_type >::valueFunction ( ) const [inline]

the pointer of the value function.

template<class value_type>
ValuePrototype& FunctionFunction< value_type >::valueFunction ( ) [inline]

the pointer of the value function.


成员数据文档

template<class value_type>
GradientPrototype FunctionFunction< value_type >::gf [private]
template<class value_type>
ValuePrototype FunctionFunction< value_type >::vf [private]

< the pointer to the value function. the pointer to the gradient function.


该类的文档由以下文件生成: