bpp-core3  3.0.0
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 std::shared_ptr< DataTablecomputeGrid (FunctionInterface &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 63 of file FunctionTools.h.

Member Function Documentation

◆ computeGrid()

shared_ptr< DataTable > FunctionTools::computeGrid ( FunctionInterface function,
const ParameterGrid grid 
)
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 shared pointer toward a dynamically created DataTable. Each row corresponds to a combination of parameters values and the corresponding function value. There is hence one column per parameter, and one additional column containing the corresponding function evaluations.

Definition at line 53 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(), bpp::ParameterList::setParameterValue(), and bpp::TextTools::toString().


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