hype::core::AlgorithmSpecification Class Reference

An AlgorithmSpecification specifies all relevant information about an algorithm, such as the algorithm's name or the name of the operation the algorithms belongs to. More...

#include <specification.hpp>

Collaboration diagram for hype::core::AlgorithmSpecification:

List of all members.

Public Member Functions
	AlgorithmSpecification (const std::string &alg_name, const std::string &op_name, StatisticalMethod stat_meth=Least_Squares_1D, RecomputationHeuristic recomp_heur=Periodic, OptimizationCriterion opt_crit=Runtime_Configuration::instance().getDefaultOptimizationCriterion())
	constructs an AlgorithmSpecification object by assigning necessary informations to all fields of the object
const std::string &	getAlgorithmName () const throw ()
	returns the algorithm's name
const std::string &	getOperationName () const throw ()
	returns the name of the operation the algorithm belongs to
const std::string	getStatisticalMethodName () const throw ()
	returns the name of the statistical method that is used for the algorithm
const std::string	getRecomputationHeuristicName () const throw ()
	returns the name of the recomputation heuristic that is used for the algorithm
const std::string	getOptimizationCriterionName () const throw ()
	returns the name of the optimization criterion of the operation the algorithm belongs to
Private Attributes
std::string	alg_name_
	the algorithm's name
std::string	op_name_
	name of the operation the algorithm belongs to
StatisticalMethod	stat_meth_
	the statistical method that is used for the algorithm
RecomputationHeuristic	recomp_heur_
	the recomputation heuristic that is used for the algorithm
OptimizationCriterion	opt_crit_
	the optimization criterion of the operation the algorithm belongs to

---

Detailed Description

An AlgorithmSpecification specifies all relevant information about an algorithm, such as the algorithm's name or the name of the operation the algorithms belongs to.

Author:

Sebastian Breß

Version:

0.2

Date:

2013

Copyright:

GNU LESSER GENERAL PUBLIC LICENSE - Version 3, http://www.gnu.org/licenses/lgpl-3.0.txt

---

Constructor & Destructor Documentation

hype::core::AlgorithmSpecification::AlgorithmSpecification	(	const std::string &	alg_name,
		const std::string &	op_name,
		StatisticalMethod	stat_meth = Least_Squares_1D,
		RecomputationHeuristic	recomp_heur = Periodic,
		OptimizationCriterion	opt_crit = Runtime_Configuration::instance().getDefaultOptimizationCriterion()
	)

constructs an AlgorithmSpecification object by assigning necessary informations to all fields of the object

Parameters:

alg_name	name of the algorithm
op_name	name of the operation the algorithms belongs to
stat_meth	the statistical method used for learning the algorithms behavior (optional)
recomp_heur	the recomputation heuristic used for adapting the algorithms approximation function (optional)
opt_crit	the optimization criterion of the operation the algorithm belongs to (optional)

---

Member Function Documentation

const std::string& hype::core::AlgorithmSpecification::getAlgorithmName

(

)

const throw ()

returns the algorithm's name

const std::string& hype::core::AlgorithmSpecification::getOperationName

(

)

const throw ()

returns the name of the operation the algorithm belongs to

const std::string hype::core::AlgorithmSpecification::getOptimizationCriterionName

(

)

const throw ()

returns the name of the optimization criterion of the operation the algorithm belongs to

const std::string hype::core::AlgorithmSpecification::getRecomputationHeuristicName

(

)

const throw ()

returns the name of the recomputation heuristic that is used for the algorithm

const std::string hype::core::AlgorithmSpecification::getStatisticalMethodName

(

)

const throw ()

returns the name of the statistical method that is used for the algorithm

---

Member Data Documentation

std::string hype::core::AlgorithmSpecification::alg_name_ [private]

the algorithm's name

std::string hype::core::AlgorithmSpecification::op_name_ [private]

name of the operation the algorithm belongs to

OptimizationCriterion hype::core::AlgorithmSpecification::opt_crit_ [private]

the optimization criterion of the operation the algorithm belongs to

RecomputationHeuristic hype::core::AlgorithmSpecification::recomp_heur_ [private]

the recomputation heuristic that is used for the algorithm

StatisticalMethod hype::core::AlgorithmSpecification::stat_meth_ [private]

the statistical method that is used for the algorithm

---

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

• /home/sebastian/gpudbms/trunk/hype-library/include/core/specification.hpp