FEAT::Solver::OptimizationTestTraits< DT_, Function_ > Struct Template Reference

Class holding additional information about certain AnalyticFunction used for optimization tests. More...

#include <function_traits.hpp>

Public Types
typedef FunctionType::template Evaluator< FuncEvalTraits >	EvalType
	Type of the evaluator. More...
typedef Analytic::EvalTraits< DT_, FunctionType >	FuncEvalTraits
	The evaluation traits for this function. More...
typedef Function_	FunctionType
	The AnalyticFunction i.e. from FEAT::Analytic::Common. More...
typedef EvalType::PointType	PointType
	Type the function maps from. More...
typedef EvalType::ValueType	ValueType
	Type the function maps to. More...

Static Public Member Functions
template<int sn_>
static void	get_domain_bounds (Tiny::Vector< DT_, 2, sn_ > &domain, int dim)
	Gets the domain bounds. More...
static void	get_minimal_points (std::deque< PointType > &min_points)
	Gets a list of all minimal points. More...
static void	get_starting_point (PointType &start)
	Gets an initial guess to start from. More...
static String	name ()
	Returns the name of the AnalyticFunction. More...

Detailed Description

template<typename DT_, typename Function_>
struct FEAT::Solver::OptimizationTestTraits< DT_, Function_ >

Class holding additional information about certain AnalyticFunction used for optimization tests.

Template Parameters

DT_	Floating point precision
Function_	The class of the AnalyticFunction

Note

This generic class template is only for documentation purposes. All relevant data is to be contained in specializations in Function_.

Definition at line 32 of file function_traits.hpp.

Member Typedef Documentation

EvalType

template<typename DT_ , typename Function_ >

typedef FunctionType::template Evaluator<FuncEvalTraits> FEAT::Solver::OptimizationTestTraits< DT_, Function_ >::EvalType

Type of the evaluator.

Definition at line 39 of file function_traits.hpp.

FuncEvalTraits

template<typename DT_ , typename Function_ >

typedef Analytic::EvalTraits<DT_, FunctionType> FEAT::Solver::OptimizationTestTraits< DT_, Function_ >::FuncEvalTraits

The evaluation traits for this function.

Definition at line 37 of file function_traits.hpp.

FunctionType

template<typename DT_ , typename Function_ >

typedef Function_ FEAT::Solver::OptimizationTestTraits< DT_, Function_ >::FunctionType

The AnalyticFunction i.e. from FEAT::Analytic::Common.

Definition at line 35 of file function_traits.hpp.

PointType

template<typename DT_ , typename Function_ >

typedef EvalType::PointType FEAT::Solver::OptimizationTestTraits< DT_, Function_ >::PointType

Type the function maps from.

Definition at line 43 of file function_traits.hpp.

ValueType

template<typename DT_ , typename Function_ >

typedef EvalType::ValueType FEAT::Solver::OptimizationTestTraits< DT_, Function_ >::ValueType

Type the function maps to.

Definition at line 41 of file function_traits.hpp.

Member Function Documentation

get_domain_bounds()

template<typename DT_ , typename Function_ >

template<int sn_>

static void FEAT::Solver::OptimizationTestTraits< DT_, Function_ >::get_domain_bounds ( Tiny::Vector< DT_, 2, sn_ > &  domain, int  dim  )

inlinestatic

Gets the domain bounds.

Template Parameters

sn_	stride for the Tiny::Vector holding the domain bounds

Parameters

[out]	domain	Vector with 2 entries containing the lower and the upper bound of the domain
[in]	dim	Coordinate direction for which we want to have the domain bounds

For debugging purposes, it is often handy to plot the target function on a domain. For out purposes, this is always a cartesian product of intervals and this routine returns those intervals.

Definition at line 84 of file function_traits.hpp.

get_minimal_points()

template<typename DT_ , typename Function_ >

static void FEAT::Solver::OptimizationTestTraits< DT_, Function_ >::get_minimal_points ( std::deque< PointType > &  min_points )

inlinestatic

Gets a list of all minimal points.

Parameters

[out]

min_points

All the domain points representing local minima of the function

Definition at line 63 of file function_traits.hpp.

get_starting_point()

template<typename DT_ , typename Function_ >

static void FEAT::Solver::OptimizationTestTraits< DT_, Function_ >::get_starting_point ( PointType &  start )

inlinestatic

Gets an initial guess to start from.

Parameters

[out]

start

Domain point that gets set to the initial guess

Definition at line 52 of file function_traits.hpp.

name()

template<typename DT_ , typename Function_ >

static String FEAT::Solver::OptimizationTestTraits< DT_, Function_ >::name ( )

inlinestatic

Returns the name of the AnalyticFunction.

Returns

A String containing the name of the AnalyticFunction

Definition at line 93 of file function_traits.hpp.

---

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

• kernel/solver/test_aux/function_traits.hpp