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 VVdouble *	computeGrid (Function &function, const ParameterGrid &grid)
	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 98 of file FunctionTools.h.

Member Function Documentation

computeGrid()

VVdouble * FunctionTools::computeGrid ( Function &  function, const ParameterGrid &  grid  )

static

Evaluates a function on all points in a given grid.

Parameters

function	The function to use for the evaluation.
grid	The 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

Exception

If the parameter names in the grid do not match the ones in the function, or a constraint is matched, etc.

Definition at line 90 of file FunctionTools.cpp.

References bpp::ParameterList::createSubList(), bpp::ApplicationTools::displayGauge(), bpp::ApplicationTools::displayMessage(), bpp::ParameterGrid::getDimensionName(), bpp::ParameterGrid::getDimensionNames(), bpp::ParameterGrid::getNumberOfDimensions(), bpp::ParameterGrid::getPoints(), bpp::ParameterGrid::getPointsForDimension(), bpp::ParameterGrid::getTotalNumberOfPoints(), and bpp::ParameterList::setParameterValue().

---

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

• Bpp/Numeric/Function/FunctionTools.h
• Bpp/Numeric/Function/FunctionTools.cpp