bpp-core  2.1.0
 All Classes Namespaces Files Functions Variables Typedefs Friends
bpp::FunctionTools Class Reference

This class contains static methods to deal with Function objects. More...

#include <Bpp/Numeric/Function/FunctionTools.h>

Static Public Member Functions

static VVdoublecomputeGrid (Function &function, const ParameterGrid &grid) throw (Exception)
 Evaluates a function on all points in a given grid. More...
 

Detailed Description

This class contains static methods to deal with Function objects.

Definition at line 97 of file FunctionTools.h.

Member Function Documentation

VVdouble * FunctionTools::computeGrid ( Function function,
const ParameterGrid grid 
) throw (Exception)
static

Evaluates a function on all points in a given grid.

Parameters
functionThe function to use for the evaluation.
gridThe grid defining the set of points to evaluate.
Returns
A pointer toward a dynamically created vector of vector of doubles. Each row correpsonds to a combination of parameters and the corresponding function value. There is hence one column per parameter, and one additional column containing the corresponding function evaluations. When DataTable supports different column type, we will probably return a DataTable instead.
Exceptions
ExceptionIf the parameter names in the grid do not match the ones in the function, or a constraint is matched, etc.

Definition at line 80 of file FunctionTools.cpp.

References bpp::ApplicationTools::displayGauge(), bpp::ApplicationTools::displayMessage(), bpp::ApplicationTools::displayMessage(), bpp::ParameterList::setParameterValue(), bpp::ParameterList::setParameterValue(), and bpp::ParameterList::subList().


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